Package com.sas.lsaf.content.repository.recyclebin

Class RecycleBinQuery

java.lang.Object
com.sas.lsaf.content.repository.recyclebin.RecycleBinQuery
All Implemented Interfaces:
Serializable
public class RecycleBinQuery extends Object implements Serializable
The class that represents the information to filter recycle bin items. Specifying a path queries the recycle bin for items at or below the path. If "*" is specified for deletedBy, 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 are returned. If null or a blank location is specified, the location defaults to the root, which assumes no privileges and, similarly, only the current user's items are returned.
Since:
1.2
See Also:

  • Constructor Details

    • RecycleBinQuery

      public RecycleBinQuery()
      The zero-argument constructor.

    • RecycleBinQuery

      public RecycleBinQuery(String location, String name, String deletedBy, Date fromDate, Date toDate)
      The constructor.
      Parameters:
      location - The location to query.
      name - The name of the source to query.
      deletedBy - The identifier of the user who deleted the item.
      fromDate - The starting deleted date to query.
      toDate - The ending deleted date to query.

    • RecycleBinQuery

      public RecycleBinQuery(String location, boolean recurse, String name, String deletedBy, Date fromDate, Date toDate)
      The constructor.
      Parameters:
      location - The location to query.
      recurse - the boolean value that indicates whether the recycle bin searches the specified location and below.
      name - The name of the source to query.
      deletedBy - The identifier of the user who deleted the item.
      fromDate - The starting deleted date to query.
      toDate - The ending deleted date to query.

  • Method Details

    • getName

      public String getName()
      Gets the name of the item to query in the recycle bin.
      Returns:
      The name of the item to query in the recycle bin. Null specifies that all names are queried.

    • getLocation

      public String getLocation()
      Gets the path to the item to query in the recycle bin.
      Returns:
      The path to the item to query in the recycle bin. Null specifies that all paths are queried.

    • setLocation

      public void setLocation(String location)
      Sets the path to the item to query in the recycle bin. Wildcards are not supported for location.
      Parameters:
      location - The path to the item to query in the recycle bin. Null specifies that all paths are queried.

    • isRecurse

      public boolean isRecurse()
      Indicates whether the recycle bin searches the specified location and below.
      Returns:
      The boolean value that indicates whether the recycle bin searches the specified location and below.

    • setRecurse

      public void setRecurse(boolean recurse)
      Indicates whether recycle bin searches the specified location and below.
      Parameters:
      recurse - The boolean value that indicates whether the recycle bin searches the specified location and below.

    • setName

      public void setName(String name)
      Sets the name of the item to query in the recycle bin.
      Parameters:
      name - The name of the item to query in the recycle bin. Null specifies that all names are queried.

    • getDeletedBy

      public String getDeletedBy()
      Gets the identifier of the user whose deleted files are queried.
      Returns:
      The identifier of the user whose deleted files are queried.

    • setDeletedBy

      public void setDeletedBy(String deletedBy)
      Sets the identifier of the user whose deleted files are queried. Specifying null or empty queries the current user's deleted items. Specifying * queries all users' items. If you do not have the Permanently Delete Items or Restore Items Deleted by Others privilege, only the current user's items are returned.
      Parameters:
      deletedBy - The identifier of the user who deleted the items. Null or blank results in the current user's items. Specifying * queries all users' items. If you do not have the Permanently Delete Items or Restore Items Deleted by Others privilege, only the current user's items are returned.

    • getFromDate

      public Date getFromDate()
      Gets the from deleted date of the item to query in the recycle bin.
      Returns:
      The from deleted date of the item to query in the recycle bin.

    • setFromDate

      public void setFromDate(Date fromDate)
      Sets the starting deleted date of the item to query in the recycle bin.
      Parameters:
      fromDate - The starting deleted date of the item to query in the recycle bin. Null specifies that all dates are queried.

    • getToDate

      public Date getToDate()
      Gets the ending deleted date of the item to query in the recycle bin.
      Returns:
      The ending deleted date of the item to query in the recycle bin.

    • setToDate

      public void setToDate(Date toDate)
      Sets the ending deleted date of the item to query in the recycle bin.
      Parameters:
      toDate - The ending deleted date of the item to query in the recycle bin. Null specifies that all dates are queried.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object