Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.service.propertystructure
Interface IPropertyStructureService

[contained in: com.sap.km.cm.service.base.par - km.shared.service.propertystructure_api.jar]
All Superinterfaces:
IService
public interface IPropertyStructureService
extends IService

Provides structure information for rendering property dialogs.

Method Summary
 IPropertyStructure getPropertyStructure(java.lang.String name)
          Get the property structure with the requested name.
 IPropertyStructureList getPropertyStructures()
          Gets all available property structures of the service.
 IPropertyStructureList getPropertyStructures(java.lang.String resourceType, StructureDisplayMode displayMode)
          Gets property structures for a requested resource type and display mode.
 IPropertyStructureList getPropertyStructures(java.lang.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

public IPropertyStructure getPropertyStructure(java.lang.String name)
                                        throws PropertyStructureServiceException
Get the property structure with the requested name.
Parameters:
name - name of the structure
Returns:
the structure or null

getPropertyStructures

public IPropertyStructureList getPropertyStructures()
                                             throws PropertyStructureServiceException
Gets all available property structures of the service.
Returns:
all property structures

getPropertyStructures

public IPropertyStructureList getPropertyStructures(java.lang.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.

getPropertyStructures

public IPropertyStructureList getPropertyStructures(java.lang.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.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.