jahiacontainersservice.java

java 写的一个新闻发布系统

//
//  JahiaContainersBaseService
//  EV      26.12.2000
//
//  buildContainerStructureForPage( pageID )
//
//  getctndefidsInPage( pageID )
//  getContainerListIDs( pageID )
//  getContainerListIDsInPage( thePage )
//  getctnidsInList( listID )
//  getFieldIDsInContainer( ctnid )
//  getContainerListID( containerName, pageID )
//  getAllContainerDefinitionIDs()
//
//  loadContainerInfo( ctnid )
//  loadContainer( ctnid, loadFlag )
//  loadContainer( ctnid, loadFlag, jParams )
//  saveContainerInfo( theContainer )
//  saveContainer( theContainer )
//  deleteContainer( theContainer )
//
//  loadContainerListInfo( containerListID )
//  loadContainerList( containerListID,loadFlag )
//  loadContainerList( containerListID, loadFlag, jParams )
//  saveContainerListInfo( theContainerList )
//  deleteContainerListInfo( containerListID )
//  deleteContainerList( containerListID )
//
//  loadContainerDefinition( definitionID )
//  saveContainerDefinition( theDefinition )
//  deleteContainerDefinition( definitionID )
//

package org.jahia.services.containers;

import java.util.*;                     // Vector

import org.jahia.params.*;          // ParamBean
import org.jahia.data.*;            // JahiaData
import org.jahia.services.pages.JahiaPage;
import org.jahia.utils.*;           // JahiaConsole
import org.jahia.data.containers.*; // JahiaContainers
import org.jahia.services.*;        // JahiaService
import org.jahia.exceptions.JahiaException;


public abstract class JahiaContainersService extends JahiaService {


    /**
     * Create a clone of the container list and all its contents (containers)
     *
     * @param   cListID         The containerList to clone
     * @param   newPageID       The Id of the new page to which the cloned containerList must
     *                          belong to.
     * @param   parentEntryID   The id of the container which contains this containerList
     *                          egal 0, if the containerList is in a page.
     */
     public abstract void cloneContainerList(int cListID, int newPageID, int parentAclID, boolean childrenCloned)
     throws JahiaException;



    /**
     * Create a clone of the container list and all its contents (containers)
     *
     * @param   cListID         The containerList to clone
     * @param   newPageID       The Id of the new page to which the cloned containerList must
     *                          belong to.
     * @param   parentEntryID   The id of the container which contains this containerList
     *                          egal 0, if the containerList is in a page.
     */
     public abstract JahiaContainerList cloneContainerList(int cListID, int newPageID, int parentEntryID, int parentAclID, boolean childrenCloned)
     throws JahiaException;
     
     

    /**
     * Create a clone of the container and all its contents (fields and containerList)
     *
     * @param   theContainer    The container to clone
     * @param   newPageID       The Id of the new page to which the cloned containerList must
     *                          belong to.
     * @param   newCListID      The id of the container list which contains this container.
     *                          
     */
     public abstract JahiaContainer cloneContainer(JahiaContainer theContainer, int newCListID, int newPageID, int parentAclID, boolean childrenCloned)
     throws JahiaException;



    /***
        * builds the complete container structure for a specific page
        * builds the complete container structure (containerlists->containers->fields/containerlists)
        * for a specific page
        *
        * DO NOT CACHE THIS METHOD (it depends on other caches values) !!
        *
        * @param        jData           JahiaData
        * @return       a Vector of containerlist IDs
        *
        */
    public abstract JahiaContainerSet buildContainerStructureForPage( JahiaData jData )
        throws JahiaException;




    /***
        * gets all container definitions ids on a page
        *
        * @param        thePage         the page object
        * @return       a Vector of container definition IDs
        *
        */
    public abstract Vector getctndefidsInPage( JahiaPage thePage )
        throws JahiaException;


    /***
        * gets all container list ids on a page, by their definition id
        *
        * @param        pageID          the page id
        * @param        defID           the container definition id
        * @return       a Vector of containerlist IDs
        *
        */
    public abstract Vector getContainerListIDs( int pageID, int defID )
        throws JahiaException;


    /***
        * gets all container list ids on a page
        *
        * @param        pageID          the page id
        * @param        defID           the container definition id
        * @return       a Vector of containerlist IDs
        *
        */
    public abstract Vector getContainerListIDsInPage( JahiaPage thePage )
        throws JahiaException;


    /***
        * gets all container ids in a container list
        *
        * @param        listID          the container list id
        * @return       a Vector of container IDs
        *
        */
    public abstract Vector getctnidsInList( int listID )
        throws JahiaException;


    /**
     * Gets all container ids in a container list with ordering on a given field.
     * If the fieldName is null, not ordering applied
     *
     * @param        int listID          the container list id
     * @param        String fieldName    the fieldname on which to filter
     * @param        boolean asc         Asc. or desc. ordering ( true = asc )
     * @return       a Vector of container IDs
     *
     * @todo we might want to cache these values in memory in order to
     * improve performance.
	 * @author NK
     */
    public abstract Vector getctnidsInList( int listID , String fieldName, boolean asc)
    throws JahiaException;
    
    
    /**
     * gets all container ids for a given site. This list uses stored
     * ranks to order its values
     *
     * @param int siteID, the given site id.
     * @return Vector a vector of container IDs
     *
     */
    public abstract Vector getCtnIds( int siteID )
    throws JahiaException;

    /***
        * gets all field ids in a container
        *
        * @param        ctnid         the container id
        * @return       a Vector of field IDs
        *
        */
    public abstract Vector getFieldIDsInContainer( int ctnid )
        throws JahiaException;


    /***
        * gets a container list id by its container list name and page id
        *
        * @param        containerName       the container name
        * @param        pageID              the page ID
        * @return       a Vector of field IDs
        *
        */
    public abstract int getContainerListID( String containerName, int pageID )
        throws JahiaException;


    /***
        * gets all container definition ids in Jahia
        *
        * @return       a Vector of container definition IDs
        *
        */
    public abstract Vector getAllContainerDefinitionIDs()
        throws JahiaException;


    /***
        * loads a container info, by its container id
        *
        * @param        ctnid         the container id
        * @return       a JahiaContainer object, without field values
        * @see          org.jahia.data.containers.JahiaContainer
        *
        */
    public abstract JahiaContainer loadContainerInfo( int ctnid )
        throws JahiaException;


    /***
        * loads a container by its container id
        * loads a container info and fields by its container id, but not dependant containerlists
        * this method cannot load request-specific values (i.e. applications);
        * see the loadContainer( ctnid, loadFlag, jParams) for that.
        *
        * DO NOT CACHE THIS METHOD (it depends on other caches values) !!
        *
        * @param        ctnid         the container id
        * @param        loadFlag            the loadFlag
        * @see          org.jahia.data.containers.JahiaContainer
        * @see          org.jahia.data.fields.LoadFlags
        *
        */
    public abstract JahiaContainer loadContainer( int ctnid, int loadFlag )
        throws JahiaException;


    /***
        * loads a container by its container id
        * loads a container info and fields by its container id, but not dependant containerlists
        * this method can load request-specific values (i.e. applications);
        *
        * DO NOT CACHE THIS METHOD (it depends on other caches values) !!
        *
        * @param        ctnid         the container id
        * @param        loadFlag            the loadFlag
        * @param        jParams             the ParamBean object, containing request and response
        * @see          org.jahia.data.containers.JahiaContainer
        * @see          org.jahia.data.fields.LoadFlags
        *
        */
    public abstract JahiaContainer loadContainer( int ctnid, int loadFlag, ParamBean jParams )
        throws JahiaException;


    /***
        * saves the container info
        * saves the container info
        * if id=0, assigns a new id to container and creates it in datasource
        * if listid=0, assigns a new listid to container and creates it in datasource
        *
        * @param        theContainer        a JahiaContainer object
        * @param        parentID            parent container id
        * @param        parentAclID         the Acl parent ID
        * @param		jParams				the current ParamBean
        * @see          org.jahia.data.containers.JahiaContainer
        *
        */
    public abstract void saveContainerInfo( JahiaContainer  theContainer,
                                                int             parentID,
                                                int             parentAclID,
                                                ParamBean       jParams )
        throws JahiaException;


    /***
        * saves the container info and fields
        * saves the container info and fields, but not the dependant container lists
        * if id=0, assigns a new id to container and creates it in datasource
        * if listid=0, assigns a new listid to container and creates it in datasource
        *
        * @param        theContainer        a JahiaContainer object