com.sapportals.wcm.service.propertystructure

Interface IPropertyStructureService

All Superinterfaces:

IService

public interface IPropertyStructureService
extends IService

Provides structure information for rendering property dialogs.

Method Summary

IPropertyStructure	getPropertyStructure(String name) Get the property structure with the requested name.
IPropertyStructureList	getPropertyStructures() Gets all available property structures of the service.
IPropertyStructureList	getPropertyStructures(String resourceType, StructureDisplayMode displayMode) Gets property structures for a requested resource type and display mode.
IPropertyStructureList	getPropertyStructures(String resourceType, StructureDisplayMode displayMode, IMetaContext metaContext) Gets property structures for a requested resource type and display mode.

Methods inherited from interface com.sapportals.wcm.service.IService

getDescription, getDescription, getID

Method Detail

getPropertyStructure

IPropertyStructure getPropertyStructure(String name)
                                        throws PropertyStructureServiceException

Get the property structure with the requested name.

Parameters:

name - name of the structure

Returns:

the structure or null

Throws:

PropertyStructureServiceException

getPropertyStructures

IPropertyStructureList getPropertyStructures()
                                             throws PropertyStructureServiceException

Gets all available property structures of the service.

Returns:

all property structures

Throws:

PropertyStructureServiceException

getPropertyStructures

IPropertyStructureList getPropertyStructures(String resourceType,
                                             StructureDisplayMode displayMode,
                                             IMetaContext metaContext)
                                             throws PropertyStructureServiceException

Gets property structures for a requested resource type and display mode.

Parameters:

resourceType - resource type that must be configured for the structure

displayMode - display mode that must be supported by the structure

metaContext - context information for filtering properties of the structure. The returned structures only containing properties that are relevant for this context.

Returns:

list of property structures that are fulfiling the filter criterias If the display mode is null or StructureDisplayMode.UNDEFINED, all structures that are configured for the resource type are returned. If resource type is null it is set to $unknown$ internally. In the case that a structure exists for that resource type it will be used for all resources that have no resource type. If no structure matches for the resource type an empty list is returned.

Throws:

PropertyStructureServiceException

getPropertyStructures

IPropertyStructureList getPropertyStructures(String resourceType,
                                             StructureDisplayMode displayMode)
                                             throws PropertyStructureServiceException

Gets property structures for a requested resource type and display mode.

Parameters:

resourceType - resource type that must be configured for the structure

displayMode - display mode that must be supported by the structure

Returns:

list of property structures that are fulfiling the filter criterias If the display mode is null or StructureDisplayMode.UNDEFINED, all structures that are configured for the resource type are returned. If resource type is null it is set to $unknown$ internally. In the case that a structure exists for that resource type it will be used for all resources that have no resource type. If no structure matches for the resource type an empty list is returned.

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