Modifier and Type | Method and Description |
---|---|
ICollection |
createCollection(String name,
IPosition position,
IPropertyMap properties)
Creates a new sub collection in a collection that supports ordering.
|
ICollection |
createCollection(String name,
IPosition position,
IPropertyMap properties,
boolean ignorePropertyFailures)
Creates a new sub collection in a collection that supports ordering.
|
ICollection |
createCollection(String name,
IPropertyMap properties)
Creates a new sub collection in a collection.
|
ICollection |
createCollection(String name,
IPropertyMap properties,
boolean ignorePropertyFailures)
Creates a new sub collection in a collection.
|
IResource |
createLink(String name,
URL targetURL,
LinkType linkType,
IPosition position,
IPropertyMap properties)
Creates a new link in a collection that supports ordering.
|
IResource |
createLink(String name,
URL targetURL,
LinkType linkType,
IPosition position,
IPropertyMap properties,
boolean ignorePropertyFailures)
Creates a new link in a collection that supports ordering.
|
IResource |
createLink(String name,
URL targetURL,
LinkType linkType,
IPropertyMap properties)
Creates a new link in a collection.
|
IResource |
createLink(String name,
URL targetURL,
LinkType linkType,
IPropertyMap properties,
boolean ignorePropertyFailures)
Creates a new link in a collection.
|
ILockInfo |
createResource(String name,
ILockProperties lockProperties)
Creates a empty resource that is initially locked (lock null resource)
|
IResource |
createResource(String name,
IPosition position,
IPropertyMap properties,
IContent content)
Creates a new resource in a collection that supports ordering.
|
IResource |
createResource(String name,
IPosition position,
IPropertyMap properties,
IContent content,
boolean ignorePropertyFailures)
Creates a new resource in a collection that supports ordering.
|
IResource |
createResource(String name,
IPropertyMap properties,
IContent content)
Creates a new resource in a collection.
|
IResource |
createResource(String name,
IPropertyMap properties,
IContent content,
boolean ignorePropertyFailures)
Creates a new resource in a collection.
|
IResourceList |
getChildren()
Returns a list of all resources in the collection
|
IResourceList |
getChildren(boolean visible,
boolean collections,
boolean links)
Returns a filtered list of the resources in this collection.
|
IResourceList |
getChildren(Selector childrenSelector,
Collator sortBy,
IPropertyNameList propertyPrefill)
Returns the children of this collection.
|
IResourceList |
getChildren(Selector childrenSelector,
Collator sortBy,
IPropertyNameList propertyPrefill,
String[] permissionNames)
Returns the children of this collection.
|
int |
getChildrenCount(boolean visible,
boolean collections,
boolean links)
Returns the number of filtered children in the collection.
|
IResourceList |
getChildrenWithoutLinkMapping()
This method will return all child resources without performing the special handling for link resources.
|
OrderType |
getOrderType()
Returns the order type of a collection
|
boolean |
hasChildren()
True if the collection has at least one child resource
|
void |
reorder(IReorderList list)
Change the position of some or all resources in an ordered collection.
|
void |
setOrderType(OrderType orderType)
Set the order type of a collection
|
as, checkIn, checkIn, checkIn, checkIn, checkOut, copy, copy, copy, copy, delete, deleteProperty, enableVersioning, getAccessRID, getAccessURI, getCheckedOutResources, getContent, getContent, getContext, getCreatedBy, getCreationDate, getDescription, getDisplayName, getDisplayName, getETag, getInheritedProperty, getLanguage, getLastModified, getLastModifiedBy, getLinkType, getLockByToken, getLocks, getName, getParentCollection, getProperties, getProperties, getProperty, getRepositoryManager, getResourceType, getRevisionID, getRID, getSupportedEvents, getSupportedOptions, getTargetResource, getTargetURL, getUnfilteredContent, getUnfilteredContent, getURI, getVersionHistory, isA, isCheckedOut, isCollection, isHidden, isLocked, isLockedByMe, isReadOnly, isRevision, isVersioned, lock, lock, move, move, move, move, refreshLock, rename, search, setAsCurrentVersion, setLinkType, setProperties, setProperties, setProperty, setTargetURL, undoCheckOut, unlock, update, updateContent
IResourceList getChildren() throws ResourceException, AccessDeniedException
ResourceException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedIResourceList getChildren(boolean visible, boolean collections, boolean links) throws ResourceException, AccessDeniedException
visible
- true: activate visibility check and only visible resource are selected (system property "hidden"
is false), false: visibility check is disabled and both visible and hidden resources are selectedcollections
- true: activate check for collections and only collections are selected (links to collection
are also included regardless of links flag), false: check for collections is disabledlinks
- true: activate check for links and only link resources are selected, false: check for links is disabledResourceException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedint getChildrenCount(boolean visible, boolean collections, boolean links) throws ResourceException, AccessDeniedException
visible
- true: visibility check is active and only visible resource are counted (system property "hidden"
is false), false: visibility check is disabled and both visible and hidden resources are countedcollections
- true: collections check is active and only collections are counted (links to collection
are also included regardless of links flag), false: check for collections is disabledlinks
- true: links check is active and only link resources are counted, false: check for links is disabledResourceException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedIResourceList getChildren(Selector childrenSelector, Collator sortBy, IPropertyNameList propertyPrefill) throws ResourceException, AccessDeniedException
null
)
which will cause properties to be fetched: Collator, Selector or propertyPrefill).childrenSelector
- Specifies the filter expressionsortBy
- Specifies the ordering of the returned list. Children which are collections are grouped together and are placed BEFORE the non-collections.propertyPrefill
- Specifies the names of properties which should be fetched
for the children of the collection in addition to those needed for filtering and sorting. This "prefetching" can improve
performance of subsequent getProperty() calls on the child resources.ResourceException
AccessDeniedException
- If the resource is locked, readonly or authorization failedIResourceList getChildren(Selector childrenSelector, Collator sortBy, IPropertyNameList propertyPrefill, String[] permissionNames) throws ResourceException, AccessDeniedException
null
)
which will cause properties to be fetched: Collator, Selector or propertyPrefill).childrenSelector
- Specifies the filter expressionsortBy
- Specifies the ordering of the returned list. Children which are collections are grouped together and are placed BEFORE the non-collections.propertyPrefill
- Specifies the names of properties which should be fetched
for the children of the collection in addition to those needed for filtering and sorting. This "prefetching" can improve
performance of subsequent getProperty() calls on the child resources.permissionNames
- An array of permission names (permission name constants are defined in IPermission).
Resources for which the user in the context does not have one of the secified permissions are removed from the result list.ResourceException
AccessDeniedException
- If the resource is locked, readonly or authorization failedboolean hasChildren() throws ResourceException
ResourceException
OrderType getOrderType() throws ResourceException
ResourceException
void setOrderType(OrderType orderType) throws ResourceException, NotSupportedException, AccessDeniedException
orderType
- orderType to be setResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedvoid reorder(IReorderList list) throws ResourceException, NotSupportedException, AccessDeniedException
list
- A list that contains IPositioning
instances that
specify how the resources in the collection should be positioned.ResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedICollection createCollection(String name, IPropertyMap properties) throws ResourceException, NotSupportedException, AccessDeniedException
name
- The name of the new collection.properties
- The intial properties to set for the new resource. The
repository will try to set all properties in the map.ResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedICollection createCollection(String name, IPosition position, IPropertyMap properties) throws ResourceException, NotSupportedException, AccessDeniedException
name
- The name of the new collectionposition
- The position in the collectionproperties
- The intial properties to set for the new resource. The
repository will try to set all properties in the map.ResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedICollection createCollection(String name, IPropertyMap properties, boolean ignorePropertyFailures) throws ResourceException, NotSupportedException, AccessDeniedException
name
- The name of the new collection.properties
- The intial properties to set for the new resource. The
repository will try to set all properties in the map.ignorePropertyFailures
- Ignore exceptions if some or all properties
could not be set/removedResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedICollection createCollection(String name, IPosition position, IPropertyMap properties, boolean ignorePropertyFailures) throws ResourceException, NotSupportedException, AccessDeniedException
name
- The name of the new collectionposition
- The position in the collectionproperties
- The intial properties to set for the new resource. The
repository will try to set all properties in the map.ignorePropertyFailures
- Ignore exception if some or all properties
could not be set/removedResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedIResource createResource(String name, IPropertyMap properties, IContent content) throws ResourceException, NotSupportedException, AccessDeniedException
name
- The name of the resourceproperties
- The intial properties to set for the new resource. The
repository will try to set all properties in the map.content
- The new contentResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedIResource createResource(String name, IPosition position, IPropertyMap properties, IContent content) throws ResourceException, NotSupportedException, AccessDeniedException
name
- The name of the resourceposition
- Ths positioning informationproperties
- The intial properties to set for the new resource. The
repository will try to set all properties in the map.content
- The new contentResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedIResource createResource(String name, IPropertyMap properties, IContent content, boolean ignorePropertyFailures) throws ResourceException, NotSupportedException, AccessDeniedException
name
- The name of the resourceproperties
- The intial properties to set for the new resource. The
repository will try to set all properties in the map.content
- The new contentignorePropertyFailures
- Ignore exception if some or all properties
could not be set/removedResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedIResource createResource(String name, IPosition position, IPropertyMap properties, IContent content, boolean ignorePropertyFailures) throws ResourceException, NotSupportedException, AccessDeniedException
name
- The name of the resourceposition
- The positioning informationproperties
- The intial properties to set for the new resource. The
repository will try to set all properties in the map.content
- The new contentignorePropertyFailures
- ResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedILockInfo createResource(String name, ILockProperties lockProperties) throws ResourceException, NotSupportedException, AccessDeniedException
name
- The name of the resourcelockProperties
- The properties of the lockResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedIResource createLink(String name, URL targetURL, LinkType linkType, IPropertyMap properties) throws ResourceException, NotSupportedException, AccessDeniedException
name
- The name of the resourcetargetURL
- The link targetlinkType
- The link typeproperties
- The intial properties to set for the new resource. The
repository will try to set all properties in the map.ResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedIResource createLink(String name, URL targetURL, LinkType linkType, IPosition position, IPropertyMap properties) throws ResourceException, NotSupportedException, AccessDeniedException
name
- The name of the resourcetargetURL
- The link targetlinkType
- The link typeposition
- The positioning informationproperties
- The intial properties to set for the new resource. The
repository will try to set all properties in the map.ResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedIResource createLink(String name, URL targetURL, LinkType linkType, IPropertyMap properties, boolean ignorePropertyFailures) throws ResourceException, NotSupportedException, AccessDeniedException
name
- The name of the resourcetargetURL
- The link targetlinkType
- The link typeproperties
- The intial properties to set for the new resource. The
repository will try to set all properties in the map.ignorePropertyFailures
- ResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedIResource createLink(String name, URL targetURL, LinkType linkType, IPosition position, IPropertyMap properties, boolean ignorePropertyFailures) throws ResourceException, NotSupportedException, AccessDeniedException
name
- The name of the resourcetargetURL
- The link targetlinkType
- The link typeposition
- The positioning informationproperties
- The intial properties to set for the new resource. The
repository will try to set all properties in the map.ignorePropertyFailures
- ResourceException
NotSupportedException
AccessDeniedException
- If the resource is locked, readonly or
authorization failedIResourceList getChildrenWithoutLinkMapping() throws ResourceException, NotSupportedException, AccessDeniedException
ResourceException
NotSupportedException
AccessDeniedException
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 2018 SAP AG Complete Copyright Notice