com.sap.netweaver.bc.rf.mi.property
Interface IPropertyManager

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.mi_api.jar]

All Known Subinterfaces:

IMutablePropertyManager

public interface IPropertyManager

Read-Only interface describing a repository sub manager for properties. Resources usually have properties describing the resource. All system properties MUST be made available as properties. Resources with content MUST make the content metadata available as properties also! This interface provides means to read the properties of a resource.

Most properties are not required, but when missing, certain behaviour is assumed:

RESOURCENAME is the last RID part if not existent (and must be the last RID part if set)
COLLECTION is assumed to be false, i.e. a simple resource if not existent (and must be true for collections and false for resources)
LINKTYPE is assumed to be none, i.e. no link of any kind if not existent
DISPLAYNAME is assumed to be the resource name if not existent

Method Summary

java.util.Map	getAllProperties(IResourceHandle resourceHandle) Get map of all properties of a single resource handle.
java.util.Map	getAllProperties(java.util.List resourceHandles) Get maps of all properties of a list of resource handles.
java.util.Map	getListedProperties(IResourceHandle resourceHandle, java.util.List propertyNames) Get list of properties of a single resource handle.
java.util.Map	getListedProperties(java.util.List resourceHandles, java.util.List propertyNames) Get list of properties of a list of resource handles.
java.util.Map	getProperties(java.util.List resourceHandles, IPropertyName propertyName) Get single property of a list of resource handles.
IProperty	getProperty(IResourceHandle resourceHandle, IPropertyName propertyName) Get single property of a single resource handle.

Method Detail

getProperty

public IProperty getProperty(IResourceHandle resourceHandle,
                             IPropertyName propertyName)
                      throws ResourceException

Get single property of a single resource handle. Returns null if the property is not set.

Parameters:

resourceHandle - resource handle

propertyName - property name

Returns:

property

Throws:

ResourceException - when either the resource handle or the property name is invalid or the property retrieval failed

getListedProperties

public java.util.Map getListedProperties(IResourceHandle resourceHandle,
                                         java.util.List propertyNames)
                                  throws ResourceException

Get list of properties of a single resource handle. Not found properties are ignored and are not stored inside the returned data structure (not even with a null value). Returns an empty map if no property is set.

Parameters:

resourceHandle - resource handle

propertyNames - list of property names

Returns:

map of properties indexed by property names

Throws:

ResourceException - when either the resource handle or the property names are invalid or the property retrieval failed

getAllProperties

public java.util.Map getAllProperties(IResourceHandle resourceHandle)
                               throws ResourceException

Get map of all properties of a single resource handle. Returns an empty map if no property is available.

Parameters:

resourceHandle - resource handle

Returns:

map of properties indexed by property names

Throws:

ResourceException - when either the resource handle is invalid or the property retrieval failed

getProperties

public java.util.Map getProperties(java.util.List resourceHandles,
                                   IPropertyName propertyName)
                            throws ResourceException,
                                   OperationNotCompletedException

Get single property of a list of resource handles. Resources without the property are ignored and are not stored inside the returned data structure (not even with a null value). Returns an empty map if the property is not set for all resources.

Note: This method needs not to be handled atomically! Although this operation may fail in parts, the operation on one of the many operands provided through the parameter list is always expected to be atomic!

Parameters:

resourceHandles - list of resource handles

propertyName - property name

Returns:

map of properties indexed by the resource handles

Throws:

ResourceException - when a general problem occured

OperationNotCompletedException - when the operation failed in parts (either a resource handle or a property name was invalid or a property retrieval failed)

getListedProperties

public java.util.Map getListedProperties(java.util.List resourceHandles,
                                         java.util.List propertyNames)
                                  throws ResourceException,
                                         OperationNotCompletedException

Get list of properties of a list of resource handles. Not found properties are ignored and are not stored inside the returned data structure (not even with a null value). If no properties are found for a resource, the whole resource isn't stored inside the returned data structure too. Returns an empty map if no properties are set for all resources.

Note: This method needs not to be handled atomically! Although this operation may fail in parts, the operation on one of the many operands provided through the parameter list is always expected to be atomic!

Parameters:

resourceHandles - list of resource handles

propertyNames - list of property names

Returns:

map of maps of properties indexed by resource handles; the inner maps hold properties indexed by property names

Throws:

ResourceException - when a general problem occured

OperationNotCompletedException - when the operation failed in parts (either a resource handle or a property name was invalid or a property retrieval failed)

getAllProperties

public java.util.Map getAllProperties(java.util.List resourceHandles)
                               throws ResourceException,
                                      OperationNotCompletedException

Get maps of all properties of a list of resource handles. If no properties are available for a resource, the whole resource isn't stored inside the returned data structure. Returns an empty map if no properties are available for all resources.

Note: This method needs not to be handled atomically! Although this operation may fail in parts, the operation on one of the many operands provided through the parameter list is always expected to be atomic!

Parameters:

resourceHandles - list of resource handles

Returns:

map of maps of properties indexed by resource handles; the inner maps hold properties indexed by property names

Throws:

ResourceException - when a general problem occured

OperationNotCompletedException - when the operation failed in parts (either a resource handle or a property name was invalid or a property retrieval failed)