+

Search Tips   |   Advanced Search

 PREV CLASS   NEXT CLASS
Tree 
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ibm.portal.state.accessors.pagemode
Interface PageModeAccessor

All Superinterfaces:
Accessor, Disposable
All Known Subinterfaces:
PageModeAccessorController
public interface PageModeAccessor
extends Accessor

Provides read access to the page mode information of the state.

Since:
8.5

Method Summary
 java.util.Set<PageMode> getActive()
          Return the set of active page modes.
 java.util.Set<java.lang.String> getActiveAsString()
          Return the set of active page modes.
 boolean isActive(PageMode mode)
          Check if the given PageMode is active.
 
Methods inherited from interface com.ibm.portal.Disposable
dispose
 

Method Detail

isActive

boolean isActive(PageMode mode)
Checks if the given PageMode is active.

Returns:
true if the given page mode is active, false otherwise. Defaults to false if the underlying state document does not contain this information.

getActive

java.util.Set<PageMode> getActive()
Returns the set of active page modes.

Returns:
A set containing all active page modes. May be empty but not null.

getActiveAsString

java.util.Set<java.lang.String> getActiveAsString()
Returns the set of active page modes.

Returns:
A set containing all active page modes. May be empty but not null.
 PREV CLASS   NEXT CLASS
Tree 
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD