public interface RecycleBinService
Note that items returned from this service are items that were explicitly deleted. If a container is deleted, the container is returned, not its children. This is because the children were not explicitly deleted.
Modifier and Type | Method and Description |
---|---|
List<String> |
deleteAvailableItems()
Permanently deletes all of the items in the recycle bin that the current user has access to delete.
|
List<String> |
deleteItem(RecycleBinItem item)
Permanently deletes the specified item in the recycle bin.
|
List<String> |
deleteItemById(String recycleBinItemId)
Permanently deletes the item with the specified identifier in the recycle bin.
|
List<String> |
deleteItems(Set<RecycleBinItem> items)
Permanently deletes the specified items in the recycle bin.
|
List<String> |
deleteItemsByIds(Set<String> recycleBinItemIds)
Permanently deletes the recycle bin items with the specified identifiers.
|
List<String> |
deleteItemsByQuery(RecycleBinQuery query)
Permanently deletes all of the items that can be deleted in the recycle bin based on the specified query.
|
RecycleBinSearchResults |
search(RecycleBinQuery query)
Searches the recycle bin based on the specified query.
|
List<String> deleteAvailableItems()
List<String> deleteItemsByQuery(RecycleBinQuery query) throws RecycleBinItemSearchException
query
- The criteria by which to permanently delete items.RecycleBinItemSearchException
- Thrown when there is an issue processing the query.List<String> deleteItem(RecycleBinItem item) throws RecycleBinItemNotFoundException, RecycleBinItemDeleteException
item
- The RecycleBinItem that represents the item in the recycle bin.RecycleBinItemNotFoundException
- Thrown when the specified recycle bin item is not found.RecycleBinItemDeleteException
- Thrown when a recycle bin item cannot be deleted.List<String> deleteItemById(String recycleBinItemId) throws RecycleBinItemNotFoundException, RecycleBinItemDeleteException
recycleBinItemId
- The identifier that represents the items in the recycle bin.RecycleBinItemNotFoundException
- Thrown when the specified recycle bin item is not found.RecycleBinItemDeleteException
- Thrown when a recycle bin item cannot be deleted.List<String> deleteItems(Set<RecycleBinItem> items)
items
- The RecycleBinItem that represents items in the recycle bin.List<String> deleteItemsByIds(Set<String> recycleBinItemIds)
recycleBinItemIds
- The identifiers that represents items in the recycle bin.RecycleBinItemNotFoundException
- Thrown when the recycle bin item is not found.RecycleBinItemDeleteException
- Thrown when a recycle bin item cannot be deleted.RecycleBinSearchResults search(RecycleBinQuery query) throws RecycleBinItemSearchException
RecycleBinItem
s that
satisfy the query. If the server cannot process all of the items due to server limitations,
RecycleBinSearchResults.isLimitReached()
is set to True. If True, more items might exist that satisfy the
query, but they cannot be returned. Items to which the current user does not have Read access are not returned
unless the user has the Permanently Delete Items or Restore Items Deleted by Others privilege.
Note that if "*" is specified for deletedBy
in RecycleBinQuery
, and the current user does
not have the Permanently Delete Items or Restore Items Deleted by Others privilege at the specified query
location
, only the current user's items are returned. If null or a blank location
is
specified in the query, the location defaults to the root, which assumes no privileges and, similarly, only the
current user's items are returned.
query
- The search criteria with which to query the recycle bin.RecycleBinItem
s that satisfy
the query, and whether the limit is reached on the server.RecycleBinItemSearchException
- Thrown when there is an issue processing the recycle bin search.<i>Copyright (c) 2020, SAS Institute Inc., Cary, NC, USA</i>