com.ibm.mashups.enabler.model.state
Interface AccessorFactory


public AccessorFactory

Interface representing an AccessorFactory. Accessor API should be used to read/write information from NavigationStateModel.


Method Summary
 PageAccessor getPageAccessor(NavigationStateModel navStateModel, String spaceId)
           Returns the Accessor to access Page selection in each Space
 SpaceAccessor getSpaceAccessor(NavigationStateModel navStateModel)
           Returns the Accessor to access Space selection
 WidgetAccessor getWidgetAccessor(NavigationStateModel navStateModel, String widgetId)
           Returns the Widget Accessor to access Widget state information
 PageModeAccessor getPageModeAccessor(NavigationStateModel navStateModel)
           Returns the Accessor to access Page mode of current page
 ShareableParameterSetAccessor getShareableParameterSetAccessor(NavigationStateModel navStateModel, String id, String scope)
           Returns the Accessor to access the sharable parameters
 LayoutAccessor getLayoutAccessor(NavigationStateModel navStateModel, String pageId)
           Returns the Layout Accessor to access page layout state information
 

Method Detail

getPageAccessor

PageAccessor getPageAccessor(NavigationStateModel navStateModel,
                             String spaceId)
Returns the Accessor to access Page selection in each Space

Parameters:
navStateModel - NavigationStateModel to get Space/Page Selection
spaceId - spaceId to getPage Selection
Returns:
The PageAccessor of NavigationStateModel

getSpaceAccessor

SpaceAccessor getSpaceAccessor(NavigationStateModel navStateModel)
Returns the Accessor to access Space selection

Parameters:
navStateModel - NavigationStateModel to get Space Selection
Returns:
The SpaceAccessor of NavigationStateModel

getWidgetAccessor

WidgetAccessor getWidgetAccessor(NavigationStateModel navStateModel,
                                 String widgetId)
Returns the Widget Accessor to access Widget state information

Parameters:
navStateModel - to Widget Navigation State
widgetId - to Widget Navigation State
Returns:
The WidgetAccessor of NavigationStateModel

getPageModeAccessor

PageModeAccessor getPageModeAccessor(NavigationStateModel navStateModel)
Returns the Accessor to access Page mode of current page

Parameters:
navStateModel - NavigationStateModel to get Space/Page Selection
Returns:
The PageModeAccessor of NavigationStateModel

getShareableParameterSetAccessor

ShareableParameterSetAccessor getShareableParameterSetAccessor(NavigationStateModel navStateModel,
                                                               String id,
                                                               String scope)
Returns the Accessor to access the sharable parameters

Parameters:
navStateModel - NavigationStateModel to get ShareableParameterSet
id - id of ShareableParameterSet
scope - optional scope for the sharable item set. If not provided or null, the global scope is returned.
Returns:
The ShareableParameterSetAccessor of NavigationStateModel

getLayoutAccessor

LayoutAccessor getLayoutAccessor(NavigationStateModel navStateModel,
                                 String pageId)
Returns the Layout Accessor to access page layout state information

Parameters:
navStateModel - to Layout Navigation State
pageId - of the page containing the Layout Container
Returns:
The LayoutAccessor of NavigationStateModel for the specified page


Copyright IBM Corp. 2010 All Rights Reserved.