public interface IApplicationProperties
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
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_ID |
Modifier and Type | Method and Description |
---|---|
void |
deleteProperty(IPropertyName propertyName,
IResource resource) |
void |
deleteProperty(IPropertyName propertyName,
IResource resource,
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,
String userID)
Deprecated.
as of NW04. Use method with resource context parameter
|
void |
deleteProperty(IPropertyName propertyName,
RID resourceID,
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,
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,
String userID)
Deprecated.
as of NW04. Use method with resource context parameter
|
IAppPropertyMap |
getProperties(RID resourceID,
String userID,
IResourceContext context)
Returns all personalized properties of a resource.
|
IAppPropertyMap |
getProperties(String namespace,
IResource resource) |
IAppPropertyMap |
getProperties(String namespace,
IResource resource,
String userID) |
IAppPropertyMap |
getProperties(String namespace,
RID resourceID)
Deprecated.
as of NW04. Use method with resource context parameter
|
IAppPropertyMap |
getProperties(String namespace,
RID resourceID,
IResourceContext context)
Returns all application properties for the specified namespace and RID (but
not the personalized properties).
|
IAppPropertyMap |
getProperties(String namespace,
RID resourceID,
String userID)
Deprecated.
as of NW04. Use method with resource context parameter
|
IAppPropertyMap |
getProperties(String namespace,
RID resourceID,
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,
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,
String userID)
Deprecated.
as of NW04. Use method with resource context parameter
|
IResourceAppPropertyMap |
getProperty(IPropertyName propertyName,
IRidList ridList,
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,
String userID)
Deprecated.
as of NW04. Use method with resource context parameter
|
IAppProperty |
getProperty(IPropertyName propertyName,
RID resourceID,
String userID,
IResourceContext context)
Returns the personalized property for the specified resource and user ID.
|
IRidList |
search(IPropertyName name,
String userID,
Object value,
Operator op,
boolean multiValued)
Deprecated.
as of NW04. Use method with resource context parameter
|
IRidList |
search(IPropertyName name,
String userID,
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.
|
static final String SERVICE_ID
IAppProperty getProperty(IPropertyName propertyName, RID resourceID, String userID, IResourceContext context) throws WcmException
propertyName
- The property name.resourceID
- The resource identified.userID
- The ID of the user the property belongs to.context
- The resource context.WcmException
- No DescriptionIResourceAppPropertyMap getProperty(IPropertyName propertyName, IRidList ridList, String userID, IResourceContext context) throws WcmException
propertyName
- The property nameridList
- A list of resource identifiersuserID
- The ID of the user the property belongs tocontext
- The resource context.WcmException
- No DescriptionIAppPropertyMap getProperties(String namespace, RID resourceID, String userID, IResourceContext context) throws WcmException
namespace
- The namespaceresourceID
- The resource identifier.userID
- The ID of the user the property belongs tocontext
- The resource context.WcmException
- No DescriptionIAppPropertyMap getProperties(RID resourceID, String userID, IResourceContext context) throws WcmException
resourceID
- The resource indentifier.context
- The resource context.userID
- TBD: Description of the incoming method parameterWcmException
- No Descriptionvoid deleteProperty(IPropertyName propertyName, RID resourceID, String userID, IResourceContext context) throws WcmException
null
the
property will be deleted for all users.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.WcmException
- userIDIAppProperty getProperty(IPropertyName propertyName, RID resourceID, IResourceContext context) throws WcmException
propertyName
- The property name.resourceID
- The resource identifier.context
- The resource context.WcmException
- No DescriptionIResourceAppPropertyMap getProperty(IPropertyName propertyName, IRidList ridList, IResourceContext context) throws WcmException
propertyName
- The property name.ridList
- A list of resource identifiers.context
- The resource context.WcmException
- Exception raised in failure situationIAppPropertyMap getProperties(String namespace, RID resourceID, IResourceContext context) throws WcmException
namespace
- The namespace.resourceID
- The resource identifier.context
- The resource context.WcmException
- No DescriptionIAppPropertyMap getProperties(RID resourceID, IResourceContext context) throws WcmException
resourceID
- The resource identifier.context
- The resource context.WcmException
- Exception raised in failure situationIAppPropertyCollection getProperties(IPropertyName propertyName, RID resourceID, IResourceContext context) throws WcmException
propertyName
- the name of the propertyresourceID
- the ressource identifiercontext
- The resource context.WcmException
- Exception raised in failure situationvoid deleteProperty(IPropertyName propertyName, RID resourceID, IResourceContext context) throws WcmException
propertyName
- The name of the property to delete.resourceID
- The resource identifiercontext
- The resource context.WcmException
- Exception raised in failure situationvoid setProperty(IAppProperty property, RID resourceID, IResourceContext context) throws WcmException
property
- The property to storeresourceID
- The resource identifier.context
- The resource context.WcmException
- Exception raised in failure situationIRidList search(IPropertyName name, String userID, Object value, Operator op, boolean multiValued, IResourceContext context) throws WcmException
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.
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.WcmException
- If an unsopprted operator was used If a syntax
error occured in the regular expressionIAppProperty getProperty(IPropertyName propertyName, IResource resource, String userID) throws WcmException
WcmException
IAppPropertyMap getProperties(String namespace, IResource resource, String userID) throws WcmException
WcmException
IAppPropertyMap getProperties(IResource resource, String userID) throws WcmException
WcmException
void deleteProperty(IPropertyName propertyName, IResource resource, String userID) throws WcmException
WcmException
IAppProperty getProperty(IPropertyName propertyName, IResource resource) throws WcmException
WcmException
IAppPropertyMap getProperties(String namespace, IResource resource) throws WcmException
WcmException
void setProperty(IAppProperty property, IResource resource) throws WcmException
WcmException
IAppPropertyMap getProperties(IResource resource) throws WcmException
WcmException
IAppPropertyCollection getProperties(IPropertyName propertyName, IResource resource) throws WcmException
WcmException
void deleteProperty(IPropertyName propertyName, IResource resource) throws WcmException
WcmException
IAppProperty getProperty(IPropertyName propertyName, RID resourceID, String userID) throws WcmException
propertyName
- No DescriptionresourceID
- No DescriptionuserID
- No DescriptionWcmException
- Exception raised in failure situationIResourceAppPropertyMap getProperty(IPropertyName propertyName, IRidList ridList, String userID) throws WcmException
propertyName
- No DescriptionridList
- No DescriptionuserID
- No DescriptionWcmException
- Exception raised in failure situationIAppPropertyMap getProperties(String namespace, RID resourceID, String userID) throws WcmException
namespace
- No DescriptionresourceID
- No DescriptionuserID
- No DescriptionWcmException
- Exception raised in failure situationIAppPropertyMap getProperties(RID resourceID, String userID) throws WcmException
resourceID
- No DescriptionuserID
- No DescriptionWcmException
- Exception raised in failure situationvoid deleteProperty(IPropertyName propertyName, RID resourceID, String userID) throws WcmException
propertyName
- No DescriptionresourceID
- No DescriptionuserID
- No DescriptionWcmException
- Exception raised in failure situationIAppProperty getProperty(IPropertyName propertyName, RID resourceID) throws WcmException
propertyName
- No DescriptionresourceID
- No DescriptionWcmException
- Exception raised in failure situationIResourceAppPropertyMap getProperty(IPropertyName propertyName, IRidList ridList) throws WcmException
propertyName
- No DescriptionridList
- No DescriptionWcmException
- Exception raised in failure situationIAppPropertyMap getProperties(String namespace, RID resourceID) throws WcmException
namespace
- No DescriptionresourceID
- No DescriptionWcmException
- Exception raised in failure situationvoid setProperty(IAppProperty property, RID resourceID) throws WcmException
property
- property to be setresourceID
- property to be setWcmException
- Exception raised in failure situationIAppPropertyMap getProperties(RID resourceID) throws WcmException
resourceID
- property to be setWcmException
- Exception raised in failure situationvoid deleteProperty(IPropertyName propertyName, RID resourceID) throws WcmException
propertyName
- No DescriptionresourceID
- No DescriptionWcmException
- Exception raised in failure situationIRidList search(IPropertyName name, String userID, Object value, Operator op, boolean multiValued) throws WcmException
name
- No DescriptionuserID
- No Descriptionvalue
- No Descriptionop
- No DescriptionmultiValued
- No DescriptionWcmException
- Exception raised in failure situationAccess Rights |
---|
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
|
Copyright 2018 SAP AG Complete Copyright Notice