jahiaapplicationsmanagerservice.java

java 写的一个新闻发布系统

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

//
//  JahiaApplicationsManagerService
//  NK      10.02.2000
//
//

package org.jahia.services.applications;

import java.util.*;                     // Vector, Enumeration


import org.jahia.exceptions.JahiaException;
import org.jahia.data.*;           			// JahiaData
import org.jahia.data.fields.JahiaField;
import org.jahia.data.applications.*;  		// ApplicationBean
import org.jahia.params.*;         			// ParamBean
import org.jahia.services.*;       			// JahiaService


/**
 * This Service is used to manage the jahia application definitions.
 *
 * @author Khue ng
 * @version 1.0
 */
public abstract class JahiaApplicationsManagerService extends JahiaService
{


	//--------------------------------------------------------------------------
	/***
	 * return a vector of distinct Jahia web site for all application definitions
     *
     * @return a Vector of Jahia Web site
     */
    public abstract Vector getWebSites()
    throws JahiaException;

	//--------------------------------------------------------------------------
	/***
	 * return an Application Definition get directly from db
     *
     * @param appID the appID
     * @return ApplicationBean, the Application Definition
     */
    public abstract ApplicationBean getApplication( int appID )
    throws JahiaException;

	//--------------------------------------------------------------------------
	/***
	 * return an Application Definition looking at its context.
     *
	 * @param context , the context
     * @return ApplicationBean, the Application Definition
     */
    public abstract ApplicationBean getApplication( String context )
    throws JahiaException;

	//--------------------------------------------------------------------------
	/***
	 * return all application Definitions
     *
     * @return Enumeration an enumerations of ApplicationBean or null if empty
     */
    public abstract Vector getApplications()
    throws JahiaException;

	//--------------------------------------------------------------------------
	/***
	 * return all application Definitions for a gived site ( jahia id )
     *
     * @param int the JahiaID web site
     * @return Vector of ApplicationBean
     */
    public abstract Vector getApplications(int jahiaID)
    throws JahiaException;

	//--------------------------------------------------------------------------
	/***
	 * set an application Visible to users
	 *
	 * @param int appID
	 * @param boolean visible status
	 * @return false on error
	 */
	public abstract boolean setVisible(int appID, boolean visible)
	throws JahiaException;

	//--------------------------------------------------------------------------
	/***
	 * Add a new Application Definition.
	 * both in ApplicationsRegistry and in Persistance
	 *
	 * @param ApplicationBean the app Definition
	 * @return false on error
	 */
	public abstract boolean addDefinition(ApplicationBean app)
	throws JahiaException;

	//--------------------------------------------------------------------------
	/***
	 * Save the Application Definition.
	 * both in ApplicationsRegistry and in Persistance
	 *
	 * @param ApplicationBean the app Definition
	 * @return false on error
	 */
	public abstract boolean saveDefinition(ApplicationBean app)
	throws JahiaException;

	//--------------------------------------------------------------------------
    /**
     * Removes an application from the persistant storage area and from registry.
     *
     * @param appID identifier of the application to remove from the persistant
     * storage area
     * @exception generated if there was an error while removing the application
     * data from persistant storage area
     */
    public abstract void removeApplication ( int appID )
    throws JahiaException;

	//--------------------------------------------------------------------------
	/**
	 * delete groups associated with an application.
	 * When deleting an Application definition, should call this method to
	 * remove unused groups
	 *
	 **/
	public abstract void deleteApplicationGroups(ApplicationBean app)
	throws JahiaException;

	//--------------------------------------------------------------------------
	/**
	 * create groups for each context, that is for each field id
	 *
	 */
    public abstract void createApplicationGroups( ApplicationBean theApp, JahiaField theField)
    throws JahiaException;

	//--------------------------------------------------------------------------
	/**
	 * delete groups associated with a gived context, that is attached to a field id
	 * and all its members
	 */
    public abstract void deleteApplicationGroups( ApplicationBean theApp, JahiaField theField )
    throws JahiaException;

    //--------------------------------------------------------------------------
	/**
	 * return a DOM document of applications definitions
	 *
	 * @param int the site id
	 *
	 * @return JahiaDOMObject a DOM representation of this object
	 *
	 * @author NK
	 */
	public abstract JahiaDOMObject getApplicationDefsAsDOM( int siteID )
	throws JahiaException;



} // end JahiaApplicationsService