public interface IResourceFactory
IResource) and to access the manager and
service factories.
Copyright (c) SAP AG 2001-2004
IManagerFactory| Modifier and Type | Method and Description |
|---|---|
boolean |
checkExistence(RID rid,
IResourceContext context)
Returns
true if a resource exists for the given resource identifier. |
boolean |
checkExistence(URI uri,
IResourceContext context)
Deprecated.
As of EP 5.0 SP3, replaced by method with RID parameter.
|
IArchivingFactory |
getArchivingFactory()
Returns an instance of the archiving factory.
|
IFilterFactory |
getFilterFactory()
Returns a instance of the FilterFactory
|
IManagerFactory |
getManagerFactory()
Returns a instance of the ManagerFactory
|
Object |
getObject(RID rid,
IResourceContext context,
Class asClass)
Returns a resource object converted into a semantic object for the given resource identifier and context.
|
IResource |
getResource(RID rid,
boolean resolveInternalLinks,
IResourceContext context)
Returns a resource object instance for the given RID and context.
|
IResource |
getResource(RID rid,
IResourceContext context)
Returns a resource object instance for the given resource identifier and context.
|
IResource |
getResource(RID rid,
IResourceContext context,
boolean createCollections)
Returns a resource object instance for the given RID and context.
|
IResource |
getResource(URI uri,
IResourceContext context)
Deprecated.
As of EP 5.0 SP3, replaced by getResource() method with RID parameter.
|
IResource |
getResource(URI uri,
IResourceContext context,
boolean createCollections)
Deprecated.
As of EP 5.0 SP3, replaced by getResource() method with RID parameter.
|
IResourceBatch |
getResourceBatch(IResourceList resourceList)
Creates a resource batch instance for the given resource list.
|
IResourceList |
getResources(IRidList ridList,
Map propertyMaps,
ResourceErrors errors,
IResourceContext context)
Returns a list of resource instances for a list of resource identifiers and possible
IPropertyMaps for the
resources. |
IResourceList |
getResources(IRidList ridList,
Map propertyMaps,
ResourceErrors errors,
String[] permissionNames,
IResourceContext context)
Returns a list of resource instances for a list of resource identifiers and possible
IPropertyMaps for the
resources. |
IResourceList |
getResources(IRidList ridList,
ResourceErrors errors,
IResourceContext context)
Returns a list of resource instances for an array of resource identifiers.
|
IResourceList |
getResources(IRidList ridList,
ResourceErrors errors,
String[] permissionNames,
IResourceContext context)
Returns a list of resource instances for an array of resource identifiers and removes resources without the
specified permission(s) from the result list.
|
IResourceList |
getResources(IUriList uriList,
ResourceErrors errors,
IResourceContext context)
Deprecated.
As of EP 5.0 SP3, replaced by getResources() method with IRidList parameter.
|
IResourceContext |
getServiceContext()
Returns a new resource context for services with an anonymous user
|
IResourceContext |
getServiceContext(String userID)
Deprecated.
As of NetWeaver 7.1, replaced by
getServiceContextUME(String) |
IResourceContext |
getServiceContextUME(String userName)
Returns a new resource context for services with an anonymous user
|
IRepositoryServiceFactory |
getServiceFactory()
Returns a instance of the ServiceFactory
|
IResource getResource(URI uri, IResourceContext context) throws ResourceException, AuthorizationRequiredException
uri - TBD: Description of the incoming method parametercontext - TBD: Description of the incoming method parameterResourceException - Exception raised in failure situationAuthorizationRequiredException - Exception raised in failure situationIResource getResource(URI uri, IResourceContext context, boolean createCollections) throws ResourceException, AuthorizationRequiredException
uri - TBD: Description of the incoming method parametercontext - TBD: Description of the incoming method parametercreateCollections - TBD: Description of the incoming method parameterResourceException - Exception raised in failure situationAuthorizationRequiredException - Exception raised in failure situationIResource getResource(RID rid, IResourceContext context) throws ResourceException
getResource(rid, true,
context) . Returns null if the resource does not exist.rid - The resource identifier of the resource.context - The resource context.null is returned only if the resource definitively does not
exist. If it can not be created by the repositoy for some other reason (e.g. internal error) an appropriate
exception such as ServiceUnavailableException will be thrownResourceException - Exception raised in failure situationObject getObject(RID rid, IResourceContext context, Class asClass) throws ResourceException
rid - TBD: Description of the incoming method parametercontext - TBD: Description of the incoming method parameterasClass - TBD: Description of the incoming method parameterResourceException - Exception raised in failure situationIResource getResource(RID rid, IResourceContext context, boolean createCollections) throws ResourceException
rid - The RID of the resourcecreateCollections - If the resource does not exists create a new collection with that name. All collections in the path will
be created.context - The resource context objectResourceException - Exception raised in failure situationIResource getResource(RID rid, boolean resolveInternalLinks, IResourceContext context) throws ResourceException
rid - The RID of the resourceresolveInternalLinks - true : If the RID contains internal links to collections the framework will find and return
the target resource. In this case the RID of the returned resource will not be equal to the specified RID
parameter. false : If the RID contains internal links to collections a
InternalLinkException
exception is thrown.context - The resource context objectResourceException - Exception raised in failure situationIResource.getRID(),
IResource.getAccessRID()IResourceList getResources(IUriList uriList, ResourceErrors errors, IResourceContext context) throws ResourceException
uriList - TBD: Description of the incoming method parametererrors - TBD: Description of the incoming method parametercontext - TBD: Description of the incoming method parameterResourceException - Exception raised in failure situationIResourceList getResources(IRidList ridList, ResourceErrors errors, IResourceContext context) throws ResourceException
ResourceErrors instance.ridList - A list of resource identifiers. The list can contain RIDs from different managers.errors - A reference to a ResourceErrors instance. If this is null all exceptions
will be ignored.context - The resource contextResourceException - Exception raised in failure situationIResourceList getResources(IRidList ridList, ResourceErrors errors, String[] permissionNames, IResourceContext context) throws ResourceException
ridList - A list of resource identifiers. The list can contain RIDs from different managers.errors - A reference to a ResourceErrors instance. If this is null all exceptions
will be ignored.permissionNames - An array of permission names. Permission name constants are defined in IPermission.context - The resource contextResourceException - Exception raised in failure situationIResourceList getResources(IRidList ridList, Map propertyMaps, ResourceErrors errors, IResourceContext context) throws ResourceException
IPropertyMaps for the
resources. The property maps need not be present for each and every resource identifier. If a property map is given
for a resource, the caller indicates that he is content to see those properties on the returned resource object. If
these properties are visible on the returned resource or if the repository will return the actual, current
properties is up to the repository.
Repositories are however encouraged to sacrifice exactness for speed, e.g. prefer the client supplied properties compared to (maybe costly) resource lookups and validations.
ridList - A list of resource identifiers. The list can contain RIDs from different managers.propertyMaps - a map holding an IPropertyMap with the resource identifier RID as key.errors - A reference to a ResourceErrors instance. If this is null all exceptions
will be ignored.context - The resource contextResourceException - Exception raised in failure situationIResourceList getResources(IRidList ridList, Map propertyMaps, ResourceErrors errors, String[] permissionNames, IResourceContext context) throws ResourceException
IPropertyMaps for the
resources. The property maps need not be present for each and every resource identifier. If a property map is given
for a resource, the caller indicates that he is content to see those properties on the returned resource object. If
these properties are visible on the returned resource or if the repository will return the actual, current
properties is up to the repository.
Repositories are however encouraged to sacrifice exactness for speed, e.g. prefer the client supplied properties compared to (maybe costly) resource lookups and validations.
ridList - A list of resource identifiers. The list can contain RIDs from different managers.propertyMaps - a map holding an IPropertyMap with the resource identifier RID as key.errors - A reference to a ResourceErrors instance. If this is null all exceptions
will be ignored.permissionNames - An array of permission names. Permission name constants are defined in IPermission.context - The resource contextResourceException - Exception raised in failure situationboolean checkExistence(URI uri, IResourceContext context) throws ResourceException, AuthorizationRequiredException
boolean checkExistence(RID rid, IResourceContext context) throws ResourceException, AuthorizationRequiredException
true if a resource exists for the given resource identifier.
Note that this method should only be used if the caller really only requires this piece of information. Using the
return value to decide whether it makes sense to call getResource(RID, IResourceContext), or to detect
whether a particular RID isn't in use yet DOES NOT WORK due to possible race conditions. Instead, just do the
respective method calls and properly check results/exceptions.
rid - The RID to checkcontext - The resource contextResourceException - Exception raised in failure situationAuthorizationRequiredException - Exception raised in failure situationIRepositoryServiceFactory getServiceFactory() throws ResourceException
ResourceException - Exception raised in failure situationIManagerFactory getManagerFactory() throws ResourceException
ResourceException - Exception raised in failure situationIFilterFactory getFilterFactory() throws ResourceException
ResourceException - Exception raised in failure situationIArchivingFactory getArchivingFactory() throws ResourceException
ResourceExceptionIResourceContext getServiceContext() throws ResourceException
ResourceException - on errorIResourceContext getServiceContext(String userID) throws ResourceException
getServiceContextUME(String)userID - the ID of the service user accountResourceException - on errorIResourceContext getServiceContextUME(String userName) throws ResourceException
userName - the unique name of the service user accountResourceException - on errorIResourceBatch getResourceBatch(IResourceList resourceList)
resourceList - a resource list instance| Access 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 2021 SAP SE Complete Copyright Notice