IContentSearcherDAO.java

/*
*
* Copyright 2005 AgileTec s.r.l. (http://www.agiletec.it) All rights reserved.
*
* This file is part of jAPS software.
* jAPS is a free software; 
* you can redistribute it and/or modify it
* under the terms of the GNU General Public License (GPL) as published by the Free Software Foundation; version 2.
* 
* See the file License for the specific language governing permissions   
* and limitations under the License
* 
* 
* 
* Copyright 2005 AgileTec s.r.l. (http://www.agiletec.it) All rights reserved.
*
*/
package com.agiletec.plugins.jacms.aps.system.services.content;

import java.util.Collection;
import java.util.List;

import com.agiletec.aps.system.common.entity.IEntitySearcherDAO;
import com.agiletec.aps.system.common.entity.model.EntitySearchFilter;
import com.agiletec.plugins.jacms.aps.system.services.content.showlet.IContentListHelper;

/**
 * Interfaccia base per i Data Access Object 
 * riservato al caricamento/ricerca lista di contenuti.
 * @author E.Santoboni
 * @deprecated from jAPS 2.0 version 2.0.9. Use {@link IPublicContentSearcherDAO}
 */
public interface IContentSearcherDAO extends IEntitySearcherDAO {
	
	/**
	 * Carica una lista di identificativi di contenuti in base ai parametri immessi.
	 * @param categories Le categorie dei contenuti da cercare.
	 * @param filters L'insieme dei filtri sugli attibuti, su cui la ricerca deve essere effettuata.
	 * @param userGroupCodes I codici dei gruppi utenti dell'utente richiedente la lista. 
	 * Se la collezione è vuota o nulla, gli identificativi di contenuto erogati saranno 
	 * relativi al gruppo definito "ad accesso libero". Nel caso nella collezione sia presente 
	 * il codice del gruppo degli amministratori, non sarà applicato alcun il filtro sul gruppo.
	 * @param onlyOwner Implica se il filtro sulla ricerca và applicato 
	 * anche sui gruppi extra dei contenuti e non esclusivamente sul gruppo proprietario.
	 * @return La lista degli id dei contenuti cercati.
	 */
	public List<String> loadContentsId(String[] categories, EntitySearchFilter[] filters, 
			Collection<String> userGroupCodes, boolean onlyOwner);
	
	/**
	 * Carica una lista di identificativi di contenuti publici in base ai parametri immessi.
	 * @param categories Le categorie dei contenuti da cercare.
	 * @param filters L'insieme dei filtri sugli attibuti, su cui la ricerca deve essere effettuata.
	 * @param userGroupCodes I codici dei gruppi utenti dell'utente richiedente la lista. 
	 * Se la collezione è vuota o nulla, gli identificativi di contenuto erogati saranno 
	 * relativi al gruppo definito "ad accesso libero". Nel caso nella collezione sia presente 
	 * il codice del gruppo degli amministratori, non sarà applicato alcun il filtro sul gruppo.
	 * @return La lista degli id dei contenuti cercati.
	 */
	public List<String> loadPublicContentsId(String[] categories, EntitySearchFilter[] filters, 
			Collection<String> userGroupCodes);
	
	/**
	 * Carica una lista di identificativi di contenuti publici in base ai parametri immessi.
	 * @param contentType Il codice dei tipi di contenuto da cercare.
	 * @param categories Le categorie dei contenuti da cercare.
	 * @param filters L'insieme dei filtri sugli attibuti, su cui la ricerca deve essere effettuata.
	 * @param userGroupCodes I codici dei gruppi utenti dell'utente richiedente la lista. 
	 * Se la collezione è vuota o nulla, gli identificativi di contenuto erogati saranno 
	 * relativi al gruppo definito "ad accesso libero". Nel caso nella collezione sia presente 
	 * il codice del gruppo degli amministratori, non sarà applicato alcun il filtro sul gruppo.
	 * @return La lista degli id dei contenuti cercati.
	 */
	public List<String> loadPublicContentsId(String contentType, String[] categories, EntitySearchFilter[] filters, 
			Collection<String> userGroupCodes);
	
	/**
	 * @deprecated from jAPS 2.0 version 2.0.9. use constant on {@link IContentManager}
	 */
	public static final String DESCR_FILTER_KEY = IContentManager.CONTENT_DESCR_FILTER_KEY;
	
	/**
	 * @deprecated from jAPS 2.0 version 2.0.9. use constant on {@link IContentManager}
	 */
	public static final String STATUS_FILTER_KEY = IContentManager.CONTENT_STATUS_FILTER_KEY;
	
	/**
	 * @deprecated from jAPS 2.0 version 2.0.9. use constant on {@link IContentManager}
	 */
	public static final String CREATION_DATE_FILTER_KEY = IContentManager.CONTENT_CREATION_DATE_FILTER_KEY;
	
	/**
	 * @deprecated from jAPS 2.0 version 2.0.9. use constant on {@link IContentManager}
	 */
	public static final String MODIFY_DATE_FILTER_KEY = IContentManager.CONTENT_MODIFY_DATE_FILTER_KEY;
	
	/**
	 * @deprecated from jAPS 2.0 version 2.0.9. use constant on {@link IContentManager}
	 */
	public static final String ONLINE_FILTER_KEY = IContentManager.CONTENT_ONLINE_FILTER_KEY;
	
	/**
	 * @deprecated from jAPS 2.0 version 2.0.9. use constant on {@link IContentListHelper}
	 */
	public static final String[] allowedContentFilterKeys = IContentListHelper.allowedMetadataFilterKeys;
	
}