jahiahomepagesservice.java

java 写的一个新闻发布系统

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

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

import org.jahia.services.JahiaService;
import org.jahia.exceptions.JahiaException;
import org.jahia.services.sites.JahiaSite;
import org.jahia.services.usermanager.JahiaGroup;
import org.jahia.services.usermanager.JahiaUser;
import org.jahia.data.JahiaDOMObject;

/**
 * Homepage services
 *
 * @author Khue ng
 */
public abstract class JahiaHomepagesService extends JahiaService
{

    //--------------------------------------------------------------------------
	/**
	 * return the list of all home page
	 *
	 * @return Enumeration an enumeration of JahiaHomepage bean
	 */
    public abstract Enumeration getHomepages() throws JahiaException;
		

    //--------------------------------------------------------------------------
	/**
	 * return the list of all home pages of a site.
	 *
	 * @return Enumeration an enumeration of JahiaHomepage bean
	 */
    public abstract Enumeration getHomepages(JahiaSite site) 
    throws JahiaException;
	

    //--------------------------------------------------------------------------
	/**
	 * return a Homepage bean looking at it id
	 *
	 * @param int the JahiaHomepage id
	 * @return JahiaHomepage the JahiaHomepage bean
	 */
    public abstract JahiaHomepage getHomepage( int id ) 
    throws JahiaException;


    //--------------------------------------------------------------------------
	/**
	 * Create a new Homepage that is not saved in storage yet.
	 *
	 * @param String the home page name
	 * @param String the home page descr
	 * @param String the site key
	 * @param int type the home page type
	 * @param hashtable the props
	 * @param int aclID
	 *
	 * @return Jahiahomepage the created homepage bean
	 */
	public abstract JahiaHomepage createHomepage(	String name,
													String descr,
								 	   	  			String siteKey,
								 	   	  			int type,
								 	   	  			Hashtable props,
								 	   	  			int aclID
								 	     			) throws JahiaException ;
	

    //--------------------------------------------------------------------------
	/**
	 * delete a Homepage from storage and cache
	 *
	 * @param int the home page id
	 */
    public abstract void deleteHomepage( int id )
    throws JahiaException ;
		

    //--------------------------------------------------------------------------
	/**
	 * Save a Homepage. Create it if its id is <=0 and create an ACL if it is <=0.
	 * The parent ACL is can be the site's acl.
	 *
	 * @param JahiaHomepage the homepage bean object
	 * @param int the parent ACL ID
	 */
    public abstract void saveHomepage( JahiaHomepage hp, int parentAclID )
    throws JahiaException ;


    //--------------------------------------------------------------------------
    /**
     * returns a DOM representation of all home pages of a site
     *
     * @param String siteKey
     */
    public abstract JahiaDOMObject getHomepageDefsAsDOM( String siteKey ) 
    throws JahiaException ;
    	
    //--------------------------------------------------------------------------
    /**
     * returns a DOM representation of all home pages props of a site
     *
     * @param String siteKey
     */
    public abstract JahiaDOMObject getHomepageDefPropsAsDOM( String siteKey ) 
    throws JahiaException ;

    //--------------------------------------------------------------------------
    /**
     * Returns a vector of all home page's Acl ID of this site
     * Need this for site extraction
     *
     * @param String siteKey
     */
    public abstract Vector getAclIDs( String siteKey  )
    throws JahiaException;



}