com.sssw.portal.api
Interface EbiPageLayoutInfo

All Known Subinterfaces:

EbiContainerPageInfo, EbiGroupPageInfo, EbiSharedPageInfo, EbiUserPageInfo

public interface EbiPageLayoutInfo

Interface for managing the page layout information of a specific portal application.

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.
EbiPageLayoutInfo	cloneCopy() Clone this object, and reset the read-only flag in the cloned object.
EbiPageLayoutInfo	cloneCopy(String anotherPortalID) Clone this object, and reset the read-only flag, page name, and the portal ID in the cloned object.
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	getDescription() Gets the description of this layout page.
String	getDisplayName() Gets the layout page display name.
String	getPageLayoutType() Gets the type of this page layout.
String	getPageName() Gets the page name of a page layout.
String	getPortalID() Gets Portal ID.
String	getPortalLayoutID() Gets the portal layout identifier.
String[]	getSectionIDs() Gets a list of section IDs that contains selected components.
String	getSelectedComponentsXML() Gets the XML String that contains only the selected components.
String	getStyleID() Gets the style ID which the page uses to style it - typically for custom layouts.
void	removeComponent(EbiPortalContext context, String componentName, String instanceID) Remove a component from the selection list.
void	removeComponent(EbiPortalContext context, String componentName, String instanceID, String from) Remove a component from the selection list.
void	setDescription(String description) Sets the description of this layout page.
void	setDisplayName(String displayName) Sets the display name of this layout page.
void	setPageName(String pageName) Sets a page name for a page layout.
void	setPortalID(String portalID) Sets Portal ID.
void	setPortalLayoutID(EbiPortalContext context, String layoutID) Sets the portal layout identifier and validate the sections with the new layout.
void	setPortalLayoutID(String layoutID) Sets the portal layout identifier.
void	updateSectionComponents(EbiPortalContext context, String sectionID, String[] comps) Updates the order of components in the specified section.
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

getPageLayoutType

public String getPageLayoutType()

Gets the type of this page layout.

getPortalID

public String getPortalID()

Gets Portal ID.

getPageName

public String getPageName()

Gets the page name of a page layout.

getDisplayName

public String getDisplayName()

Gets the layout page display name.

getDescription

public String getDescription()

Gets the description of this layout page.

getPortalLayoutID

public String getPortalLayoutID()

Gets the portal layout identifier.

getStyleID

public String getStyleID()

Gets the style ID which the page uses to style it - typically for custom layouts.

Returns:

a portal style id.

getSelectedComponentsXML

public String getSelectedComponentsXML()

Gets the XML String that contains only the selected components.

getComponentsBySection

public NodeList getComponentsBySection(String sectionID)

Gets the list of selected components by a specified section.

Parameters:

sectionID - a section identifier.

Returns:

a NodeList object that contains the list of components.

updateSectionComponents

public void updateSectionComponents(EbiPortalContext context,
                                    String sectionID,
                                    String[] comps)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Updates the order of components in the specified section.

Parameters:

context - an EbiPortalContext object.

sectionID - a section identifier.

comps - a String array of components (name, instanceid pairs)

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.

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, adjustments are made automatically.

Parameters:

context - an EbiPortalContext object.

setPortalID

public void setPortalID(String portalID)

Sets Portal ID.

Parameters:

portalID - a portal identifier.

setPageName

public void setPageName(String pageName)

Sets a page name for a page layout.

Parameters:

pageName - a page name.

setDisplayName

public void setDisplayName(String displayName)

Sets the display name of this layout page.

Parameters:

displayName - a display name.

setDescription

public void setDescription(String description)

Sets the description of this layout page.

Parameters:

description - a description.

setPortalLayoutID

public void setPortalLayoutID(String layoutID)

Sets the portal layout identifier.

Parameters:

layoutID - a portal layout identifier.

setPortalLayoutID

public void setPortalLayoutID(EbiPortalContext context,
                              String layoutID)
                       throws EboUnrecoverableSystemException,
                              EboSecurityException

Sets the portal layout identifier and validate the sections with the new layout.

Parameters:

context - an EbiPortalContext.

layoutID - a portal layout identifier.

addComponent

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

Adds a component to the selection list.

Parameters:

context - an EbiPortalContext object.

componentName - a component name.

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

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

Since:

v5.0

removeComponent

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

Remove a component 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

Remove a component from the selection list.

Parameters:

context - an EbiPortalContext object.

componentName - a component name.

instanceID - a component instance identifier.

cloneCopy

public EbiPageLayoutInfo cloneCopy()

Clone this object, and reset the read-only flag in the cloned object.

Returns:

a cloned copy of this object.

cloneCopy

public EbiPageLayoutInfo cloneCopy(String anotherPortalID)

Clone this object, and reset the read-only flag, page name, and the portal ID in the cloned object.

Parameters:

anotherPortalID - another portal war's ID.

Returns:

a cloned copy of this object.