com.sssw.portal.api
Interface EbiPageManager

public interface EbiPageManager

This provides an interface for the portal page manager.

Method Summary

boolean	clearPagesFromCache() Clears the pages from cache.
boolean	clearPagesFromCache(EbiPortalContext context, String categoryID) Clears the pages that belong to a category from cache.
Document	getPage(EbiPortalContext context, String pageID) Deprecated. EbiPageManager.getPID(EbiPortalContext,String,boolean)
Document	getPage(EbiPortalContext context, String pageID, boolean flush) Deprecated. EbiPageManager.getPID(EbiPortalContext,String,boolean)
EbiCategoryInfo	getPageCategoryInfo(EbiPortalContext context, String category) Gets a page category info.
EbiCategoryInfo	getPageCategoryInfo(EbiPortalContext context, String categoryName, boolean flush) Gets a page category info.
EbiCategoryInfo[]	getPageCategoryInfoList(EbiPortalContext context) Gets a list of page categories info.
EbiPageInfo	getPageInfo(EbiPortalContext context, String pageID) Gets a page info.
EbiPageInfo	getPageInfo(EbiPortalContext context, String pageID, boolean flush) Gets a page info.
EbiPageInfo[]	getPageInfoList(EbiPortalContext context, String categoryID) Gets a list of EbiPageInfo objects for a specified category.
EbiPortalPID	getPID(EbiPortalContext context, String pageID) Gets a EboPortalPID object.
EbiPortalPID	getPID(EbiPortalContext context, String pageID, boolean flush) Gets a EboPortalPID object.

Method Detail

getPID

public EbiPortalPID getPID(EbiPortalContext context,
                           String pageID)
                    throws EboUnrecoverableSystemException,
                           EboSecurityException

Gets a EboPortalPID object.

Parameters:

context - a context.

pageID - a page identifier.

getPID

public EbiPortalPID getPID(EbiPortalContext context,
                           String pageID,
                           boolean flush)
                    throws EboUnrecoverableSystemException,
                           EboSecurityException

Gets a EboPortalPID object.

Parameters:

context - a context.

pageID - a page identifier.

flush - if true get fresh copy from the persistent provider and flush the cache

getPage

public Document getPage(EbiPortalContext context,
                        String pageID,
                        boolean flush)
                 throws EboUnrecoverableSystemException

Deprecated. EbiPageManager.getPID(EbiPortalContext,String,boolean)

Gets a page DOM object.

Parameters:

context - a context.

pageID - a page identifier.

flush - true if needs to flush the cache and re-get it from db.

Returns:

the DOM object for the specified page.

getPage

public Document getPage(EbiPortalContext context,
                        String pageID)
                 throws EboUnrecoverableSystemException

Deprecated. EbiPageManager.getPID(EbiPortalContext,String,boolean)

Gets a page DOM object.

Parameters:

context - a context.

pageUIID - a page UUID.

Returns:

the DOM object for the specified page.

getPageInfo

public EbiPageInfo getPageInfo(EbiPortalContext context,
                               String pageID,
                               boolean flush)
                        throws EboUnrecoverableSystemException

Gets a page info.

Parameters:

context - a context.

pageID - a pageID

flush - true, flush the cache and re-get page info from database

Returns:

an EbiPageInfo object for the specified page.

getPageInfo

public EbiPageInfo getPageInfo(EbiPortalContext context,
                               String pageID)
                        throws EboUnrecoverableSystemException

Gets a page info.

Parameters:

context - a context.

pageID - a page ID

flush - true, flush the cache and re-get page info from database

Returns:

an EbiPageInfo object for the specified page.

getPageInfoList

public EbiPageInfo[] getPageInfoList(EbiPortalContext context,
                                     String categoryID)
                              throws EboUnrecoverableSystemException

Gets a list of EbiPageInfo objects for a specified category. (always gets from db)

Parameters:

context - a context.

categoryID - a category name (if null, get all pages)

Returns:

an array of EbiPageInfo objects for the specified category.

clearPagesFromCache

public boolean clearPagesFromCache()
                            throws EboUnrecoverableSystemException

Clears the pages from cache.

Returns:

true if the pages are removed from cache successfully.

clearPagesFromCache

public boolean clearPagesFromCache(EbiPortalContext context,
                                   String categoryID)
                            throws EboUnrecoverableSystemException

Clears the pages that belong to a category from cache.

Parameters:

context - an EbiContext object.

categoryID - a category name.

Returns:

true if the page for a category are removed from the cache successfully.

getPageCategoryInfo

public EbiCategoryInfo getPageCategoryInfo(EbiPortalContext context,
                                           String categoryName,
                                           boolean flush)
                                    throws EboUnrecoverableSystemException

Gets a page category info.

Parameters:

context - a context.

categoryName - a name of the specified category.

flush - true if needs to flush the cache and re-get it from db.

Returns:

an EbiCategoryInfo object.

getPageCategoryInfo

public EbiCategoryInfo getPageCategoryInfo(EbiPortalContext context,
                                           String category)
                                    throws EboUnrecoverableSystemException

Gets a page category info.

Parameters:

context - a context.

category - a category

Returns:

an EbiCategoryInfo object.

getPageCategoryInfoList

public EbiCategoryInfo[] getPageCategoryInfoList(EbiPortalContext context)
                                          throws EboUnrecoverableSystemException

Gets a list of page categories info.

Parameters:

context - a context.

Returns:

an array of EbiCategoryInfo objects for page categories.