jahiasitesservice.java

java 写的一个新闻发布系统

//
//                                   ____.
//                       __/\ ______|    |__/\.     _______
//            __   .____|    |       \   |    +----+       \
//    _______|  /--|    |    |    -   \  _    |    :    -   \_________
//   \\______: :---|    :    :           |    :    |         \________>
//           |__\---\_____________:______:    :____|____:_____\
//                                      /_____|
//
//                 . . . i n   j a h i a   w e   t r u s t . . .
//
//
//  JahiaSitesService
//
//  NK      12.03.2001
//
package org.jahia.services.sites;

import java.util.Enumeration;

import org.jahia.services.JahiaService;
import org.jahia.settings.JahiaPrivateSettings;
import org.jahia.exceptions.JahiaException;
import org.jahia.exceptions.JahiaInitializationException;
import org.jahia.services.usermanager.JahiaGroup;
import org.jahia.services.usermanager.JahiaUser;
import org.jahia.services.pages.*;
import org.jahia.data.*;

/**
 * Jahia Multi Sites Management Service
 *
 * @author Khue ng
 */
public abstract class JahiaSitesService extends JahiaService
{

	public static final int ORDER_BY_SERVER_NAME = 1;
	public static final int ORDER_BY_TITLE = 2;


	/**
	 * return the list of all sites
	 *
	 * @return Enumeration an enumeration of JahiaSite bean
	 */
    public abstract Enumeration getSites()
        throws JahiaException;


	/**
	 * return the site bean looking at it id
	 *
	 * @param int the JahiaSite id
	 * @return JahiaSite the JahiaSite bean
	 */
    public abstract JahiaSite getSite( int id )
        throws JahiaException;


	/**
	 * return a site looking at its key
	 *
	 * @param String site key
	 * @return JahiaSite the JahiaSite bean or null
	 */
    public abstract JahiaSite getSiteByKey( String siteKey )
        throws JahiaException;


	/**
	 * return a site looking at its server name
	 *
	 * @param String site name
	 * @return JahiaSite the JahiaSite bean or null
	 */
    public abstract JahiaSite getSite( String name )
        throws JahiaException;


	/**
	 * Add a new site only if there is no other site with same server name
	 *
	 * @param JahiaSite the JahiaSite bean
	 * @param JahiaSite the Creator
	 *
	 * @return boolean false if there is another site using same server name
	 * @auhtor NK
	 */
	public abstract boolean addSite( JahiaSite site )
        throws JahiaException;


	/**
	 * remove a site
	 *
	 * @param JahiaSite the JahiaSite bean
	 */
    public abstract void removeSite( JahiaSite site )
        throws JahiaException;


	/**
	 * Update a JahiaSite definition
	 *
	 * @param JahiaSite the site bean object
	 */
    public abstract void updateSite( JahiaSite site )
        throws JahiaException;



    //-------------------------------------------------------------------------
    /**
     * Return the amount of sites in the system.
     *
     * @return
     *      Amount of sites in the system.
     */
    public abstract int getNbSites ()
        throws JahiaException;

    //-------------------------------------------------------------------------
    /**
     * Add a site to the list of site going to be deleted
     *
     * @param int siteID
     */
    public abstract void addSiteToDelete (int siteID);

    //-------------------------------------------------------------------------
    /**
     * Remove a given site from the list of site going to be deleted
     *
     * @param int siteID
     */
    public abstract void removeSiteToDelete (int siteID);

    //-------------------------------------------------------------------------
    /**
     * Return true if the given site is going to be deleted
     *
     * @param int the site id
     * @return boolean
     */
    public abstract boolean isSiteToBeDeleted (int siteID);

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

    //--------------------------------------------------------------------------
    /**
     * returns a DOM representation of a site's properties
     *
     * @param int siteID
     * @auhtor NK
     */
    public abstract JahiaDOMObject getSitePropsAsDOM( int siteID ) throws JahiaException;


}