com.sapportals.wcm.service.propertystructure

Interface IPropertyStructure

public interface IPropertyStructure

Preconfigured structure for displaying the properties of a resource.

Method Summary

StructureDisplayMode[]	getDisplayModes() All supported display modes of the structure.
String	getLabel(Locale locale) Gets the label for the structure.
String	getName() Gets the name of the structure.
IStructuredGroupItemList	getOrderedItems() Gets all first level items of the structure in their configured order.
String[]	getResourceTypes() All resource types for that the structure is configured.
boolean	isSingleFocusEnabled() Checks if the groups of this structure (only 1 level) should be displayed in a way that always only one group is in the focus
boolean	isSupportedDisplayMode(StructureDisplayMode displayMode) Checks if a display mode is supported by a structure.

Method Detail

getName

public String getName()
               throws PropertyStructureServiceException

Gets the name of the structure.

Returns:

structure name

Throws:

PropertyStructureServiceException

getOrderedItems

public IStructuredGroupItemList getOrderedItems()
                                         throws PropertyStructureServiceException

Gets all first level items of the structure in their configured order. An item can be a IStructuredGroup or a IStructuredProperty.

Returns:

first level items of the structure

Throws:

PropertyStructureServiceException

getResourceTypes

public String[] getResourceTypes()
                          throws PropertyStructureServiceException

All resource types for that the structure is configured.

Returns:

resource types of the structure

Throws:

PropertyStructureServiceException

getDisplayModes

public StructureDisplayMode[] getDisplayModes()
                                       throws PropertyStructureServiceException

All supported display modes of the structure.

Returns:

display modes of the structure

Throws:

PropertyStructureServiceException

isSupportedDisplayMode

public boolean isSupportedDisplayMode(StructureDisplayMode displayMode)
                               throws PropertyStructureServiceException

Checks if a display mode is supported by a structure.

Parameters:

displayMode - display mode to check

Returns:

true if the display mode is supported

Throws:

PropertyStructureServiceException

getLabel

public String getLabel(Locale locale)
                throws PropertyStructureServiceException

Gets the label for the structure.

Parameters:

locale - locale to determine the labels language

Throws:

PropertyStructureServiceException

isSingleFocusEnabled

public boolean isSingleFocusEnabled()
                             throws PropertyStructureServiceException

Checks if the groups of this structure (only 1 level) should be displayed in a way that always only one group is in the focus

Returns:

true if the groups should be rendered in single focus mode (e.g. as tab strip)

Throws:

PropertyStructureServiceException