|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.6.0) E15995-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPropertyService
A namespace scoped property service to manage propertydefinitions, propertysetdefinitions and propertysets. The namespaceName (getNamespaceName()
) can't be changed once this is created.
Method Summary | ||
---|---|---|
|
createProperty(IContext context, IPropertySetDefinitionName setDefinitionName, IPropertySetName setName, IProperty<T> property) Creates a new property in the propertyset identified by the given setDefinitionName and the setName . |
|
IPropertyDefinition |
createPropertyDefinition(IContext context, IPropertyDefinition propertyDefinition) Creates the given propertyDefinition . |
|
IPropertySet |
createPropertySet(IContext context, IPropertySet propertySet) Creates the given propertySet . |
|
IPropertySetDefinition |
createPropertySetDefinition(IContext context, IPropertySetDefinition propertySetDefinition) Creates the given propertySetDefinition . |
|
IPagedList<IPropertySet> |
filter(IContext context, IPropertySetDefinitionName setDefinitionName, PropertySetFilterContext filterContext) Filters the propertysets within the scope of the given setDefinitionName and the namespace getNamespaceName() and based on the given filterContext . |
|
IPagedList<IPropertyDefinition> |
filter(IContext context, PropertyDefinitionFilterContext filterContext) Filters the propertydefinitions within the scope of the namespace getNamespaceName() and based on the given filterContext . |
|
IPagedList<IPropertySetDefinition> |
filter(IContext context, PropertySetDefinitionFilterContext filterContext) Filters the propertysetdefinitions within the scope of the namespace getNamespaceName() and based on the given filterContext . |
|
INamespaceName |
getNamespaceName() Returns the namespace name to which this is scoped. |
|
|
getProperty(IContext context, IPropertySetDefinitionName propertySetDefinitionName, IPropertySetName propertySetName, java.lang.String propertyName) Retrieves the property identified by the given propertyName from the propertyset identified by the given propertySetDefinitionName and the propertySetName . |
|
IPropertyDefinition |
getPropertyDefinition(IContext context, IPropertyDefinitionName propertyDefinitionName) Retrieves the propertydefinition identified by the given propertyDefinitionName . |
|
IPagedList<IPropertyDefinition> |
getPropertyDefinitions(IContext context, PaginationContext paginationContext) Retrieves a paged list of propertydefinitions in this namespace getNamespaceName() . |
|
IPropertySet |
getPropertySet(IContext context, IPropertySetDefinitionName propertySetDefinitionName, IPropertySetName propertySetName) Retrieves the propertyset identified by the given propertyDefinitionName and the propertySetName . |
|
IPropertySetDefinition |
getPropertySetDefinition(IContext context, IPropertySetDefinitionName propertySetDefinitionName) Retrieves the propertysetdefinition identified by the given propertySetDefinitionName . |
|
IPagedList<IPropertySetDefinition> |
getPropertySetDefinitions(IContext context, PaginationContext paginationContext) Retrieves a paged list of propertysetdefinitions in this namespace getNamespaceName() . |
|
IPagedList<IPropertySet> |
getPropertySets(IContext context, IPropertySetDefinitionName propertySetDefinitionName, PaginationContext paginationContext) Retrieves a paged list of propertysets for the given propertysetdefinition name propertyDefinitionName . |
|
void |
removeAllProperties(IContext context, IPropertySetDefinitionName setDefinitionName, IPropertySetName setName) Clears the propertyset identified by the given setDefinitionName and setName by removing all the properties from it. |
|
void |
removeAllPropertyDefinitions(IContext context) Removes all the propertydefinitions found in the namespace returned by the method getNamespaceName() . |
|
void |
removeAllPropertySetDefinitions(IContext context) Removes all the propertysetdefinitions found in the namespace returned by the method getNamespaceName() . |
|
void |
removeAllPropertySets(IContext context, IPropertySetDefinitionName setDefinitionName) Removes all the propertysets within the scope of the namespace returned by the method getNamespaceName() and the given setDefinitionName . |
|
|
removeProperty(IContext context, IPropertySetDefinitionName setDefinitionName, IPropertySetName setName, IProperty<T> property) Removes the given property from the propertyset identified by the given setDefinitionName and the setName . |
|
|
removeProperty(IContext context, IPropertySetDefinitionName setDefinitionName, IPropertySetName setName, IPropertyName propertyName) Removes the property identified by the given name propertyName from the propertyset identified by the given setDefinitionName and the setName . |
|
IPropertyDefinition |
removePropertyDefinition(IContext context, IPropertyDefinition propertyDefinition) Removes the given propertydefinition propertyDefinition . |
|
IPropertyDefinition |
removePropertyDefinition(IContext context, IPropertyDefinitionName propertyDefinitionName) Removes the named propertydefinition. |
|
IPropertySet |
removePropertySet(IContext context, IPropertySet propertySet) Removes the given propertyset propertySet . |
|
IPropertySet |
removePropertySet(IContext context, IPropertySetDefinitionName propertySetDefinitionName, IPropertySetName propertySetName) Removes the propertyset identified the given propertyDefinitionName and the propertySetName . |
|
IPropertySetDefinition |
removePropertySetDefinition(IContext context, IPropertySetDefinition propertySetDefinition) Removes the given propertysetdefinition propertySetDefinition . |
|
IPropertySetDefinition |
removePropertySetDefinition(IContext context, IPropertySetDefinitionName propertySetDefinitionName) Removes the named propertysetdefinition. |
|
|
updateProperty(IContext context, IPropertySetDefinitionName setDefinitionName, IPropertySetName setName, IProperty<T> property) Updates the given property in the propertyset identified by the given setDefinitionName and the setName . |
|
IPropertyDefinition |
updatePropertyDefinition(IContext context, IPropertyDefinition propertyDefinition) Updates an existing propertydefinition by replacing it with the given propertyDefinition . |
|
IPropertySet |
updatePropertySet(IContext context, IPropertySet propertySet) Updates an existing propertyset by replacing it with the given propertySet . |
|
IPropertySetDefinition |
updatePropertySetDefinition(IContext context, IPropertySetDefinition propertySetDefinition) Updates an existing propertysetdefinition by replacing it with the given propertySetDefinition . |
Method Detail |
---|
INamespaceName getNamespaceName()
IPagedList<IPropertySet> getPropertySets(IContext context, IPropertySetDefinitionName propertySetDefinitionName, PaginationContext paginationContext) throws OperationFailedException
propertyDefinitionName
. The paged list's size and the starting index is determined by the given paginationContext
. The paged list will be empty if the current user is not authorized to read the propertysets. This indirectly calls IPropertyLocator.filter(IContext, INamespaceName, IPropertySetDefinitionName, oracle.wcps.property.filter.PropertySetFilterContext)
.context
- a property service context. If this API is accessed remotely this context must have remote properties.propertySetDefinitionName
- a propertysetdefinition's name.paginationContext
- contains a page size and a starting index.OperationFailedException
- if the backing IPropertyLocator
is unable to retrieve the propertysets.IPropertySet getPropertySet(IContext context, IPropertySetDefinitionName propertySetDefinitionName, IPropertySetName propertySetName) throws UnauthorizedException
propertyDefinitionName
and the propertySetName
. This indirectly calls IPropertyLocator.loadProperties(IContext, IPropertySet, IPropertySetDefinition, java.util.List)
.context
- a property service context. If this API is accessed remotely this context must have remote properties.propertySetDefinitionName
- a propertysetdefinition's name.propertySetName
- a propertyset's name.UnauthorizedException
- if the currently user is not authorized to read IPropertyPermission.isAllowed(IContext, oracle.wcps.property.security.Capability, oracle.wcps.property.security.IResourceId)
this propertyset.OperationFailedException
- if the backing IPropertyLocator
is unable to retrieve the propertyset.IPropertySet createPropertySet(IContext context, IPropertySet propertySet) throws AlreadyExistsException, ValidationFailedException, NotFoundException, UnauthorizedException
propertySet
. If the given propertyset's name is not set the system will generate an UUID UUID
and use it as its name. The returned propertyset will have values for createdOn and updatedOn set by the system. This indirectly calls IPropertyLocator.storeProperties(IContext, IPropertySet, IPropertySetDefinition, java.util.List)
context
- a property service context. If this API is accessed remotely this context must have remote properties.propertySet
- a new propertyset.AlreadyExistsException
- if the system already contains the given propertyset.ValidationFailedException
- if the property values fail validation according to their propertydefinitions.NotFoundException
- if the propertysetdefinition identified by the name in the given propertySet IPropertySet.getPropertySetDefinitionName()
is not found in the system.UnauthorizedException
- if the currently user is not authorized to create IPropertyPermission.isAllowed(IContext, oracle.wcps.property.security.Capability, oracle.wcps.property.security.IResourceId)
this propertyset.OperationFailedException
- if the backing IPropertyLocator
is unable to create the propertyset.IPropertySetDefinition
, IPropertyDefinition
IPropertySet updatePropertySet(IContext context, IPropertySet propertySet) throws NotFoundException, ValidationFailedException, ObjectOutOfSyncException, UnauthorizedException
propertySet
. If the optimistic concurrency feature is enabled IContext.isOptimisticConcurrencyEnabled()
, this method updates the given propertyset optimistically. The given propertySet is updated only if its updatedOn time matches with the existing propertyset's updatedOn time. This indirectly calls IPropertyLocator.storeProperties(IContext, IPropertySet, IPropertySetDefinition, java.util.List)
context
- a property service context. If this API is accessed remotely this context must have remote properties.propertySet
- a propertyset that was retrieved from the system.NotFoundException
- if the given propertyset was not created before or if the propertysetdefinition referred by the given propertyset is not found in the system.ValidationFailedException
- if a property's value fails validation according to the associated propertydefinition. The propertydefinition is associated to a property name in a property mapping IPropertyMapping
found in the propertysetdefinition IPropertySetDefinition
which is associated to the given propertySet
.ObjectOutOfSyncException
- if the optimistic concurrency feature is enabled and updatedOn time of the given propertySet
doesn't match with the current version in the system.UnauthorizedException
- if the current user is not authorized to update IPropertyPermission.isAllowed(IContext, oracle.wcps.property.security.Capability, oracle.wcps.property.security.IResourceId)
this propertyset.OperationFailedException
- if the backing IPropertyLocator
is unable to update the given propertyset.IPropertySet removePropertySet(IContext context, IPropertySet propertySet) throws ObjectOutOfSyncException, UnauthorizedException
propertySet
. If the optimistic concurrency feature is enabled, this method removes the given propertySet
optimistically, it is removed only if its updatedOn time matches the updatedOn time of the existing propertyset in the system. This indirectly calls IPropertyLocator.removeProperties(IContext, IPropertySet, java.util.List)
context
- a property service context. If this API is accessed remotely this context must have remote properties.propertySet
- a propertyset that was retrieved from the system.ObjectOutOfSyncException
- if the optimistic concurrency feature is enabled and updatedOn time of the given propertySet
doesn't match with the current version in the system.UnauthorizedException
- if the current user is not authorized to remove IPropertyPermission.isAllowed(IContext, oracle.wcps.property.security.Capability, oracle.wcps.property.security.IResourceId)
this propertyset.OperationFailedException
- if the backing IPropertyLocator
is unable to remove the given propertyset.IPropertySet removePropertySet(IContext context, IPropertySetDefinitionName propertySetDefinitionName, IPropertySetName propertySetName) throws UnauthorizedException
propertyDefinitionName
and the propertySetName
. This indirectly calls IPropertyLocator.removeProperties(IContext, IPropertySet, java.util.List)
.context
- a property service context. If this API is accessed remotely this context must have remote properties.propertySetDefinitionName
- a propertysetdefinition's name.propertySetName
- a propertyset's name.UnauthorizedException
- if the current user is not authorized to remove IPropertyPermission.isAllowed(IContext, oracle.wcps.property.security.Capability, oracle.wcps.property.security.IResourceId)
this propertyset.OperationFailedException
- if the backing IPropertyLocator
is unable to remove the propertyset.void removeAllPropertySets(IContext context, IPropertySetDefinitionName setDefinitionName) throws UnauthorizedException
getNamespaceName()
and the given setDefinitionName
. This indirectly calls IPropertyLocator.removeProperties(IContext, INamespaceName, IPropertySetDefinitionName)
.context
- a property service context. If this API is accessed remotely this context must have remote properties.setDefinitionName
- a propertysetdefinition's name.UnauthorizedException
- if the current user is not authorized to remove IPropertyPermission.isAllowed(IContext, oracle.wcps.property.security.Capability, oracle.wcps.property.security.IResourceId)
all propertysets.OperationFailedException
- if the backing IPropertyLocator
is unable to remove all the propertysets.IPagedList<IPropertySet> filter(IContext context, IPropertySetDefinitionName setDefinitionName, PropertySetFilterContext filterContext)
setDefinitionName
and the namespace getNamespaceName()
and based on the given filterContext
. This indirectly calls IPropertyLocator.filter(IContext, INamespaceName, IPropertySetDefinitionName, oracle.wcps.property.filter.PropertySetFilterContext)
context
- a property service context. If this API is accessed remotely this context must have remote properties.setDefinitionName
- a propertysetdefinition's name.filterContext
- a filter context that contains search expression and pagination context.OperationFailedException
- if the backing IPropertyLocator
is unable to filter the propertysets.<T extends java.io.Serializable> IProperty<T> getProperty(IContext context, IPropertySetDefinitionName propertySetDefinitionName, IPropertySetName propertySetName, java.lang.String propertyName) throws UnauthorizedException
propertyName
from the propertyset identified by the given propertySetDefinitionName
and the propertySetName
.T
- property value's type.context
- a property service context. If this API is accessed remotely this context must have remote properties.propertySetDefinitionName
- a propertysetdefinition's name.propertySetName
- a propertyset's name.propertyName
- a property's name.UnauthorizedException
- if the current user is not authorized to read IPropertyPermission.isAllowed(IContext, oracle.wcps.property.security.Capability, oracle.wcps.property.security.IResourceId)
this property.OperationFailedException
- if the backing IPropertyLocator
is unable to retrieve the named propertyset.<T extends java.io.Serializable> IProperty<T> createProperty(IContext context, IPropertySetDefinitionName setDefinitionName, IPropertySetName setName, IProperty<T> property) throws AlreadyExistsException, NotFoundException, UnauthorizedException, ValidationFailedException
setDefinitionName
and the setName
.T
- property value's type.context
- a property service context. If this API is accessed remotely this context must have remote properties.setDefinitionName
- a propertysetdefinition's name.setName
- a propertyset's name.property
- a new property to create.AlreadyExistsException
- if the propertyset already contains this property.NotFoundException
- if the propertyset or the propertysetdefinition are not found.UnauthorizedException
- if the current user is not authorized to create IPropertyPermission.isAllowed(IContext, oracle.wcps.property.security.Capability, oracle.wcps.property.security.IResourceId)
this property.ValidationFailedException
- if the property
's name is null or its value fails to validate according to the propertydefinition that is mapped to this property
in the propertysetdefinition identified by the given setDefinitionName
.OperationFailedException
- if the backing IPropertyLocator
is unable to update the named propertyset.<T extends java.io.Serializable> IProperty<T> updateProperty(IContext context, IPropertySetDefinitionName setDefinitionName, IPropertySetName setName, IProperty<T> property) throws ObjectOutOfSyncException, NotFoundException, UnauthorizedException, ValidationFailedException
setDefinitionName
and the setName
.T
- property value's type.context
- a property service context. If this API is accessed remotely this context must have remote properties.setDefinitionName
- a propertysetdefinition's name.setName
- a propertyset's name.property
- a property to update.ObjectOutOfSyncException
- if the optimistic concurrency feature is enabled and updatedOn time of the given property
doesn't match with the current version in the system.NotFoundException
- if the propertyset or the propertysetdefinition not found.UnauthorizedException
- if the current user is not authorized to update IPropertyPermission.isAllowed(IContext, oracle.wcps.property.security.Capability, oracle.wcps.property.security.IResourceId)
this property.ValidationFailedException
- if the property
's name is null or its value fails to validate according to the propertydefinition that is mapped to this property
in the propertysetdefinition identified by the given setDefinitionName
.OperationFailedException
- if the backing IPropertyLocator
is unable to update the named propertyset.<T extends java.io.Serializable> IProperty<T> removeProperty(IContext context, IPropertySetDefinitionName setDefinitionName, IPropertySetName setName, IProperty<T> property) throws ObjectOutOfSyncException, UnauthorizedException
property
from the propertyset identified by the given setDefinitionName
and the setName
. If the optimistic concurrency feature is enabled, this method removes the given property
optimistically, it is removed only if its updatedOn time matches the updatedOn time of the property in the system.T
- property value's type.context
- a property service context. If this API is accessed remotely this context must have remote properties.setDefinitionName
- a propertysetdefinition's name.setName
- a propertyset's name.property
- a property to update.ObjectOutOfSyncException
- if the optimistic concurrency feature is enabled and updatedOn time of the given property
doesn't match with the current version in the system.UnauthorizedException
- if the current user is not authorized to remove IPropertyPermission.isAllowed(IContext, oracle.wcps.property.security.Capability, oracle.wcps.property.security.IResourceId)
this property.OperationFailedException
- if the backing IPropertyLocator
is unable to update the named propertyset.<T extends java.io.Serializable> IProperty<T> removeProperty(IContext context, IPropertySetDefinitionName setDefinitionName, IPropertySetName setName, IPropertyName propertyName) throws UnauthorizedException
propertyName
from the propertyset identified by the given setDefinitionName
and the setName
.T
- the property value's type.context
- a property service context. If this API is accessed remotely this context must have remote properties.setDefinitionName
- a propertysetdefinition's name.setName
- a propertyset's name.propertyName
- a property's name.UnauthorizedException
- if the current user is not authorized to remove IPropertyPermission.isAllowed(IContext, oracle.wcps.property.security.Capability, oracle.wcps.property.security.IResourceId)
this property.OperationFailedException
- if the backing IPropertyLocator
is unable to update the named propertyset.void removeAllProperties(IContext context, IPropertySetDefinitionName setDefinitionName, IPropertySetName setName) throws UnauthorizedException
setDefinitionName
and setName
by removing all the properties from it.context
- a property service context. If this API is accessed remotely this context must have remote properties.setDefinitionName
- a propertysetdefinition's name.setName
- a propertyset's name.UnauthorizedException
- if the current user is not authorized to remove IPropertyPermission.isAllowed(IContext, oracle.wcps.property.security.Capability, oracle.wcps.property.security.IResourceId)
all properties.OperationFailedException
- if the backing IPropertyLocator
is unable to update the named propertyset.IPagedList<IPropertySetDefinition> getPropertySetDefinitions(IContext context, PaginationContext paginationContext)
getNamespaceName()
. The paged list size and starting index is determined by the given paginationContext
. The paged list will be empty if the current authenticated user is not authorized to read the propertysetdefinitions. This indirectly calls IDefinitionLocator.filter(IContext, INamespaceName, oracle.wcps.property.filter.PropertySetDefinitionFilterContext)
context
- a property service context. If this API is accessed remotely this context must have remote properties.paginationContext
- containing page size and starting indexOperationFailedException
- if the backing IDefinitionLocator
is unable to retrieve the propertysetdefinitions.IPropertySetDefinition getPropertySetDefinition(IContext context, IPropertySetDefinitionName propertySetDefinitionName)
propertySetDefinitionName
. This indirectly calls IDefinitionLocator.loadPropertySetDefinition(IContext, INamespaceName, IPropertySetDefinitionName)
.context
- a property service context. If this API is accessed remotely this context must have remote properties.propertySetDefinitionName
- a propertysetdefinition's name.OperationFailedException
- if the backing IDefinitionLocator
is unable to retrieve the propertysetdefinition.IPropertySetDefinition createPropertySetDefinition(IContext context, IPropertySetDefinition propertySetDefinition) throws AlreadyExistsException
propertySetDefinition
. If the given propertysetdefinition's name is not set system will generate an UUID UUID
and use it as its name. This indirectly calls IDefinitionLocator.storePropertySetDefinition(IContext, IPropertySetDefinition)
.context
- a property service context. If this API is accessed remotely this context must have remote properties.propertySetDefinition
- a new propertysetdefinition.AlreadyExistsException
- if the system already contains the given propertysetdefinition.OperationFailedException
- if the backing IDefinitionLocator
is unable to create the propertysetdefinition.IPropertySetDefinition updatePropertySetDefinition(IContext context, IPropertySetDefinition propertySetDefinition) throws NotFoundException, ObjectInUseException, ObjectOutOfSyncException, OperationFailedException
propertySetDefinition
. If the optimistic concurrency feature is enabled IContext.isOptimisticConcurrencyEnabled()
, this method updates the given propertysetdefinition optimistically. The given propertySetDefinition is updated only if its updatedOn time matches with the existing propertysetdefinition's updatedOn time. This indirectly calls IDefinitionLocator.storePropertySetDefinition(IContext, IPropertySetDefinition)
. Note: This update is very restricted and only allows updates if a new property mapping is added.context
- a property service context. If this API is accessed remotely this context must have remote properties.propertySetDefinition
- a propertysetdefinition that was retrieved from the system.NotFoundException
- if the propertysetdefinition was not created before.ObjectInUseException
- if there are propertysets that refer this. Remove all the propertysets first by calling removeAllPropertySets(IContext, IPropertySetDefinitionName)
and then call this to avoid getting this exception.OperationFailedException
- if the backing IDefinitionLocator
is unable to update the propertysetdefinition.ObjectOutOfSyncException
- if the optimistic concurrency feature is enabled and updatedOn time of the given propertySetDefinition
doesn't match with the current version in the system.IPropertySetDefinition removePropertySetDefinition(IContext context, IPropertySetDefinition propertySetDefinition) throws ObjectInUseException, ObjectOutOfSyncException
propertySetDefinition
. If the optimistic concurrency feature is enabled, this method removes the given propertySetDefinition
optimistically, it is removed only if its updatedOn time matches the updatedOn time of the existing propertysetdefinition in the system. This indirectly calls IDefinitionLocator.remove(IContext, INamespaceName, oracle.wcps.property.model.PropertySetDefinitionName)
context
- a property service context. If this API is accessed remotely this context must have remote properties.propertySetDefinition
- a propertysetdefinition that was retrieved from the system.ObjectInUseException
- if there are propertysets that refer this. Remove all the propertysets first by calling removeAllPropertySets(IContext, IPropertySetDefinitionName)
and then call this method to avoid getting this exception.ObjectOutOfSyncException
- if the optimistic concurrency feature is enabled and updatedOn time of the given propertySetDefinition
doesn't match with the current version in the system.OperationFailedException
- if the backing IDefinitionLocator
is unable to remove the given propertysetdefinition.IPropertySetDefinition removePropertySetDefinition(IContext context, IPropertySetDefinitionName propertySetDefinitionName) throws ObjectInUseException
IDefinitionLocator.remove(IContext, INamespaceName, oracle.wcps.property.model.PropertySetDefinitionName)
context
- a property service context. If this API is accessed remotely this context must have remote properties.propertySetDefinitionName
- the name of a propertysetdefinition.ObjectInUseException
- if there are propertysets that refer this. Remove all the propertysets first by calling removeAllPropertySets(IContext, IPropertySetDefinitionName)
and then call this to avoid getting this exception.OperationFailedException
- if the backing IDefinitionLocator
is unable to remove the named propertysetdefinition.void removeAllPropertySetDefinitions(IContext context) throws ObjectInUseException
getNamespaceName()
. This indirectly calls IDefinitionLocator.removeAllPropertySetDefinitions(IContext, INamespaceName)
context
- a property service context. If this API is accessed remotely this context must have remote properties.ObjectInUseException
- if there is a propertyset referring one of the propertysetdefinitions. Remove all the propertysets for each propertysetdefinition by calling removeAllPropertySets(IContext, IPropertySetDefinitionName)
and then call this to avoid getting this exception.OperationFailedException
- if the backing IDefinitionLocator
is unable to remove the propertysetdefinitions.IPagedList<IPropertySetDefinition> filter(IContext context, PropertySetDefinitionFilterContext filterContext)
getNamespaceName()
and based on the given filterContext
. This indirectly calls IDefinitionLocator.filter(IContext, INamespaceName, oracle.wcps.property.filter.PropertySetDefinitionFilterContext)
.context
- a property service context. If this API is accessed remotely this context must have remote properties.filterContext
- a filter context that contains search expression and pagination context.OperationFailedException
- if the backing IDefinitionLocator
is unable to filter the propertysetdefinitions.IPagedList<IPropertyDefinition> getPropertyDefinitions(IContext context, PaginationContext paginationContext)
getNamespaceName()
. The paged list size and starting index is determined by the given paginationContext
. The paged list will be empty if the current authenticated user is not authorized to read the propertydefinitions. This indirectly calls IDefinitionLocator.filter(IContext, INamespaceName, oracle.wcps.property.filter.PropertyDefinitionFilterContext)
context
- a property service context. If this API is accessed remotely this context must have remote properties.paginationContext
- containing page size and starting indexOperationFailedException
- if the backing IDefinitionLocator
is unable to retrieve the propertydefinitions.IPropertyDefinition getPropertyDefinition(IContext context, IPropertyDefinitionName propertyDefinitionName)
propertyDefinitionName
. This indirectly calls IDefinitionLocator.loadPropertyDefinition(IContext, INamespaceName, IPropertyDefinitionName)
.context
- a property service context. If this API is accessed remotely this context must have remote properties.propertyDefinitionName
- a propertydefinition's name.OperationFailedException
- if the backing IDefinitionLocator
is unable to retrieve the propertydefinition.IPropertyDefinition createPropertyDefinition(IContext context, IPropertyDefinition propertyDefinition) throws AlreadyExistsException
propertyDefinition
. If the given propertydefinition's name is not set system will generate an UUID UUID
and use it as its name. This indirectly calls IDefinitionLocator.storePropertyDefinition(IContext, IPropertyDefinition)
.context
- a property service context. If this API is accessed remotely this context must have remote properties.propertyDefinition
- a new propertydefinition.AlreadyExistsException
- if the system already contains the given propertydefinition.OperationFailedException
- if the backing IDefinitionLocator
is unable to create the propertydefinition.IPropertyDefinition updatePropertyDefinition(IContext context, IPropertyDefinition propertyDefinition) throws NotFoundException, ObjectInUseException, ObjectOutOfSyncException, OperationFailedException
propertyDefinition
. If the optimistic concurrency feature is enabled IContext.isOptimisticConcurrencyEnabled()
, this method updates the given propertydefinition optimistically. The given propertyDefinition is updated only if the updatedOn time matches with the existing propertydefinition's updatedOn time. This indirectly calls IDefinitionLocator.storePropertyDefinition(IContext, IPropertyDefinition)
.context
- a property service context. If this API is accessed remotely this context must have remote properties.propertyDefinition
- a propertydefinition that was retrieved from the system.NotFoundException
- if the propertydefinition was not created before.ObjectInUseException
- if there are propertysetdefinitions that refer this, please remove all the propertysetdefinitions first by calling removeAllPropertySetDefinitions(IContext)
and then call this to avoid getting this exception.OperationFailedException
- if the backing IDefinitionLocator
is unable to update the propertysetdefinition.ObjectOutOfSyncException
- if the optimistic concurrency feature is enabled and updatedOn time of the given propertySetDefinition
doesn't match with the current version in the system.IPropertyDefinition removePropertyDefinition(IContext context, IPropertyDefinition propertyDefinition) throws ObjectInUseException, ObjectOutOfSyncException
propertyDefinition
. If the optimistic concurrency feature is enabled, this method removes propertyDefinition
optimistically, it is removed only if its updatedOn time matches the updatedOn time of the existing propertydefinition in the system. This indirectly calls IDefinitionLocator.remove(IContext, INamespaceName, oracle.wcps.property.model.PropertyDefinitionName)
context
- a property service context. If this API is accessed remotely this context must have remote properties.propertyDefinition
- a propertydefinition that was retrieved from the system.ObjectInUseException
- if there are propertysetdefinitions that refer this. Remove all the propertysetdefinitions first by calling removeAllPropertySetDefinitions(IContext)
and then call this to avoid getting this exception.ObjectOutOfSyncException
- if the optimistic concurrency feature is enabled and updatedOn time of the given propertyDefinition
doesn't match with the current version in the system.OperationFailedException
- if the backing IDefinitionLocator
is unable to remove the given propertydefinition.IPropertyDefinition removePropertyDefinition(IContext context, IPropertyDefinitionName propertyDefinitionName) throws ObjectInUseException
IDefinitionLocator.remove(IContext, INamespaceName, oracle.wcps.property.model.PropertyDefinitionName)
context
- a property service context. If this API is accessed remotely this context must have remote properties.propertyDefinitionName
- the name of a propertydefinition.ObjectInUseException
- if there are propertysetdefinitions that refer this. Remove all the propertysetdefinitions first by calling removeAllPropertySetDefinitions(IContext)
and then call this to avoid getting this exception.OperationFailedException
- if the backing IDefinitionLocator
is unable to remove the named propertydefinition.void removeAllPropertyDefinitions(IContext context) throws ObjectInUseException
getNamespaceName()
. This indirectly calls IDefinitionLocator.removeAllPropertyDefinitions(IContext, INamespaceName)
context
- a property service context. If this API is accessed remotely this context must have remote properties.ObjectInUseException
- if there is at least one propertysetdefinition referring this. Remove all the propertysetdefinitions referring this by calling removeAllPropertySetDefinitions(IContext)
and then call this to avoid getting this exception.OperationFailedException
- if the backing IDefinitionLocator
is unable to remove propertydefinitions.IPagedList<IPropertyDefinition> filter(IContext context, PropertyDefinitionFilterContext filterContext)
getNamespaceName()
and based on the given filterContext
. This indirectly calls IDefinitionLocator.filter(IContext, INamespaceName, oracle.wcps.property.filter.PropertyDefinitionFilterContext)
.context
- a property service context. If this API is accessed remotely this context must have remote properties.filterContext
- a filter context that contains search expression and pagination context.OperationFailedException
- if the backing IDefinitionLocator
is unable to filter propertydefinitions.
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.6.0) E15995-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |