jahiapageservice.java

java 写的一个新闻发布系统

//
//                                   ____.
//                       __/\ ______|    |__/\.     _______
//            __   .____|    |       \   |    +----+       \
//    _______|  /--|    |    |    -   \  _    |    :    -   \_________
//   \\______: :---|    :    :           |    :    |         \________>
//           |__\---\_____________:______:    :____|____:_____\
//                                      /_____|
//
//                 . . . i n   j a h i a   w e   t r u s t . . .
//

package org.jahia.services.pages;

import java.util.Vector;
import java.util.Enumeration;


import org.jahia.params.ParamBean;

import org.jahia.exceptions.JahiaException;
import org.jahia.exceptions.JahiaPageNotFoundException;
import org.jahia.exceptions.JahiaTemplateNotFoundException;

import org.jahia.services.JahiaService;
import org.jahia.services.pages.JahiaPage;
import org.jahia.services.pages.JahiaPageDefinition;
import org.jahia.services.usermanager.JahiaUser;
import org.jahia.data.JahiaDOMObject;


/**
 * This interface defines all the methods a page service should implement, so that
 * it can be intergrated into Jahia.
 *
 * @auhtor  Khue, Fulco Houkes
 * @version 2.0
 */
public abstract class JahiaPageService extends JahiaService
{

    //-------------------------------------------------------------------------
    /** Create a new page.
     *
     * @param   siteID          The Jahia ID (site ID).
     * @param   parentID        The parent page ID.
     * @param   pageType        The page type (see constants in JahiaPage).
     * @param   title           The page title.
     * @param   pageDefID       The page defiNition ID.
     * @param   creator         The creators nickname used by Jahia internally.
     * @param   parentAclID     The parent ACL ID.
     * @param   jParam          The Jahia parameters.
     *
     * @return  Return a new JahiaPage instanciated object.
     *
     * @exception   JahiaException
     *      Throws this exception when any error occured in the page
     *      creation process.
     */
    public abstract JahiaPage createPage (
            int       siteID,
            int       parentID,
            int       pageType,
            String    title,
            int       pageDefID,
            String    remoteURL,
            int       pageLinkID,
            String    creator,
            int       parentAclID,
            ParamBean jParam)
        throws JahiaException;


    //-------------------------------------------------------------------------
    /** Deletes a page information, and its contents (fields, containers, etc.)
     *
     * @param   pageID  The page to be deleted.
     *
     * @exception   JahiaException
     *      Return this exception if any failure occured in the deletion
     *      process.
     */
    public abstract void deletePage (JahiaPage theVictim, ParamBean jParam)
        throws JahiaException;


    //-------------------------------------------------------------------------
    /** Finds a page id from a page id, and going up a certain number of levels
     *
     * @param   pageID      The page id
     * @param   levelNb     The number of levels to go up
     *
     * @return      the page id if found, -1 if not found
     */
    public abstract int findPageIDFromLevel( int pageID, int levelNb )
        throws JahiaException;


    //-------------------------------------------------------------------------
    /** Get all pages of the specified "website".
     *  If the submitted user is not null, then this method won't return
     *  pages that the user can't read.
     *
     * @param   siteID      The jahia site ID
     * @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.
     * @param   theUser     The current user, to check rights
     *
     * @return      a Vector of JahiaPage objects
     *
     * @exception   JahiaException
     *      Return this exception if any failure occured.
     */
    public abstract Enumeration getAllPages (
            int siteID,
            int loadFlag,
            ParamBean jParam,
            JahiaUser user)
        throws JahiaException;

    //-------------------------------------------------------------------------
    /** Return all the site IDs.
     *
     * @return  Return a Vector holding all the site IDs as Integers.
     */
    public abstract Vector getAllSiteIDs ()
        throws JahiaException;


    //--------------------------------------------------------------------------
    /** Gets all the page IDs of a specified site.
     *
     * @param   siteID      The jahia site ID.
     *
     * @return  Return a valid Vector of page IDs stored as Integers. The Vector
     *          might be empty if no page was found.
     *
     * @exception   JahiaException
     *      Return this exception if any failure occured.
     */
    public abstract Vector getPageIDsInSite (int siteID)
        throws JahiaException;

    //--------------------------------------------------------------------------
    /** Get the jahia page id in a site corresponding to a specified link type.
     *
     * @param   siteID      The jahia site ID.
     * @param   linkType    One of these TYPE_DIRECT, TYPE_LINK, TYPE_URL links. 
     *
     * @return  Return a valid Vector of page IDs stored as Integers. The Vector
     *          might be empty if no page was found.
     *
     * @exception   JahiaException
     *      Return this exception if any failure occured.
     */
    public abstract Vector getPageIDsInSite (int siteID, int linkType)
        throws JahiaException;

    //--------------------------------------------------------------------------
    /** Retrieves all the page IDs that use the specified template
     *
     * @param   templateID the identifier of the template we want the page IDs
     *          for
     *
     * @returns Returns a Vector of page IDs stored as Integers. The Vector
     *          might be empty if no page was found.
     *
     * @exception   JahiaException
     *      Return this exception if any failure occured.
     */
    public abstract Vector getPageIDsWithTemplate (int templateID)
        throws JahiaException;


    //-------------------------------------------------------------------------
    /** Return a vector holding all the child pages of the specified page. The
     *  loading flag filters the kind of pages to return.
     *
     * @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. The returned vector is
     *          always non-null, but might have no pages if the specified page
     *          has not childs, or if no childs matching the loading flag were
     *          found.
     *
     * @exception   JahiaException
     *      Return this exception if any failure occured.
     */
    public abstract Vector getPageChilds (
            int pageID,
            int loadFlag,
            ParamBean jParam)
        throws JahiaException;

    //-------------------------------------------------------------------------
    /** Return a vector holding all the child pages of the specified page. The
     *  loading flag filters the kind of pages to return.
     *
     * @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   user        Jahia User.
     *
     * @return  Return a Vector of JahiaPage objects. The returned vector is
     *          always non-null, but might have no pages if the specified page
     *          has not childs, or if no childs matching the loading flag were
     *          found.
     *
     * @exception   JahiaException
     *      Return this exception if any failure occured.
     */