jahiaapplicationspersistanceservice.java

java 写的一个新闻发布系统

//
//  JahiaApplicationsDBService
//  EV      29.11.2000
//
//  get_applications_list( jahiaID )
//  get_application_definition( appID )

//  add_application( appBean )
//  update_application( appBean )
//

package org.jahia.services.applications;

import java.sql.*;                      // Resultset
import java.util.*;                     // Vector

import org.jahia.exceptions.JahiaException;
import org.jahia.data.*;            // JahiaData
import org.jahia.data.fields.JahiaField;
import org.jahia.data.applications.*;
import org.jahia.services.*;        // JahiaService
import org.jahia.*;
import org.jahia.services.usermanager.JahiaUser;

import org.jahia.data.JahiaDOMObject;
import org.jahia.data.JahiaDBDOMObject;


/**
 * This services offers methods that allow the storage and retrieval of application
 * information from a persistant source, such as a database, flat files, XML
 * files.
 * You should not directly access this service, but rather through the JahiaApplicationManagerService !
 *
 * @author Eric Vassalli, Serge Huber
 * @version 1.0
 */

public abstract class JahiaApplicationsPersistanceService extends JahiaService{


    /**
     * Retrieves the number of distinct jahia website
     * exist it creates it.
     * @returns Singleton instance of the service
     */
    public abstract Vector getWebSites() throws JahiaException ;


    /**
     * Retrieves the list of available applications .
     * called by FieldForms.drawApplicationForm
     * @param visibleOnly if true, return only applications with visible status = 1
     * @returns Vector containing ApplicationBean objects that contain the application
     * definitions
     * @exception JahiaException generated if an error occured during retrieval
     * fromm persistant storage
     */
    public abstract Vector get_applications_list( boolean visibleOnly ) throws JahiaException;


    /**
     * Retrieves the list of available applications for a jahia site.
     * called by FieldForms.drawApplicationForm
     * @param jahiaID identifier of the jahia site that we are requesting the
     * applications for
     * @param visibleOnly if true, return only applications with visible status = 1
     * @returns Vector containing ApplicationBean objects that contain the application
     * definitions
     * @exception JahiaException generated if an error occured during retrieval
     * fromm persistant storage
     */
    public abstract Vector get_applications_list( int jahiaID , boolean visibleOnly)
    throws JahiaException;

    /**
     * Retrieves a single application definition by specifying it's index in the
     * persistant storage area.
     * called by ApplicationsRegistry.getApplication()
     * @param appID identifier of the application
     * @returns ApplicationBean object containing the information relative to
     * the application retrieved from persistant storage
     */
    public abstract ApplicationBean get_application_definition( int appID )
    throws JahiaException;

	/**
	 * return an Application Definition , looking at the context
	 *
	 */
    public abstract ApplicationBean get_application_definition( String context )
    throws JahiaException;


    /**
     * Adds an application entry in persistant storage
     * called by DownloadApp_Engine.processForm()
     * @param theApp an ApplicationBean to be stored in persistant storage area
     * @exception JahiaException if there was an error during storage
     */
    public abstract void add_application( ApplicationBean theApp )
    throws JahiaException;

    /**
     * Updates the entry for an application in the persistant storage area
     * called by add_application
     * @param theApp an ApplicationBean object containing the new data that
     * will replace the data stored in the persistant storage area
     * @exception JahiaException if there was an error while updating the data
     * in the persistant storage area
     */
    public abstract void update_application( ApplicationBean theApp )
    throws JahiaException;

    /**
     * Removes an application from the persistant storage area
     * @param theApp an ApplicationBean object containing 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 ( ApplicationBean theApp )
    throws JahiaException;

    /**
     * Removes an application from the persistant storage area
     * @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;

    //--------------------------------------------------------------------------
	/**
	 * 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;



    ///////////////////////////////////////////////////////////////////////////////////////////////
    // FIXME -Fulco-
    //
    //      The purpose of the method is only to add the creator of an application
    //      (application adding on a page) into the groups "manager" and "administrator".
    //
    //      REMOVE THIS METHOD AS SOON AS POSSIBLE !!!!!!
    //
    ///////////////////////////////////////////////////////////////////////////////////////////////
    public abstract void fake_create_application_groups (ApplicationBean theApp,
                                                int fieldID,
                                                JahiaUser user)
        throws JahiaException;


} // end ApplicationsDBManager