@ProviderType
public interface ResourceCollectionManager
ResourceCollectionManager
defines the API to get, create and delete
resource collections ResourceCollection
.
The ResourceCollectionManager service can be retrieved by looking it up from the
service registry or by adapting a ResourceResolver
.Modifier and Type | Method and Description |
---|---|
ResourceCollection |
createCollection(org.apache.sling.api.resource.Resource parentResource,
String name)
This method creates a resource collection with a given name under the
parentResource . |
ResourceCollection |
createCollection(org.apache.sling.api.resource.Resource parentResource,
String name,
Map<String,Object> properties)
This method creates a resource collection with a given name under the
parentResource . |
boolean |
deleteCollection(org.apache.sling.api.resource.Resource resource)
Removes the
ResourceCollection corresponding to the collection represented by
resource . |
ResourceCollection |
getCollection(org.apache.sling.api.resource.Resource resource)
This method returns a resource collection for the given
resource
that represents a ResourceCollection . |
ResourceCollection getCollection(org.apache.sling.api.resource.Resource resource)
resource
that represents a ResourceCollection
.
It returns null if given resource is not a collectionresource
- resource that represents a collectionResourceCollection
representing the collection.ResourceCollection createCollection(org.apache.sling.api.resource.Resource parentResource, String name) throws org.apache.sling.api.resource.PersistenceException
parentResource
.
The changes are transient and have to be saved by resourceResolver.commit()parentResource
- parent resource where collection needs to be created.name
- The name for collection.ResourceCollection
representing the created collection.org.apache.sling.api.resource.PersistenceException
- if the operation failsResourceCollection createCollection(org.apache.sling.api.resource.Resource parentResource, String name, Map<String,Object> properties) throws org.apache.sling.api.resource.PersistenceException
parentResource
.
The changes are transient and have to be saved by resourceResolver.commit()parentResource
- parent resource where collection needs to be created.name
- The name for collection.properties
- The additional data for resource collectionResourceCollection
representing the created collection.org.apache.sling.api.resource.PersistenceException
- if the operation failsboolean deleteCollection(org.apache.sling.api.resource.Resource resource) throws org.apache.sling.api.resource.PersistenceException
ResourceCollection
corresponding to the collection represented by
resource
.
The changes are transient and have to be saved by resourceResolver.commit()resource
- resource representing a collection to be deleted.true
if the collection was successfully removed.org.apache.sling.api.resource.PersistenceException
- if the operation failsCopyright © 2007–2022 The Apache Software Foundation. All rights reserved.