|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.livecycle.rightsmanagement.client.infomodel.LicenseSearchFilter
public class LicenseSearchFilter
The LicenseSearchFilter
class is used to specify search criteria when searching
for licenses.
This class provides methods for setting and retrieving the values of parameters for searching for licenses by the name of the document and the identification of the policy associated with the license, the name of the publisher, and the date when the license was issued:
The getLicenses
method uses LicenseSearchFilter
objects to perfom searches.
Constructor Summary | |
---|---|
LicenseSearchFilter()
A constructor that creates a LicenseSearchFilter object. |
Method Summary | |
---|---|
java.lang.String |
getDocumentName()
Retrieves the value of the parameter used for searching for licenses by the name of the document associated with the licenses. |
java.util.Date |
getLicenseIssueBeginDate()
Retrieves the value of the parameter used for searching for licenses by the date after which they were issued. |
java.util.Date |
getLicenseIssueEndDate()
Retrieves the value of the parameter used for searching for licenses by the date before which they were issued. |
java.lang.String |
getPolicyId()
Returns the value of the parameter used for searching for licenses by the identification of the policy associated with the licenses. |
Principal |
getPublisher()
Retrieves the value of the parameter used for searching for licenses by the publisher of the documents associated with the licenses. |
void |
setDocumentName(java.lang.String name)
Sets the value of the parameter used for searching for licenses by the name of the document associated with the licenses. |
void |
setLicenseIssueBeginDate(java.util.Date beginDate)
Sets the value of the parameter used for searching for licenses by the date after which they were issued. |
void |
setLicenseIssueEndDate(java.util.Date endDate)
Sets the value of the parameter used for searching for licenses by the date before which they were issued. |
void |
setPolicyId(java.lang.String policyId)
Sets the value of the parameter used for searching for licenses by the identification of the policy associated with the licenses. |
void |
setPublisher(Principal publisher)
Sets the value of the parameter used for searching for licenses by the publisher of the documents associated with the licenses. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LicenseSearchFilter()
LicenseSearchFilter
object.
Method Detail |
---|
public java.lang.String getDocumentName()
java.lang.String
that holds the name of the document to search or null if no document name is set.public java.util.Date getLicenseIssueBeginDate()
java.util.Date
object that holds the issuing date after which the licenses were issued
or null if no date is set.public java.util.Date getLicenseIssueEndDate()
java.util.Date
object that holds the issuing date before which the licenses were issued or
null if no date is set.public Principal getPublisher()
Principal
object that represents the publisher of the licenses
or null if no publisher is set.public void setDocumentName(java.lang.String name)
name
- A java.lang.String
that holds the entire name or part of the name of the document
associated with the licenses.public void setLicenseIssueBeginDate(java.util.Date beginDate)
beginDate
- A java.util.Date
object that represents the date after which
the licenses were issued.public void setLicenseIssueEndDate(java.util.Date endDate)
endDate
- A java.util.Date
object that represents the date before which
the licenses were issued.public void setPublisher(Principal publisher)
publisher
- A Principal
object that represents the publisher of the licenses.public void setPolicyId(java.lang.String policyId)
policyId
- A java.lang.String
that holds the unique identification
of the policy associated with the licenses.public java.lang.String getPolicyId()
java.lang.String
that holds the identification of the policy
associated with the licenses.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |