jahiapageservice.java

java 写的一个新闻发布系统

    public abstract Vector getPageChilds (
            int pageID,
            int loadFlag,
            JahiaUser user)
        throws JahiaException;

    //-------------------------------------------------------------------------
    /** Return the page path. The page path consist of all the parent pages of
     *  the specified page until the site's root page.
     *
     * @param   pageID      The page id
     * @param   jParam      Jahia parameter reference. Specify null if to
     *                      page context is needed.
     *
     * @return  Return a valid Vector of JahiaPage objects defining the path.
     *          The first element will be the root page, and the specified
     *          page will be the last element in the Vector. In case the
     *          specified page is the root page, only this page will be
     *          present in the Vector.
     *
     * @exception   JahiaException
     *      Return this exception if any failure occured.
     */
    public abstract Vector getPagePath (int pageID, ParamBean jParam)
        throws JahiaException;


    //-------------------------------------------------------------------------
    /** Return a list of pages pointing on the specified page. Pages can hold
     *  the context information if needed.
     *
     * @param   pageID      the page ID on which the pages should point to.
     * @param   jParam      Jahia parameter reference. Specify null if to
     *                      page context is needed.
     *
     * @return  Return Vector of page objects
     *
     * @exception   JahiaException
     *      Return this exception if any failure occured.
     */
    public abstract Vector getPagesPointingOnPage (int pageID, ParamBean jParam)
        throws JahiaException;


    //-------------------------------------------------------------------------
    /** Gets complete subtree under page.
     *
     * @param   pageID
     *      Page unique identification number.
     *
     * @param   loadFlag
     *      Mask of page types to be loaded. See
     *      {@link org.jahia.services.pages.PageLoadFlags PageLoadFlags}
     *      class constants for more informaion.
     *
     * @param   jParam
     *      Jahia parameters. This parameter can be set to null in case no
     *      dynamic context is needed.
     *
     * @return  Return a Vector of JahiaPage objects
     *
     * @exception   JahiaException
     *      Return this exception if any failure occured.
     */
    public abstract Vector getPageSubTree (
            int pageID,
            int loadFlag,
            ParamBean jParam)
        throws JahiaException;


    //-------------------------------------------------------------------------
    /** Try to find the specified page. Create a new JahiaPage object, in
     *  which will be included a reference to the raw page info, a reference
     *  to the page definition associated to the page, a reference to the page's
     *  ACL object and finally a reference to the current Jahia parameters.
     *
     * @param   pageID  The ID of the page to be looked up.
     * @param   jParam  Jahia parameters.
     *
     * @return  Return a valid instance of a JahiaPage class. If the page does
     *          not exist, or any of its content is unavailable (ACL, page
     *          definition) then an exception will be thrown.
     *
     * @exception   JahiaException
     *      Throws this exception if any error occured in the lookup process.
     *
     * @exception   JahiaPageNotFoundException
     *      Throws this exception when the page could not be found in the
     *      database.
     */
    public abstract JahiaPage lookupPage (int pageID, ParamBean jParam)
        throws  JahiaException,
                JahiaPageNotFoundException,
                JahiaTemplateNotFoundException;


    //-------------------------------------------------------------------------
    /** Try to find the specified page. Create a new JahiaPage object, in
     *  which will be included a reference to the raw page info, a reference
     *  to the page definition associated to the page, a reference to the page's
     *  ACL object and finally a reference to the current Jahia parameters.
     *
     * @param   pageID  The ID of the page to be looked up.
     *
     * @return  Return a valid instance of a JahiaPage class. If the page does
     *          not exist, or any of its content is unavailable (ACL, page
     *          definition) then an exception will be thrown.
     *
     * @exception   JahiaException
     *      Throws this exception if any error occured in the lookup process.
     *
     * @exception   JahiaPageNotFoundException
     *      Throws this exception when the page could not be found in the
     *      database.
     */
    public abstract JahiaPage lookupPage (int pageID)
        throws  JahiaException,
                JahiaPageNotFoundException,
                JahiaTemplateNotFoundException;

    //-------------------------------------------------------------------------
    /** return a copy (clone) of the jahia page.
     *  all the page content and the acl are cloned too.
     *  @param   newParentID   int parentID of the cloned page
     *                         if -1, newParentID = parentID of the page to clone.
     *  @param   pageToClone   JahiaPage the page to clone.
     *
     *  @return  return a JahiaPage which is the clone of the page in parameter.
     */
     public abstract JahiaPage clonePage(int newParentID,
                                             int newParentAclID,
                                             JahiaPage pageToClone,
                                             ParamBean jParam,
                                             boolean childrenCloned)
        throws JahiaException;


     //-------------------------------------------------------------------------
    /** set a new parent to the page.
     *  USE this method carefully, it will move all the subtree.
     *  @param   newParentID int the new parentID of the page
     *  @param   page        JahiaPage the page to clone.
     *
     *  @return  return a JahiaPage with the new parentID.
     */
     public abstract JahiaPage setParentPageID(int newParentID,
                                                   JahiaPage page)
        throws JahiaException;


    //-------------------------------------------------------------------------
    /**
     * Return the number of pages in the database.
     *
     * @return
     *      Return the number of pages.
     */
    public abstract int getNbPages ()
        throws  JahiaException;


    //-------------------------------------------------------------------------
    /**
     * Return the number of pages in the database.
     *
     * @return
     *      Return the number of pages.
     */
    public abstract int getNbPages (int siteID)
        throws  JahiaException;

    //-------------------------------------------------------------------------
    /**
     * Return the number of pages in the database.
     *
     * @return
     *      Return the number of pages.
     */
    public abstract int getRealNbPages ()
        throws  JahiaException;


    //-------------------------------------------------------------------------
    /**
     * Return the number of pages in the database.
     *
     * @return
     *      Return the number of pages.
     */
    public abstract int getRealNbPages (int siteID)
        throws  JahiaException;


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


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



}