com.sapportals.wcm.repository.service.appproperties
Interface IApplicationProperties

[contained in: com.sap.netweaver.bc.rf.service.par - bc.rf.repository.service.appproperties_api.jar]

public interface IApplicationProperties

The application properties service is used to persist arbitrary data for a resource. These so called "application properties" (IAppProperty) are not saved as custom properties of a resource in the repositories. Instead, an implementation of this service will have its own persistence e.g. a database. This means that "application properties" are never returned with a IResource.getProperty(IPropertyName) or IResource.getProperties() call (unless a property filter is used to do so).

All properties managed by this service are bound to an application via an application-defined namespace. Additionally, the properties can be personalized, that means that a user ID is used as an additional key to persist such properties.

An application properties service implementation must handle rename, move and delete events of all repository instances it is attached to. In it's event handlers it must update the persistence accordingly.

Copyright (c) SAP AG 2001-2004

Field Summary

static java.lang.String

SERVICE_ID

Method Summary

void	deleteProperty(IPropertyName propertyName, IResource resource)
void	deleteProperty(IPropertyName propertyName, IResource resource, java.lang.String userID)
void	deleteProperty(IPropertyName propertyName, RID resourceID) Deprecated. as of NW04. Use method with resource context parameter
void	deleteProperty(IPropertyName propertyName, RID resourceID, IResourceContext context) Deletes the property with the specified name from the persistent storage.
void	deleteProperty(IPropertyName propertyName, RID resourceID, java.lang.String userID) Deprecated. as of NW04. Use method with resource context parameter
void	deleteProperty(IPropertyName propertyName, RID resourceID, java.lang.String userID, IResourceContext context) Deletes a personalized property.
IAppPropertyCollection	getProperties(IPropertyName propertyName, IResource resource)
IAppPropertyCollection	getProperties(IPropertyName propertyName, RID resourceID, IResourceContext context) Returns all personalized properties for a given property name and RID.
IAppPropertyMap	getProperties(IResource resource)
IAppPropertyMap	getProperties(IResource resource, java.lang.String userID)
IAppPropertyMap	getProperties(RID resourceID) Deprecated. as of NW04. Use method with resource context parameter
IAppPropertyMap	getProperties(RID resourceID, IResourceContext context) Returns all application properties for the specified RID (not the personalized properties)
IAppPropertyMap	getProperties(RID resourceID, java.lang.String userID) Deprecated. as of NW04. Use method with resource context parameter
IAppPropertyMap	getProperties(RID resourceID, java.lang.String userID, IResourceContext context) Returns all personalized properties of a resource.
IAppPropertyMap	getProperties(java.lang.String namespace, IResource resource)
IAppPropertyMap	getProperties(java.lang.String namespace, IResource resource, java.lang.String userID)
IAppPropertyMap	getProperties(java.lang.String namespace, RID resourceID) Deprecated. as of NW04. Use method with resource context parameter
IAppPropertyMap	getProperties(java.lang.String namespace, RID resourceID, IResourceContext context) Returns all application properties for the specified namespace and RID (but not the personalized properties).
IAppPropertyMap	getProperties(java.lang.String namespace, RID resourceID, java.lang.String userID) Deprecated. as of NW04. Use method with resource context parameter
IAppPropertyMap	getProperties(java.lang.String namespace, RID resourceID, java.lang.String userID, IResourceContext context) Returns all personalized properties of a resource for a namespace and the user ID.
IAppProperty	getProperty(IPropertyName propertyName, IResource resource)
IAppProperty	getProperty(IPropertyName propertyName, IResource resource, java.lang.String userID)
IResourceAppPropertyMap	getProperty(IPropertyName propertyName, IRidList ridList) Deprecated. as of NW04. Use method with resource context parameter
IResourceAppPropertyMap	getProperty(IPropertyName propertyName, IRidList ridList, IResourceContext context) Returns the properties with the specified name and for all RIDs in the list.
IResourceAppPropertyMap	getProperty(IPropertyName propertyName, IRidList ridList, java.lang.String userID) Deprecated. as of NW04. Use method with resource context parameter
IResourceAppPropertyMap	getProperty(IPropertyName propertyName, IRidList ridList, java.lang.String userID, IResourceContext context) Returns the specified personalized property for all resources IDs in the list and the specified user ID.
IAppProperty	getProperty(IPropertyName propertyName, RID resourceID) Deprecated. as of NW04. Use method with resource context parameter
IAppProperty	getProperty(IPropertyName propertyName, RID resourceID, IResourceContext context) Returns the property for the specified resource identifier and name.
IAppProperty	getProperty(IPropertyName propertyName, RID resourceID, java.lang.String userID) Deprecated. as of NW04. Use method with resource context parameter
IAppProperty	getProperty(IPropertyName propertyName, RID resourceID, java.lang.String userID, IResourceContext context) Returns the personalized property for the specified resource and user ID.
IRidList	search(IPropertyName name, java.lang.String userID, java.lang.Object value, Operator op, boolean multiValued) Deprecated. as of NW04. Use method with resource context parameter
IRidList	search(IPropertyName name, java.lang.String userID, java.lang.Object value, Operator op, boolean multiValued, IResourceContext context) Queries all properties and returns a list of RIDs that match the search criteria.
void	setProperty(IAppProperty property, IResource resource)
void	setProperty(IAppProperty property, RID resourceID) Deprecated. as of NW04. Use method with resource context parameter
void	setProperty(IAppProperty property, RID resourceID, IResourceContext context) Stores the property for the specified RID in some persistent storage.

Field Detail

SERVICE_ID

public static final java.lang.String SERVICE_ID

Method Detail

getProperty

public IAppProperty getProperty(IPropertyName propertyName,
                                RID resourceID,
                                java.lang.String userID,
                                IResourceContext context)
                         throws WcmException

Returns the personalized property for the specified resource and user ID. Will return null if the property does not exist.

Parameters:

propertyName - The property name.

resourceID - The resource identified.

userID - The ID of the user the property belongs to.

context - The resource context.

Returns:

A property object or null if the property does not exist

Throws:

WcmException -

getProperty

public IResourceAppPropertyMap getProperty(IPropertyName propertyName,
                                           IRidList ridList,
                                           java.lang.String userID,
                                           IResourceContext context)
                                    throws WcmException

Returns the specified personalized property for all resources IDs in the list and the specified user ID.

Parameters:

propertyName - The property name

ridList - A list of resource identifiers

userID - The ID of the user the property belongs to

context - The resource context.

Returns:

A map: key = RID, value = IAppProperty

Throws:

WcmException -

getProperties

public IAppPropertyMap getProperties(java.lang.String namespace,
                                     RID resourceID,
                                     java.lang.String userID,
                                     IResourceContext context)
                              throws WcmException

Returns all personalized properties of a resource for a namespace and the user ID.

Parameters:

namespace - The namespace

resourceID - The resource identifier.

userID - The ID of the user the property belongs to

context - The resource context.

Returns:

A map of properties: key = IAppPropertyName, value = IAppProperty

Throws:

WcmException -

getProperties

public IAppPropertyMap getProperties(RID resourceID,
                                     java.lang.String userID,
                                     IResourceContext context)
                              throws WcmException

Returns all personalized properties of a resource.

Parameters:

resourceID - The resource indentifier.

context - The resource context.

userID - TBD: Description of the incoming method parameter

Returns:

A map of properties: key = IAppPropertyName, value = IAppProperty

Throws:

WcmException -

deleteProperty

public void deleteProperty(IPropertyName propertyName,
                           RID resourceID,
                           java.lang.String userID,
                           IResourceContext context)
                    throws WcmException

Deletes a personalized property. If the user ID is null the property will be deleted for all users.

Parameters:

propertyName - The name of the property to delete.

resourceID - The resource identifier.

userID - The user ID. If the user ID is null the property will be deleted for all users.

context - The resource context.

Throws:

WcmException -

getProperty

public IAppProperty getProperty(IPropertyName propertyName,
                                RID resourceID,
                                IResourceContext context)
                         throws WcmException

Returns the property for the specified resource identifier and name. Will return null if the property does not exist.

Parameters:

propertyName - The property name.

resourceID - The resource identifier.

context - The resource context.

Returns:

the property for the specified resource identifier and namespace.

Throws:

WcmException -

getProperty

public IResourceAppPropertyMap getProperty(IPropertyName propertyName,
                                           IRidList ridList,
                                           IResourceContext context)
                                    throws WcmException

Returns the properties with the specified name and for all RIDs in the list.

Parameters:

propertyName - The property name.

ridList - A list of resource identifiers.

context - The resource context.

Returns:

A map: key = RID, value = IAppProperty

Throws:

WcmException -

getProperties

public IAppPropertyMap getProperties(java.lang.String namespace,
                                     RID resourceID,
                                     IResourceContext context)
                              throws WcmException

Returns all application properties for the specified namespace and RID (but not the personalized properties).

Parameters:

namespace - The namespace.

resourceID - The resource identifier.

context - The resource context.

Returns:

A map of properties: key = IAppPropertyName, value = IAppProperty

Throws:

WcmException -

getProperties

public IAppPropertyMap getProperties(RID resourceID,
                                     IResourceContext context)
                              throws WcmException

Returns all application properties for the specified RID (not the personalized properties)

Parameters:

resourceID - The resource identifier.

context - The resource context.

Returns:

A map of properties: key = IAppPropertyName, value = IAppProperty

Throws:

WcmException -

getProperties

public IAppPropertyCollection getProperties(IPropertyName propertyName,
                                            RID resourceID,
                                            IResourceContext context)
                                     throws WcmException

Returns all personalized properties for a given property name and RID.

Parameters:

propertyName - the name of the property

resourceID - the ressource identifier

context - The resource context.

Returns:

A collection of application properties

Throws:

WcmException -

deleteProperty

public void deleteProperty(IPropertyName propertyName,
                           RID resourceID,
                           IResourceContext context)
                    throws WcmException

Deletes the property with the specified name from the persistent storage.

Parameters:

propertyName - The name of the property to delete.

resourceID - The resource identifier

context - The resource context.

Throws:

WcmException - Exception raised in failure situation

setProperty

public void setProperty(IAppProperty property,
                        RID resourceID,
                        IResourceContext context)
                 throws WcmException

Stores the property for the specified RID in some persistent storage. If the property object contains a user ID the property is personalized.

Parameters:

property - The property to store

resourceID - The resource identifier.

context - The resource context.

Throws:

WcmException -

search

public IRidList search(IPropertyName name,
                       java.lang.String userID,
                       java.lang.Object value,
                       Operator op,
                       boolean multiValued,
                       IResourceContext context)
                throws WcmException

Queries all properties and returns a list of RIDs that match the search criteria. The property's namespace, name and userID (optional) are compared for equality . A query for the property's values is possible with different operators and for all property types. The operators LIKE and REGEXP can only be used for properties of type STRING and XML.

The search for type Boolean is restricted to the operator EQUAL. The search result is a list of resource identifiers. All properties for all repositories the service is registered at are searched, thus the result set can include RIDs from different repositories. The RIDs in the result list are unique.

Search for multi-valued properties is supported. At least one of the values must match the specified value.

Parameters:

name - The property name to search for.

userID - The userID to search for or null .

value - The value to search for. Must be a String, Date, Integer, Long or Boolean object.

op - The comparison operator to use.

multiValued - If multi-valued properties will be included in the search.

context - The resource context.

Returns:

A list of resource identifiers. The RIDs in the list are unique.

Throws:

WcmException - If an unsopprted operator was used If a syntax error occured in the regular expression

getProperty

public IAppProperty getProperty(IPropertyName propertyName,
                                IResource resource,
                                java.lang.String userID)
                         throws WcmException

getProperties

public IAppPropertyMap getProperties(java.lang.String namespace,
                                     IResource resource,
                                     java.lang.String userID)
                              throws WcmException

getProperties

public IAppPropertyMap getProperties(IResource resource,
                                     java.lang.String userID)
                              throws WcmException

deleteProperty

public void deleteProperty(IPropertyName propertyName,
                           IResource resource,
                           java.lang.String userID)
                    throws WcmException

getProperty

public IAppProperty getProperty(IPropertyName propertyName,
                                IResource resource)
                         throws WcmException

getProperties

public IAppPropertyMap getProperties(java.lang.String namespace,
                                     IResource resource)
                              throws WcmException

setProperty

public void setProperty(IAppProperty property,
                        IResource resource)
                 throws WcmException

getProperties

public IAppPropertyMap getProperties(IResource resource)
                              throws WcmException

getProperties

public IAppPropertyCollection getProperties(IPropertyName propertyName,
                                            IResource resource)
                                     throws WcmException

deleteProperty

public void deleteProperty(IPropertyName propertyName,
                           IResource resource)
                    throws WcmException

getProperty

public IAppProperty getProperty(IPropertyName propertyName,
                                RID resourceID,
                                java.lang.String userID)
                         throws WcmException

Deprecated. as of NW04. Use method with resource context parameter

Returns:

property

Throws:

WcmException - Exception raised in failure situation

getProperty

public IResourceAppPropertyMap getProperty(IPropertyName propertyName,
                                           IRidList ridList,
                                           java.lang.String userID)
                                    throws WcmException

Deprecated. as of NW04. Use method with resource context parameter

Returns:

property

Throws:

WcmException - Exception raised in failure situation

getProperties

public IAppPropertyMap getProperties(java.lang.String namespace,
                                     RID resourceID,
                                     java.lang.String userID)
                              throws WcmException

Deprecated. as of NW04. Use method with resource context parameter

Returns:

properties

Throws:

WcmException - Exception raised in failure situation

getProperties

public IAppPropertyMap getProperties(RID resourceID,
                                     java.lang.String userID)
                              throws WcmException

Deprecated. as of NW04. Use method with resource context parameter

Returns:

properties

Throws:

WcmException - Exception raised in failure situation

deleteProperty

public void deleteProperty(IPropertyName propertyName,
                           RID resourceID,
                           java.lang.String userID)
                    throws WcmException

Deprecated. as of NW04. Use method with resource context parameter

Throws:

WcmException - Exception raised in failure situation

getProperty

public IAppProperty getProperty(IPropertyName propertyName,
                                RID resourceID)
                         throws WcmException

Deprecated. as of NW04. Use method with resource context parameter

Returns:

property

Throws:

WcmException - Exception raised in failure situation

getProperty

public IResourceAppPropertyMap getProperty(IPropertyName propertyName,
                                           IRidList ridList)
                                    throws WcmException

Deprecated. as of NW04. Use method with resource context parameter

Returns:

property

Throws:

WcmException - Exception raised in failure situation

getProperties

public IAppPropertyMap getProperties(java.lang.String namespace,
                                     RID resourceID)
                              throws WcmException

Deprecated. as of NW04. Use method with resource context parameter

Returns:

properties

Throws:

WcmException - Exception raised in failure situation

setProperty

public void setProperty(IAppProperty property,
                        RID resourceID)
                 throws WcmException

Deprecated. as of NW04. Use method with resource context parameter

Parameters:

property - property to be set

resourceID - property to be set

Throws:

WcmException - Exception raised in failure situation

getProperties

public IAppPropertyMap getProperties(RID resourceID)
                              throws WcmException

Deprecated. as of NW04. Use method with resource context parameter

Returns:

properties

Throws:

WcmException - Exception raised in failure situation

deleteProperty

public void deleteProperty(IPropertyName propertyName,
                           RID resourceID)
                    throws WcmException

Deprecated. as of NW04. Use method with resource context parameter

Throws:

WcmException - Exception raised in failure situation

search

public IRidList search(IPropertyName name,
                       java.lang.String userID,
                       java.lang.Object value,
                       Operator op,
                       boolean multiValued)
                throws WcmException

Deprecated. as of NW04. Use method with resource context parameter

Throws:

WcmException - Exception raised in failure situation