public interface RecycleBinService
Modifier and Type | Method and Description |
---|---|
void |
clearRecycleBinItemsInfo(RecycleBinToken token)
Releases the token and any cached information about the query associated with the token.
|
Set<String> |
deleteAvailableItems()
Permanently deletes all items in the recycle bin that the current user has permission to delete.
|
Set<String> |
deleteItem(RecycleBinItem item)
Permanently deletes the specified item in the recycle bin.
|
Set<String> |
deleteItems(Set<RecycleBinItem> items)
Permanently deletes the specified items in the recycle bin.
|
Set<RecycleBinItem> |
getAvailableItems()
Gets items in the recycle bin to which the current user has the privilege to delete.
|
int |
getPageSizeLimit()
Gets the maximum number of recycle bin items that can be returned in a single request.
|
Set<RecycleBinItem> |
getRecycleBinItems(RecycleBinToken token,
int fromRow,
int toRow)
Gets RecycleBinItem objects using a token from RecycleBinItemsInfo which is obtained by calling
getRecycleBinItemsInfoByQuery.
|
RecycleBinItemsInfo |
getRecycleBinItemsInfoByQuery(RecycleBinItemQuery rbq)
Returns an RecycleBinItemsInfo object which contains a token and row count in which to request recycle bin items.
|
Set<String> deleteAvailableItems() throws RecycleBinItemDeleteException
RecycleBinItemDeleteException
- Thrown if a recycle bin item cannot be deleted.Set<RecycleBinItem> getAvailableItems() throws RecycleBinItemSearchException
RecycleBinItemSearchException
- Thrown if the recycle bin items cannot be retrieved.Set<String> deleteItem(RecycleBinItem item) throws RecycleBinItemNotFoundException, RecycleBinItemDeleteException
item
- RecycleBinItem representing the item in the recycle bin to delete.RecycleBinItemNotFoundException
- Thrown if the recycle bin item specified cannot be found.RecycleBinItemDeleteException
- Thrown if a recycle bin item cannot be deleted.Set<String> deleteItems(Set<RecycleBinItem> items) throws RecycleBinItemNotFoundException, RecycleBinItemDeleteException
items
- RecycleBinItem representing items in the recycle bin to delete.RecycleBinItemNotFoundException
- Thrown if the recycle bin item specified cannot be found.RecycleBinItemDeleteException
- Thrown if a recycle bin item cannot be deleted.RecycleBinItemsInfo getRecycleBinItemsInfoByQuery(RecycleBinItemQuery rbq) throws RecycleBinItemSearchException
rbq
- RecycleBinItemQuery containing criteria in which to filter the recycle bin items.RecycleBinItemSearchException
- thrown if there was an issue performing the querySet<RecycleBinItem> getRecycleBinItems(RecycleBinToken token, int fromRow, int toRow) throws RecycleBinItemSearchException
token
- A token identifying a generated recycle bin item query on the serverfromRow
- Row number in which to start with. Must be greater than 0.toRow
- Row number to end with. Must be less than or equal to the rowCount on RecycleBinItemsInfoRecycleBinItemSearchException
- thrown if the token has been cleared from the server or if the total row number
requested exceeds the page size limitvoid clearRecycleBinItemsInfo(RecycleBinToken token)
token
- A token identifying a generated recycle bin query on the serverint getPageSizeLimit()
Copyright (c) 2017, SAS Institute Inc., Cary, NC, USA