com.sapportals.wcm.service.propertystructure

Interface IPropertyStructure

public interface IPropertyStructure

Preconfigured structure for displaying the properties of a resource.

Method Summary

StructureDisplayMode[]	getDisplayModesNew() 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

String getName()
               throws PropertyStructureServiceException

Gets the name of the structure.

Returns:

structure name

Throws:

PropertyStructureServiceException

getOrderedItems

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

String[] getResourceTypes()
                          throws PropertyStructureServiceException

All resource types for that the structure is configured.

Returns:

resource types of the structure

Throws:

PropertyStructureServiceException

getDisplayModesNew

StructureDisplayMode[] getDisplayModesNew()
                                          throws PropertyStructureServiceException

All supported display modes of the structure.

Returns:

display modes of the structure

Throws:

PropertyStructureServiceException

isSupportedDisplayMode

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

String getLabel(Locale locale)
                throws PropertyStructureServiceException

Gets the label for the structure.

Parameters:

locale - local to determine the labels language

Returns:

label for the structure

Throws:

PropertyStructureServiceException

isSingleFocusEnabled

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

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM