com.sssw.portal.api
Interface EbiPageLayoutHandler

All Superinterfaces:

Cloneable, Serializable

public interface EbiPageLayoutHandler

extends Cloneable, Serializable

Interface for managing manages sections and components in sections for either a user page or a group page.

Method Summary

void	addComponent(EbiPortalContext context, String componentName, String sectionID) Adds a component to the selection list.
void	addComponent(EbiPortalContext context, String componentName, String sectionID, String instanceID) Adds a component to the selection list.
String[]	getAllowedSectionIDs(EbiPortalContext context) Gets a list of allowed section IDs according to the selected layout.
NodeList	getComponentsBySection(String sectionID) Gets the list of selected components by a specified section.
String[]	getSectionIDs() Gets a list of section IDs that contains selected components.
String	getSelectedComponentsXML() Gets the XML String that contains only the selected components.
void	initialize(Document pageDoc) Initializes this instance from a User page or a group page.
void	removeComponent(EbiPortalContext context, String componentName, String instanceID) Removes specified component from the selection list.
void	removeComponent(EbiPortalContext context, String componentName, String instanceID, String from) Removes a compnent from the selection list.
void	replacePage(EbiPortalContext context, Document newPageDoc) Replaces with the new page doc.
void	validateLayout(EbiPortalContext context) Validates the selected components to see if the sections that the components are binding to are consistent with the selected layout.

Method Detail

getComponentsBySection

public NodeList getComponentsBySection(String sectionID)

Gets the list of selected components by a specified section.

Parameters:

sectionID - a section identifier.

Returns:

a NodeList that contains the list of components.

getSectionIDs

public String[] getSectionIDs()

Gets a list of section IDs that contains selected components.

Returns:

a String array of section IDs.

getAllowedSectionIDs

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

Gets a list of allowed section IDs according to the selected layout.

Parameters:

context - an EbiPortalContext object.

Returns:

a String array of allowed section IDs.

getSelectedComponentsXML

public String getSelectedComponentsXML()

Gets the XML String that contains only the selected components.

Returns:

get XML String with selected components.

initialize

public void initialize(Document pageDoc)

Initializes this instance from a User page or a group page.

Parameters:

pageDoc - A user page or a group page document.

replacePage

public void replacePage(EbiPortalContext context,
                        Document newPageDoc)
                 throws EboUnrecoverableSystemException,
                        EboSecurityException

Replaces with the new page doc. This allows to re-do the page completely.

Parameters:

context - An EbiPortalContext context.

newPageDoc - A new page doc.

validateLayout

public void validateLayout(EbiPortalContext context)
                    throws EboUnrecoverableSystemException,
                           EboSecurityException

Validates the selected components to see if the sections that the components are binding to are consistent with the selected layout. If not, adjustment is made automatically

Parameters:

context - An EbiPortalContext object.

addComponent

public void addComponent(EbiPortalContext context,
                         String componentName,
                         String sectionID)
                  throws EboUnrecoverableSystemException,
                         EboSecurityException

Adds a component to the selection list. This method generates a component instance ID automatically.

Parameters:

context - An EbiPortalContext object.

componentName - A component name.

sectionID - A section identifier where the component is going to be added to.

addComponent

public void addComponent(EbiPortalContext context,
                         String componentName,
                         String sectionID,
                         String instanceID)
                  throws EboUnrecoverableSystemException,
                         EboSecurityException

Adds a component to the selection list. This method generates a component instance ID automatically.

Parameters:

context - an EbiPortalContext object.

componentName - a component name.

sectionID - a section identifier where the component is going to be added to.

instanceID - a predefined portlet/component instance ID

removeComponent

public void removeComponent(EbiPortalContext context,
                            String componentName,
                            String instanceID,
                            String from)
                     throws EboUnrecoverableSystemException,
                            EboSecurityException

Removes a compnent from the selection list.

Parameters:

context - An EbiPortalContext object.

componentName - A component name.

instanceID - A component instance identifier.

from - A section identifier where the component is going to be removed from.

removeComponent

public void removeComponent(EbiPortalContext context,
                            String componentName,
                            String instanceID)
                     throws EboUnrecoverableSystemException,
                            EboSecurityException

Removes specified component from the selection list.

Parameters:

context - An EbiPortalContext object.

componentName - A component name.

instanceID - A component instance identifier.