com.adobe.livecycle.rightsmanagement
Class RMInspectResult

java.lang.Object
  com.adobe.livecycle.rightsmanagement.RMInspectResult

All Implemented Interfaces:

java.io.Serializable

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

Provides information about a policy-protected document. An object of this type is returned by the DocumentManager object's inspectDocument method. To see an object of this type used in a code example, see the Inspecting policy protected PDF documents using the Java API quick start in Programming with Adobe Experience Manager Forms.

See Also:

Serialized Form

Constructor Summary

RMInspectResult()
Do not call this constructor - this object is returned by the DocumentManager object's inspectDocument method.

Method Summary

java.lang.String	getAlternateLicenseId() Returns the identifier value of the alternate license for the policy-protected document.
java.lang.String	getDocName() Returns the name of the policy-protected document.
java.lang.String	getLicenseId() Returns the identifier value of the license used to protect the document.
java.lang.String	getLicenseIssuingAuthority() Returns the identifier value of the license issuing authority.
java.lang.String	getPolicyId() Returns the identifier value of the policy used to protect the document.
java.lang.String	getPolicyName() Returns the name of the policy used to protect the document.
java.lang.String	getPolicySetId() Returns the identifier value of the policy set to which the policy belongs.
java.lang.String	getPolicySetName() Returns the name of the policy set to which the policy belongs.
java.lang.String	getPolicyType() Returns the type of the policy used to protect the document.
java.lang.String	getPublisherId() Returns the identifier value of the User Manager user who is the document publisher.
java.lang.String	getPublisherName() Returns the name of the publisher of the policy-protected document.
java.util.Date	getPublishTime() Returns the published time of the policy-protected document.
java.lang.String	getRevokeURL() Returns the revocation URL value that is used if the policy-protected document is revoked.
void	setAlternateLicenseId(java.lang.String licenseAlternateId) For internal purposes only.
void	setDocName(java.lang.String docName) For internal purposes only.
void	setLicenseId(java.lang.String licenseId) For internal purposes only.
void	setLicenseIssuingAuthority(java.lang.String licenseIssuingAuthority) For internal purposes only.
void	setPolicyId(java.lang.String policyId) For internal purposes only.
void	setPolicyName(java.lang.String policyName) For internal purposes only.
void	setPolicySetId(java.lang.String policySetId) For internal purposes only.
void	setPolicySetName(java.lang.String policySetName) For internal purposes only.
void	setPolicyType(java.lang.String policyType) For internal purposes only.
void	setPublisherId(java.lang.String publisherId) For internal purposes only.
void	setPublisherName(java.lang.String publisherName) For internal purposes only.
void	setPublishTime(java.util.Date publishTime) For internal purposes only.
void	setRevokeURL(java.lang.String revokeURL) For internal purposes only.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RMInspectResult

public RMInspectResult()

Do not call this constructor - this object is returned by the DocumentManager object's inspectDocument method.

Method Detail

getDocName

public java.lang.String getDocName()

Returns the name of the policy-protected document. To see this method used in a code example, see the Inspecting policy protected PDF documents using the Java API quick start in Programming with Adobe Experience Manager Forms.

Returns:

A string value that specifies the name of the policy protected document.

setDocName

public void setDocName(java.lang.String docName)

For internal purposes only. Do not invoke this method.

getPublisherName

public java.lang.String getPublisherName()

Returns the name of the publisher of the policy-protected document. For example, if a Adobe Experience Manager Forms administrator is used to protect the document, this method returns Super Admin. To see this method used in a code example, see the Inspecting policy protected PDF documents using the Java API quick start in Programming with Adobe Experience Manager Forms.

Returns:

A string value that specifies the name of the publisher.

setPublisherName

public void setPublisherName(java.lang.String publisherName)

For internal purposes only. Do not invoke this method.

getPublishTime

public java.util.Date getPublishTime()

Returns the published time of the policy-protected document.

Returns:

A java.util.Date instance that specifies the time when the policy-protected document was published.

setPublishTime

public void setPublishTime(java.util.Date publishTime)

For internal purposes only. Do not invoke this method.

getPolicyName

public java.lang.String getPolicyName()

Returns the name of the policy used to protect the document. To see this method used in a code example, see the Inspecting policy protected PDF documents using the Java API quick start in Programming with Adobe Experience Manager Forms.

Returns:

A string value that specifies the name of the policy used to protect the document.

setPolicyName

public void setPolicyName(java.lang.String policyName)

For internal purposes only. Do not invoke this method.

getPolicyType

public java.lang.String getPolicyType()

Returns the type of the policy used to protect the document. Policies can be user policies or organizational policies.

Returns:

A string value that specifies the type of the policy used to protect the document.

setPolicyType

public void setPolicyType(java.lang.String policyType)

For internal purposes only. Do not invoke this method.

getPolicyId

public java.lang.String getPolicyId()

Returns the identifier value of the policy used to protect the document.

Returns:

A string value that specifies the identifier value of the policy used to protect the document.

setPolicyId

public void setPolicyId(java.lang.String policyId)

For internal purposes only. Do not invoke this method.

getLicenseId

public java.lang.String getLicenseId()

Returns the identifier value of the license used to protect the document.

Returns:

A string value that specifies the identifier value of the license used to protect the document.

setLicenseId

public void setLicenseId(java.lang.String licenseId)

For internal purposes only. Do not invoke this method.

getRevokeURL

public java.lang.String getRevokeURL()

Returns the revocation URL value that is used if the policy-protected document is revoked. A revocation URL is used to redirect a user to another location when they attempt to open a revoked document. To view a code example that revokes a policy-protected document, see the Revoking a document using the Java API quick start in Programming with Adobe Experience Manager Forms.

Returns:

A string value that specifies the the revocation URL value.

setRevokeURL

public void setRevokeURL(java.lang.String revokeURL)

For internal purposes only. Do not invoke this method.

getPublisherId

public java.lang.String getPublisherId()

Returns the identifier value of the User Manager user who is the document publisher.

Returns:

A string value that specifies the identifier value of the document publisher.

setPublisherId

public void setPublisherId(java.lang.String publisherId)

For internal purposes only. Do not invoke this method.

getLicenseIssuingAuthority

public java.lang.String getLicenseIssuingAuthority()

Returns the identifier value of the license issuing authority.

Returns:

A string value that specifies the identifier value of the document publisher.

setLicenseIssuingAuthority

public void setLicenseIssuingAuthority(java.lang.String licenseIssuingAuthority)

For internal purposes only. Do not invoke this method.

getAlternateLicenseId

public java.lang.String getAlternateLicenseId()

Returns the identifier value of the alternate license for the policy-protected document.

Returns:

A string value that specifies the identifier value of the alternate license for the policy-protected document.

setAlternateLicenseId

public void setAlternateLicenseId(java.lang.String licenseAlternateId)

For internal purposes only. Do not invoke this method.

getPolicySetId

public java.lang.String getPolicySetId()

Returns the identifier value of the policy set to which the policy belongs.

Returns:

A string value that specifies the identifier value of the policy set.

setPolicySetId

public void setPolicySetId(java.lang.String policySetId)

For internal purposes only. Do not invoke this method.

getPolicySetName

public java.lang.String getPolicySetName()

Returns the name of the policy set to which the policy belongs.

Returns:

A string value that specifies the name of the policy set.

setPolicySetName

public void setPolicySetName(java.lang.String policySetName)

For internal purposes only. Do not invoke this method.