public interface RecycleBinService
Note that items returned from this service return explicitly deleted items. If a container is deleted, the container will be returned, not its children.
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 specified item with the specified id 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 specified recycle bin items with the specified identifiers in the recycle bin.
|
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
- contains the criteria with which to permanently delete items from the recycle bin.RecycleBinItemSearchException
- thrown when there was an issue processing the recycle bin query.List<String> deleteItem(RecycleBinItem item) throws RecycleBinItemNotFoundException, RecycleBinItemDeleteException
item
- RecycleBinItem representing the item in the recycle bin to delete.RecycleBinItemNotFoundException
- Thrown when the recycle bin item specified cannot be found.RecycleBinItemDeleteException
- Thrown when a recycle bin item cannot be deleted.List<String> deleteItemById(String recycleBinItemId) throws RecycleBinItemNotFoundException, RecycleBinItemDeleteException
recycleBinItemId
- identifier that represents items in the recycle bin to delete.RecycleBinItemNotFoundException
- Thrown when the recycle bin item specified cannot be found.RecycleBinItemDeleteException
- Thrown when a recycle bin item cannot be deleted.List<String> deleteItems(Set<RecycleBinItem> items)
items
- RecycleBinItem that represents items in the recycle bin to delete.List<String> deleteItemsByIds(Set<String> recycleBinItemIds)
recycleBinItemIds
- identifiers that represents items in the recycle bin to delete.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()
will be set to true
. If true, more items may exist that
satisfy the query but they could not be returned. Items the current user does not have read access to will not be
returned unless the user has the Permanently Delete Items or Restore Items Deleted by Others privilege.
Note 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 query location
specified, only the current user's items will be returned. If null or blank location
is specified on
the query, the location defaults to root which assumes no privileges and, similarly, only the current user's
items will be returned.
query
- contains the search criteria with which to query the recycle bin.RecycleBinItem
s that satisfy the query and whether the limit was reached on the server.RecycleBinItemSearchException
- thrown when there was an issue processing the recycle bin searchCopyright (c) 2019, SAS Institute Inc., Cary, NC, USA