com.sas.hls.recyclebin
Interface RecycleBinService


public interface RecycleBinService

Service for retrieving and permanently deleting items in the recycle bin. To see recycle bin items at the Organization and below, the current user must be a member of the Organization and have either Permanently Delete Items or Restore Items Deleted by Other at the Organization. If you have the Permanently Delete Items privilege at the Organization, you can permanently delete items from the Recycle Bin regardless of who deleted them.


Method Summary
 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> deleteItemQuery(RecycleBinItem item)
           
 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.
 

Method Detail

deleteAvailableItems

Set<String> deleteAvailableItems()
                                 throws RecycleBinItemDeleteException
Permanently deletes all items in the recycle bin that the current user has permission to delete.

Returns:
Paths representing items that were permanently deleted.
Throws:
RecycleBinItemDeleteException - Thrown if a recycle bin item cannot be deleted.

getAvailableItems

Set<RecycleBinItem> getAvailableItems()
                                      throws RecycleBinItemSearchException
Gets items in the recycle bin to which the current user has the privilege to delete. To see recycle bin items at the Organization and below, the current user must be a member of the Organization and have either Permanently Delete Items or Restore Items Deleted by Other at the Organization. There is a limit to the number of items returned. The default limit is 5000. This limit can be configured on the server.

Returns:
RecycleBinItems representing the items in the recycle bin
Throws:
RecycleBinItemSearchException - Thrown if the recycle bin items cannot be retrieved.

deleteItem

Set<String> deleteItem(RecycleBinItem item)
                       throws RecycleBinItemNotFoundException,
                              RecycleBinItemDeleteException
Permanently deletes the specified item in the recycle bin. If the item specified is a container, the children will be deleted as well.

Parameters:
item - RecycleBinItem representing the item in the recycle bin to delete.
Returns:
Paths representing item(s) that were permanently deleted. If the item deleted is a container, paths of the child items deleted will also be returned.
Throws:
RecycleBinItemNotFoundException - Thrown if the recycle bin item specified cannot be found.
RecycleBinItemDeleteException - Thrown if a recycle bin item cannot be deleted.

deleteItems

Set<String> deleteItems(Set<RecycleBinItem> items)
                        throws RecycleBinItemNotFoundException,
                               RecycleBinItemDeleteException
Permanently deletes the specified items in the recycle bin. If the item specified is a container, the children will be deleted as well.

Parameters:
items - RecycleBinItem representing items in the recycle bin to delete.
Returns:
Paths representing item(s) that were permanently deleted. If an item deleted is a container, paths of the child items deleted will also be returned.
Throws:
RecycleBinItemNotFoundException - Thrown if the recycle bin item specified cannot be found.
RecycleBinItemDeleteException - Thrown if a recycle bin item cannot be deleted.

deleteItemQuery

Set<String> deleteItemQuery(RecycleBinItem item)
                            throws RecycleBinItemNotFoundException,
                                   RecycleBinItemDeleteException
Throws:
RecycleBinItemNotFoundException
RecycleBinItemDeleteException


Copyright (c) 2016, SAS Institute Inc., Cary, NC, USA