com.adobe.livecycle.rightsmanagement.re
Class UsageRights

java.lang.Object
  com.adobe.livecycle.rightsmanagement.re.UsageRights

All Implemented Interfaces:

java.io.Serializable

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

Represents individual rights that can be applied to a rights-enabled PDF document. Rights-enabled PDF documents contain a usage rights dictionary. When Adobe Reader opens a document containing such a dictionary, it enables the usage rights specified in the dictionary for that document only. For information about the usage rights dictionary, see PDF Reference.

See Also:

Serialized Form

Constructor Summary

UsageRights()
Creates a new instance of a UsageRights object with all usage rights set to false.

Method Summary

boolean	isEnabledBarcodeDecoding() Specifies whether the enabledBarcodeDecoding right is set.
boolean	isEnabledComments() Specifies whether the enabledComments right is set.
boolean	isEnabledCommentsOnline() Specifies whether the enabledCommentsOnline right is set.
boolean	isEnabledDigitalSignatures() Specifies whether the enabledDigitalSignatures right is set.
boolean	isEnabledDynamicFormFields() Specifies whether the enabledDynamicFormFields right is set.
boolean	isEnabledDynamicFormPages() Specifies whether the enabledDynamicFormPages right is set.
boolean	isEnabledEmbeddedFiles() Specifies whether the enabledEmbeddedFiles right is set.
boolean	isEnabledFormDataImportExport() Specifies whether the enabledFormDataImportExport right is set.
boolean	isEnabledFormFillIn() Specifies whether the enabledFormFillIn right is set.
boolean	isEnabledOnlineForms() Specifies whether the enabledOnlineForms right is set.
boolean	isEnabledSubmitStandalone() Specifies whether the enabledSubmitStandalone right is set.
boolean	isLegacyEnableExportOnly()
boolean	isLegacyEnableImportOnly()
void	setEnabledBarcodeDecoding(boolean enabledBarcodeDecoding) Sets the value of the enabledBarcodeDecoding right.
void	setEnabledComments(boolean enabledComments) Sets the value of the enabledComments right.
void	setEnabledCommentsOnline(boolean enabledCommentsOnline) Sets the value of the enabledCommentsOnline right.
void	setEnabledDigitalSignatures(boolean enabledDigitalSignatures) Sets the value of the enabledDigitalSignatures right.
void	setEnabledDynamicFormFields(boolean enabledDynamicFormFields) Sets the enabledDynamicFormFields right.
void	setEnabledDynamicFormPages(boolean enabledDynamicFormPages) Sets the enabledDynamicFormPages right.
void	setEnabledEmbeddedFiles(boolean enabledEmbeddedFiles) Sets the enabledEmbeddedFiles right.
void	setEnabledFormDataImportExport(boolean enabledFormDataImportExport) Sets the enabledFormDataImportExport right.
void	setEnabledFormFillIn(boolean enabledFormFillIn) Sets the enabledFormFillIn right.
void	setEnabledOnlineForms(boolean enabledOnlineForms) Sets the enabledOnlineForms right.
void	setEnabledSubmitStandalone(boolean enabledSubmitStandalone) Sets the enabledSubmitStandalone right.
void	setLegacyEnableExportOnly(boolean legacyEnableExportOnly)
void	setLegacyEnableImportOnly(boolean legacyEnableImportOnly)
java.lang.String	toString() Converts this object to a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsageRights

public UsageRights()

Creates a new instance of a UsageRights object with all usage rights set to false.

Method Detail

toString

public java.lang.String toString()

Converts this object to a string.

Overrides:

toString in class java.lang.Object

Returns:

A string that represents defined usage rights.

isEnabledBarcodeDecoding

public boolean isEnabledBarcodeDecoding()

Specifies whether the enabledBarcodeDecoding right is set. If set, this method returns true. This right enables the PDF document to use barcoded forms within Adobe Reader.

Returns:

A Boolean value that specifies whether the enabledBarcodeDecoding right is set.

See Also:

enableBarcodeDecoding

setEnabledBarcodeDecoding

public void setEnabledBarcodeDecoding(boolean enabledBarcodeDecoding)

Sets the value of the enabledBarcodeDecoding right. This right enables the PDF document to use barcoded forms within Adobe Reader.

Parameters:

enabledBarcodeDecoding - A Boolean value that sets the the enabledBarcodeDecoding right.

See Also:

isEnabledBarcodeDecoding

isEnabledComments

public boolean isEnabledComments()

Specifies whether the enabledComments right is set. If set, this method returns true. When applied to a document, this right enables a user to add comments within Adobe Reader.

Returns:

A Boolean value that specifies whether the enabledComments right is set.

See Also:

enableComments

setEnabledComments

public void setEnabledComments(boolean enabledComments)

Sets the value of the enabledComments right. When applied to a document, this right enables a user to add comments within Adobe Reader.

Parameters:

enabledComments - A Boolean value that sets the the enabledComments right.

See Also:

isEnabledComments

isEnabledCommentsOnline

public boolean isEnabledCommentsOnline()

Specifies whether the enabledCommentsOnline right is set. If set, this method returns true. When applied to a document, this right enables a user to add comments within Adobe Reader while online.

Returns:

A Boolean value that specifies whether the enabledCommentsOnline right is set.

See Also:

enableCommentsOnline

setEnabledCommentsOnline

public void setEnabledCommentsOnline(boolean enabledCommentsOnline)

Sets the value of the enabledCommentsOnline right. When applied to a document, this right enables a user to add comments within Adobe Reader while online.

Parameters:

enabledCommentsOnline - A Boolean value that sets the enabledCommentsOnline right.

See Also:

isEnabledCommentsOnline

isEnabledDigitalSignatures

public boolean isEnabledDigitalSignatures()

Specifies whether the enabledDigitalSignatures right is set. If set, this method returns true. This right enables a user to sign a PDF document within Adobe Reader.

Returns:

A Boolean value that specifies whether the enabledDigitalSignatures right is set.

See Also:

enableDigitalSignatures

setEnabledDigitalSignatures

public void setEnabledDigitalSignatures(boolean enabledDigitalSignatures)

Sets the value of the enabledDigitalSignatures right. This right enables a user to sign a PDF document within Adobe Reader.

Parameters:

enabledDigitalSignatures - A Boolean value that sets the enabledDigitalSignatures right.

See Also:

isEnabledDigitalSignatures

isEnabledDynamicFormFields

public boolean isEnabledDynamicFormFields()

Specifies whether the enabledDynamicFormFields right is set. If set, this method returns true. When applied to a document, this right enables a user to work with dynamic form fields within Adobe Reader.

Returns:

A Boolean value that specifies whether the enabledDynamicFormFields right is set.

See Also:

enableDynamicFormFields

setEnabledDynamicFormFields

public void setEnabledDynamicFormFields(boolean enabledDynamicFormFields)

Sets the enabledDynamicFormFields right. When applied to a document, this right enables a user to work with dynamic form fields within Adobe Reader.

Parameters:

enabledDynamicFormFields - A Boolean value that sets the enabledDynamicFormFields right.

See Also:

isEnabledDynamicFormFields

isEnabledDynamicFormPages

public boolean isEnabledDynamicFormPages()

Specifies whether the enabledDynamicFormPages right is set.

Returns:

A Boolean value that specifies whether the enabledDynamicFormPages right is set.

setEnabledDynamicFormPages

public void setEnabledDynamicFormPages(boolean enabledDynamicFormPages)

Sets the enabledDynamicFormPages right.

Parameters:

enabledDynamicFormPages - A Boolean value that sets the enabledDynamicFormPages right.

isEnabledEmbeddedFiles

public boolean isEnabledEmbeddedFiles()

Specifies whether the enabledEmbeddedFiles right is set. If set, this method returns true. When applied to a document, this right enables a user to attach file attachments to a PDF document within Adobe Reader.

Returns:

A Boolean value that specifies whether the enabledEmbeddedFiles right is set.

setEnabledEmbeddedFiles

public void setEnabledEmbeddedFiles(boolean enabledEmbeddedFiles)

Sets the enabledEmbeddedFiles right. When applied to a document, this right enables a user to attach file attachments to a PDF document within Adobe Reader.

Parameters:

enabledEmbeddedFiles - A Boolean value that sets the enabledEmbeddedFiles right.

isEnabledFormDataImportExport

public boolean isEnabledFormDataImportExport()

Specifies whether the enabledFormDataImportExport right is set. If set, this method returns true. When applied to a document, this right enables a user to import and export form data from a PDF document from within Adobe Reader.

Returns:

A Boolean value that specifies whether the enabledFormDataImportExport right is set.

setEnabledFormDataImportExport

public void setEnabledFormDataImportExport(boolean enabledFormDataImportExport)

Sets the enabledFormDataImportExport right. When applied to a document, this right enables a user to import and export form data from a PDF document from within Adobe Reader.

Parameters:

enabledFormDataImportExport - A Boolean value that sets the enabledFormDataImportExport right.

isEnabledFormFillIn

public boolean isEnabledFormFillIn()

Specifies whether the enabledFormFillIn right is set. If set, this method returns true. When applied to a document, this right enables a user to fill in form fields and save the PDF document from within Adobe Reader.

Returns:

A Boolean value that specifies whether the ode>enabledFormFillIn right is set.

setEnabledFormFillIn

public void setEnabledFormFillIn(boolean enabledFormFillIn)

Sets the enabledFormFillIn right. When applied to a document, this right enables a user to fill in form fields and save the PDF document from within Adobe Reader.

Parameters:

enabledFormFillIn - A Boolean value that specifies whether the enabledFormFillIn right is set.

isEnabledOnlineForms

public boolean isEnabledOnlineForms()

Specifies whether the enabledOnlineForms right is set. If set, this method returns true. When applied to a document, this right enables a user to interact with a form while online.

Returns:

A Boolean value that specifies whether the enabledOnlineForms right is set.

setEnabledOnlineForms

public void setEnabledOnlineForms(boolean enabledOnlineForms)

Sets the enabledOnlineForms right. When applied to a document, this right enables a user to interact with a form while online.

Parameters:

enabledOnlineForms - A Boolean value that specifies whether the enabledOnlineForms right is set.

isEnabledSubmitStandalone

public boolean isEnabledSubmitStandalone()

Specifies whether the enabledSubmitStandalone right is set. If set, this method returns true. When applied to a document, this right enables a user to submit information from a form within Adobe Reader.

Returns:

A Boolean value that specifies whether the enabledSubmitStandalone right is set.

setEnabledSubmitStandalone

public void setEnabledSubmitStandalone(boolean enabledSubmitStandalone)

Sets the enabledSubmitStandalone right. When applied to a document, this right enables a user to submit information from a form within Adobe Reader.

Parameters:

enabledSubmitStandalone - A Boolean value that specifies whether the enabledSubmitStandalone right is set.

isLegacyEnableImportOnly

public boolean isLegacyEnableImportOnly()

Returns:

the legacyEnableImportOnly

setLegacyEnableImportOnly

public void setLegacyEnableImportOnly(boolean legacyEnableImportOnly)

Parameters:

legacyEnableImportOnly - the legacyEnableImportOnly to set

isLegacyEnableExportOnly

public boolean isLegacyEnableExportOnly()

Returns:

the legacyEnableExportOnly

setLegacyEnableExportOnly

public void setLegacyEnableExportOnly(boolean legacyEnableExportOnly)

Parameters:

legacyEnableExportOnly - the legacyEnableExportOnly to set