public interface INamespaceManager
Modifier and Type | Method and Description |
---|---|
long |
countResources(IResourceHandle rootResourceHandle,
IFindResourcesDescriptor findResourcesDescriptor)
Count resources matching certain criteria specified in the find resources
descriptor returning their number.
|
Iterator |
findResources(IResourceHandle rootResourceHandle,
IFindResourcesDescriptor findResourcesDescriptor,
int startIndex,
int fetchSize)
Find resources matching certain criteria specified in the find resources
descriptor returning an iterator for the results.
|
List |
findResources(IResourceHandle rootResourceHandle,
IFindResourcesDescriptor findResourcesDescriptor,
int offset,
int length,
Object resultStateDescriptor)
Find resources matching certain criteria specified in the find resources
descriptor returning a list of the results.
|
OrderMechanism |
getCollectionOrderMechanism(IResourceHandle resourceHandle)
Returns the
OrderMechanism of the collection. |
ILinkDescriptor |
getLinkDescriptor(IResourceHandle resourceHandle)
Returns the
ILinkDescriptor of the link. |
IQueryBuilder |
getQueryBuilder()
Get a search manager specific query builder, which may be used to build
query expressions of type
IQueryExpression . |
boolean |
isCollection(IResourceHandle handle)
Check if a resource handle denotes a resource collection.
|
boolean |
isLink(IResourceHandle handle)
Check if a resource handle denotes a resource link, i.e. a resource linking
to another resource.
|
boolean |
isQueryPropertyNameUnderstood(IName propertyName)
Return whether or not the manager has special knowledge about the given
property, i.e. understands the semantic of this property.
|
List findResources(IResourceHandle rootResourceHandle, IFindResourcesDescriptor findResourcesDescriptor, int offset, int length, Object resultStateDescriptor) throws ResourceException, OperationNotSupportedException
rootResourceHandle
- root resource handlefindResourcesDescriptor
- find resources descriptoroffset
- if a positive number, the first n matching resources will be
skipped; 0 reports all resultslength
- if a positive number, only the top number of matching
resources will be returned; if less entries are returned no more data
is available, if exact <length> entries are returned there might
be more and a new call with <oldoffset> + <length> as the
new offset is recommended to determine whether the overall result was
complete; a negative number reports all resultsresultStateDescriptor
- optional parameter identifying a former query
and their results; if the implementation is able to keep a "session
state" for upcoming calls this state can be passed as an extra
argument. In this case the result of this query should be a special
object (implementing List) with a getter for the session result state
descriptor objectOperationNotSupportedException
- Exception raised when the
iterator based counterpart is implemented onlyResourceException
- Exception raised in failure situationIFindResourcesDescriptor
,
IResultStateList
Iterator findResources(IResourceHandle rootResourceHandle, IFindResourcesDescriptor findResourcesDescriptor, int startIndex, int fetchSize) throws ResourceException, OperationNotSupportedException
rootResourceHandle
- root resource handlefindResourcesDescriptor
- find resources descriptorstartIndex
- start index from which on the matching resources will be
returned; support is not mandatory; 0 reports all resultsfetchSize
- hint for the implementation how often next() will usually
be called in a row; support is not mandatory and fetchSize may be
internally overwritten to be of a more optimal value not throwing an
exception; 0 defines no hintOperationNotSupportedException
- Exception raised when the list
based counterpart is implemented onlyResourceException
- Exception raised in failure situationIFindResourcesDescriptor
long countResources(IResourceHandle rootResourceHandle, IFindResourcesDescriptor findResourcesDescriptor) throws ResourceException, OperationNotSupportedException
rootResourceHandle
- root resource handlefindResourcesDescriptor
- find resources descriptorResourceException
- Exception raised in failure situationOperationNotSupportedException
- Exception raised in failure
situationIFindResourcesDescriptor
IQueryBuilder getQueryBuilder() throws ResourceException, OperationNotSupportedException
IQueryExpression
.ResourceException
- Exception raised in failure situationOperationNotSupportedException
- Exception raised in failure
situationboolean isQueryPropertyNameUnderstood(IName propertyName) throws ResourceException, OperationNotSupportedException
propertyName
- property nameResourceException
- Exception raised in failure situationOperationNotSupportedException
- Exception raised in failure
situationboolean isCollection(IResourceHandle handle) throws ResourceException
handle
- resource handleResourceException
- Exception raised in failure situationboolean isLink(IResourceHandle handle) throws ResourceException
handle
- resource handleResourceException
- Exception raised in failure situationOrderMechanism getCollectionOrderMechanism(IResourceHandle resourceHandle) throws ResourceException
OrderMechanism
of the collection.resourceHandle
- resource handle of the collectionOrderMechanism
of the collection.ResourceException
- Exception raised in failure situationILinkDescriptor getLinkDescriptor(IResourceHandle resourceHandle) throws ResourceException
ILinkDescriptor
of the link.resourceHandle
- resource handle of the linkILinkDescriptor
of the link.ResourceException
- 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