jahiacontainersservice.java

java 写的一个新闻发布系统

        * @see          org.jahia.data.containers.JahiaContainer
        *
        */
    public abstract void saveContainer( JahiaContainer  theContainer,
                                        int             containerParentID,
                                        ParamBean       jParams )
        throws JahiaException;


    /***
        * deletes the container info, fields and sublists
        * deletes the container info, fields and sublists
        *
        * @param        ctnid         the container id
        * @param        jParams             the request parameters
        * @see          org.jahia.data.containers.JahiaContainer
        *
        */
    public abstract void deleteContainer( int ctnid, ParamBean jParams )
        throws JahiaException;


    /***
        * loads a container list info
        * loads container list info, but not dependant fields and container lists
        *
        * @param        containerListID     the container list id
        * @see          org.jahia.data.containers.JahiaContainerList
        *
        */
    public abstract JahiaContainerList loadContainerListInfo( int containerListID )
        throws JahiaException;


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


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


    /**
     * Loads a set of containers for a given container list
     * Loads container list info and all containers, but not dependant container lists
     * this method can load request-specific values (i.e. applications).
     *
     * DO NOT CACHE THIS METHOD (it depends on other caches values) !!
     *
     * @param        containerListID     the container list id
     * @param        loadFlag            the loadFlag
     * @param        jParams             the ParamBean object, containing request and response
     * @see          org.jahia.data.containers.JahiaContainerList
     * @see          org.jahia.data.fields.LoadFlags
     * @author		 NK
     *
     */
    public abstract JahiaContainerList loadContainerList( int containerListID,
                                                 int loadFlag,
                                                 ParamBean jParams, Hashtable cachedFieldsInContainer )
     throws JahiaException;


    /**
     * Loads a set of containers for a given container list
     * Loads container list info and containers, but not dependant container lists
     * this method can load request-specific values (i.e. applications).
     *
     * DO NOT CACHE THIS METHOD (it depends on other caches values) !!
     *
     * @param        containerListID     the container list id
     * @param        Vector     		 ctnids, vector of container ids to load.
     * @param        loadFlag            the loadFlag
     * @param        jParams             the ParamBean object, containing request and response
     * @see          org.jahia.data.containers.JahiaContainerList
     * @see          org.jahia.data.fields.LoadFlags
     * @author		 NK
     *
     */
    public abstract JahiaContainerList loadContainerList( int containerListID,
                                                 		  Vector ctnids,
                                                 		  int loadFlag,
                                                 		  ParamBean jParams,
                                                 		  Hashtable cachedFieldsInContainer )
	throws JahiaException;


    /***
        * saves a container list info
        * saves container list info, but not dependant fields and container lists
        * if id=0, attributes a new id to container list and creates it in datasource
        *
        * @param        theContainerList    a JahiaContainerList object
        * @param        parentAclID         the Acl parent ID
        * @see          org.jahia.data.containers.JahiaContainerList
        *
        */
    public abstract void saveContainerListInfo( JahiaContainerList  theContainerList,
                                                int                 parentAclID )
        throws JahiaException;




    /***
        * deletes a container list info
        * deletes a container list info, but not dependant containers
        * see deleteContainerList for that
        *
        * @param        listID              the container list id to delete
        *
        */
    public abstract void deleteContainerListInfo( int listID )
        throws JahiaException;


    /***
        * deletes a container list info
        * deletes a container list info, including dependant containers
        * see deleteContainerList for that
        *
        * @param        listID              the container list id to delete
        *
        */
    public abstract void deleteContainerList( int listID )
        throws JahiaException;


    /***
        * loads a container definition by its id
        *
        * @param        definitionID        the container definition id
        * @return       a JahiaContainerDefinition object
        * @see          org.jahia.data.containers.JahiaContainerDefinition
        * @see          org.jahia.data.containers.JahiaContainerStructure
        *
        */
    public abstract JahiaContainerDefinition loadContainerDefinition( int definitionID )
        throws JahiaException;


    /***
        * saves a container definition
        * if id=0, assigns a new id to the definition and creates it in the datasource
        *
        * @param        theDefinition       the JahiaContainerDefinition to save
        * @see          org.jahia.data.containers.JahiaContainerDefinition
        * @see          org.jahia.data.containers.JahiaContainerStructure
        *
        */
    public abstract void saveContainerDefinition( JahiaContainerDefinition theDefinition )
        throws JahiaException;


    /***
        * deletes a container definition
        *
        * @param        theDefinition       the JahiaContainerDefinition to delete
        * @see          org.jahia.data.containers.JahiaContainerDefinition
        * @see          org.jahia.data.containers.JahiaContainerStructure
        *
        */
    public abstract void deleteContainerDefinition( int definitionID )
        throws JahiaException;


    //--------------------------------------------------------------------------
    /**
     * returns a DOM representation of all containers of a site
     *
     * @param int siteID
     * @auhtor NK
     */
    public abstract JahiaDOMObject getContainersAsDOM( int siteID )
    throws JahiaException;


    //--------------------------------------------------------------------------
    /**
     * returns a DOM representation of all container lists of a site
     *
     * @param int siteID
     * @auhtor NK
     */
    public abstract JahiaDOMObject getContainerListsAsDOM( int siteID )
    throws JahiaException;

    //--------------------------------------------------------------------------
    /**
     * returns a DOM representation of all container lists props of a site
     *
     * @param int siteID
     * @auhtor NK
     */
    public abstract JahiaDOMObject getContainerListPropsAsDOM( int siteID )
    throws JahiaException;


    //--------------------------------------------------------------------------
    /**
     * returns a DOM representation of all container def of a site
     *
     * @param int siteID
     * @auhtor NK
     */
    public abstract JahiaDOMObject getContainerDefsAsDOM( int siteID )
    throws JahiaException;


    //--------------------------------------------------------------------------
    /**
     * returns a DOM representation of all container def prop of a site
     *
     * @param int siteID
     * @auhtor NK
     */
    public abstract JahiaDOMObject getContainerDefPropsAsDOM( int siteID )
    throws JahiaException;

    //--------------------------------------------------------------------------
    /**
     * returns a DOM representation of all containers extented properties of a site
     *
     * @param int siteID
     */
    public abstract JahiaDOMObject getContainerExtendedPropsAsDOM( int siteID )
    throws JahiaException;

    //--------------------------------------------------------------------------
    /**
     * returns a DOM representation of all container structure of a site
     *
     * @param int siteID
     * @auhtor NK
     */
    public abstract JahiaDOMObject getContainerStructsAsDOM( int siteID )
    throws JahiaException;

    //--------------------------------------------------------------------------
    /**
     * Returns a vector of all Acl ID used by container for a site
     * Need this for site extraction
     *
     * @param int siteID
     * @auhtor NK
     */
    public abstract Vector getAclIDs( int siteID )
    throws JahiaException;

    //--------------------------------------------------------------------------
    /**
     * Returns a vector of all ctn lists fields ( field def ) Acl ID for a site
     * Used for site extraction
     *
     * @param int siteID
     * @auhtor NK
     */
    public abstract Vector getCtnListFieldAclIDs( int siteID )
    throws JahiaException;

} // end JahiaContainersService