com.sssw.portal.api
Interface EbiLayoutManager

public interface EbiLayoutManager

Interface for the portal layout manager.

Method Summary

Document	getLayoutDefinition(EbiPortalContext context, String layoutID) Gets the layout definition for a given layout.
EbiLayoutInfo	getLayoutInfo(EbiPortalContext context, String layoutID) Gets the information object for a layout that has a particular ID.
EbiLayoutInfo	getLayoutInfo(EbiPortalContext context, String layoutID, boolean flush) Gets the information object for a layout that has a particular ID.
EbiLayoutInfo[]	getLayoutInfoList(EbiPortalContext context) Gets the list of layout information objects.
EbiLayoutInfo[]	getRestrictedLayoutInfoList(EbiPortalContext context) Gets all layouts which the current user can see in a select list.
String[]	getSectionIDs(EbiPortalContext context, String layoutID) Gets the list of section IDs contained in the layout definition.

Method Detail

getLayoutInfo

public EbiLayoutInfo getLayoutInfo(EbiPortalContext context,
                                   String layoutID,
                                   boolean flush)
                            throws EboUnrecoverableSystemException,
                                   EboSecurityException

Gets the information object for a layout that has a particular ID.

Parameters:

context - A context object that contains session/user information.

layoutID - The layout identifier.

flush - If true, then bypass the cache and retrieve the object from the data store (the resource set).

Returns:

An EbiLayoutInfo object.

getLayoutInfo

public EbiLayoutInfo getLayoutInfo(EbiPortalContext context,
                                   String layoutID)
                            throws EboUnrecoverableSystemException,
                                   EboSecurityException

Gets the information object for a layout that has a particular ID.

Parameters:

context - A context object that contains session/user information.

layoutID - The layout identifier.

Returns:

An EbiLayoutInfo object.

getLayoutInfoList

public EbiLayoutInfo[] getLayoutInfoList(EbiPortalContext context)
                                  throws EboUnrecoverableSystemException

Gets the list of layout information objects.

Parameters:

context - A context object that contains session/user information.

Returns:

An array of EbiLayoutInfo objects.

getLayoutDefinition

public Document getLayoutDefinition(EbiPortalContext context,
                                    String layoutID)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Gets the layout definition for a given layout.

The layout definition may be either XHTM or XML. Check EbiLayoutInfo.getLayoutDefinitionFormat() to determine what format to expect (text/xhtml or text/xml).

Parameters:

context - A context object that contains session/user information.

layoutID - The layout identifier.

Returns:

a Document representing the layout definition

getSectionIDs

public String[] getSectionIDs(EbiPortalContext context,
                              String layoutID)
                       throws EboUnrecoverableSystemException,
                              EboSecurityException

Gets the list of section IDs contained in the layout definition.

Parameters:

context - A portal context.

layoutID - The layout identifier.

Returns:

array of section IDs. Null if the Layout is not found, a 0 length string if no sections are included in the layout definition.

Throws:

EboUnrecoverableSystemException -

EboSecurityException - Thrown when the the current user does not have the proper authority to use the layout.

getRestrictedLayoutInfoList

public EbiLayoutInfo[] getRestrictedLayoutInfoList(EbiPortalContext context)
                                            throws EboUnrecoverableSystemException

Gets all layouts which the current user can see in a select list.

Parameters:

context - A portal context.

Returns:

array of layout information objects

Throws:

EboUnrecoverableSystemException -