com.adobe.livecycle.rightsmanagement.re
Class GetUsageRightsResult

java.lang.Object
  extended by com.adobe.livecycle.rightsmanagement.re.GetUsageRightsResult
All Implemented Interfaces:
java.io.Serializable

public class GetUsageRightsResult
extends java.lang.Object
implements java.io.Serializable

Represents information about the certificate that enables usage rights to be applied to a PDF document. For example, you can obtain the date after which, the certificate is no longer valid.

See Also:
Serialized Form

Constructor Summary
GetUsageRightsResult(UsageRights rights, java.util.Date notBefore, java.util.Date notAfter, boolean evaluation)
          Not for use by a client application.
 
Method Summary
 java.lang.String getIntendedUse()
          Returns legal intended use notice of the certificate.
 java.lang.String getMessage()
          Returns the message that is displayed within Adobe Reader when the PDF document is opened.
 java.util.Date getNotAfter()
          Returns the date after which the certificate is no longer valid.
 java.util.Date getNotBefore()
          Returns the date before which the certificate is not valid.
 java.lang.String getProfile()
          Returns profile string of the certificate.
 UsageRights getRights()
          Returns the UsageRights object that is enabled by the certificate.
 int getUseCount()
          Returns the number of times a given credential has been used.
 boolean isEvaluation()
           
 void setEvaluation(boolean evaluation)
           
 void setIntendedUse(java.lang.String intendedUse)
          Not for use by a client application.
 void setMessage(java.lang.String message)
          Not for use by a client application.
 void setNotAfter(java.util.Date notAfter)
          Set the date after which the certificate is no longer valid.
 void setNotBefore(java.util.Date notBefore)
          Set the date before which the certificate is not valid.
 void setProfile(java.lang.String profile)
          Not for use by a client application.
 void setRights(UsageRights rights)
          Set the UsageRights object that is enabled by the certificate.
 void setUseCount(int useCount)
          Not for use by a client application.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GetUsageRightsResult

public GetUsageRightsResult(UsageRights rights,
                            java.util.Date notBefore,
                            java.util.Date notAfter,
                            boolean evaluation)
Not for use by a client application.

Parameters:
rights - the UsageRights
notBefore - the credential start date
notAfter - the credential expiration date
evaluation - whether this credential is evaluation
Method Detail

getNotAfter

public java.util.Date getNotAfter()
Returns the date after which the certificate is no longer valid.

Returns:
The date after which the certificate is no longer valid.

setNotAfter

public void setNotAfter(java.util.Date notAfter)
Set the date after which the certificate is no longer valid.

Parameters:
notAfter - the notAfter to set

getNotBefore

public java.util.Date getNotBefore()
Returns the date before which the certificate is not valid.

Returns:
The date before which the certificate is not valid.

setNotBefore

public void setNotBefore(java.util.Date notBefore)
Set the date before which the certificate is not valid.

Parameters:
notBefore - the notBefore to set

getRights

public UsageRights getRights()
Returns the UsageRights object that is enabled by the certificate.

Returns:
The UsageRights object that is enabled by the certificate.

setRights

public void setRights(UsageRights rights)
Set the UsageRights object that is enabled by the certificate.

Parameters:
rights - the rights to set

getUseCount

public int getUseCount()
Returns the number of times a given credential has been used. The value is only meaningful when getting usage rights information from a credential. The value is not meaningful when getting usage rights information from a given PDF document.

Returns:
The number of times the credential has been used.

setUseCount

public void setUseCount(int useCount)
Not for use by a client application.


getMessage

public java.lang.String getMessage()
Returns the message that is displayed within Adobe Reader when the PDF document is opened.

Returns:
A string value that represents the message that is displayed.

setMessage

public void setMessage(java.lang.String message)
Not for use by a client application.


getProfile

public java.lang.String getProfile()
Returns profile string of the certificate.

Returns:
A string value that represents the profile of the certificate.

setProfile

public void setProfile(java.lang.String profile)
Not for use by a client application.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
a String representation of this object

getIntendedUse

public java.lang.String getIntendedUse()
Returns legal intended use notice of the certificate.

Returns:
A string value that represents the profile of the certificate.

setIntendedUse

public void setIntendedUse(java.lang.String intendedUse)
Not for use by a client application.

Parameters:
intendedUse - the intended use message

isEvaluation

public boolean isEvaluation()
Returns:
the evaluation

setEvaluation

public void setEvaluation(boolean evaluation)
Parameters:
evaluation - the evaluation to set