AllPDFPermissions (Qoppa jPDFNotes API)

java.lang.Object
- com.qoppa.pdf.permissions.AllPDFPermissions

```
public class AllPDFPermissions
extends Object
```
This class encompasses all of the document's permissions including Password permissions, DocMDP permissions, Signature, and Usage Rights permissions. It has methods to check if an operation is allowed to be performed by all the document's permissions. It can also return a Restrictions object that contains information about which type of permission is restricting an operation.

Author:

Qoppa Software

Constructor Summary

Constructors
Constructor and Description
`AllPDFPermissions(PasswordPermissions passwordPermissions, DocMDPPermissions docMDPPermissions, UsageRightsPermissions usageRightsPermissions, SignaturePermissions signaturePermissions)` Construct a new AllPDFPermissions object that encompasses PasswordPermissions, DocMDPPermissions, and UsageRightsPermissions.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Restrictions`	`getAssembleDocumentRestrictions(boolean checkOwnerPassword)` Returns a new Restrictions object that contains information about which type of Permission restricts assembling the document:
`Restrictions`	`getChangeDocumentRestrictions(boolean checkOwnerPassword)` Returns a new Restrictions object that contains information about which type of Permission restricts changing the document:
`DocMDPPermissions`	`getDocMDPPermissions()` Returns the Document Modification Detection and Prevention permissions.
`Restrictions`	`getExtractTextGraphicsForAccessibilityRestrictions(boolean checkOwnerPassword)` Returns a new Restrictions object that contains information about which type of Permission restricts extracting text graphics for accessibility:
`Restrictions`	`getExtractTextGraphicsRestrictions(boolean checkOwnerPassword)` Returns a new Restrictions object that contains information about which type of Permission restricts extracting text graphics:
`Restrictions`	`getFillFormFieldsRestrictions(boolean checkOwnerPassword)` Returns a new Restrictions object that contains information about which type of Permission restricts filling form fields:
`Restrictions`	`getModifyAnnotsRestrictions(boolean checkOwnerPassword)` Returns a new Restrictions object that contains information about which type of Permission restricts modifying annotations:
`PasswordPermissions`	`getPasswordPermissions()` Returns the permission object for this document.
`Restrictions`	`getPrintHighResRestrictions(boolean checkOwnerPassword)` Returns a new Restrictions object that contains information about which type of Permission restricts printing the document at high resolution:
`Restrictions`	`getPrintRestrictions(boolean checkOwnerPassword)` Returns a new Restrictions object that contains information about which type of Permission restricts printing the document:
`SignaturePermissions`	`getSignaturePermissions()` Returns permissions related to a digital signature.
`UsageRightsPermissions`	`getUsageRightsPermissions()` Returns the Usage Rights permissions.
`boolean`	`isAssembleDocumentAllowed(boolean checkOwnerPassword)` Returns true if all the document's permissions allow assembling the document:
`boolean`	`isChangeDocumentAllowed(boolean checkOwnerPassword)` Returns true if all the document's permissions allow changing the document.
`boolean`	`isCreateModifyFieldsAllowed(boolean checkOwnerPassword)` Returns true if all the document's permissions allow modifying annotations and changing the document.
`static boolean`	`isEnforceDocMDPPermissions()` Returns true if Doc MDP permissions will be enforced.
`static boolean`	`isEnforceSignaturePermissions()` Returns true if signature permissions will be enforced.
`boolean`	`isExtractTextGraphicsAllowed(boolean checkOwnerPassword)` Returns true if all the document's permissions allow extracting text graphics from the document.
`boolean`	`isExtractTextGraphicsForAccessibilityAllowed(boolean checkOwnerPassword)` Returns true if all the document's permissions allow extracting text graphics for accessibility from the document.
`boolean`	`isFillFormFieldsAllowed(boolean checkOwnerPassword)` Returns true if all the document's permissions allow filling form field.
`boolean`	`isModifyAnnotsAllowed(boolean checkOwnerPassword)` Returns true if all the document's permissions allow modifying annotations.
`boolean`	`isPrintAllowed(boolean checkOwnerPassword)` Returns true if all the document's permissions allow printing the document.
`boolean`	`isPrintHighResAllowed(boolean checkOwnerPassword)` Returns true if all the document's permissions allow printing the document at high resolution.
`static void`	`setEnforceDocMDPPermissions(boolean enforce)` Sets the flag to enforce or ignore DocMDP permissions.
`static void`	`setEnforceSignaturePermissions(boolean enforce)` Sets the flag to enforce or ignore signature permissions.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AllPDFPermissions
```
public AllPDFPermissions(PasswordPermissions passwordPermissions,
                         DocMDPPermissions docMDPPermissions,
                         UsageRightsPermissions usageRightsPermissions,
                         SignaturePermissions signaturePermissions)
```
    Construct a new AllPDFPermissions object that encompasses PasswordPermissions, DocMDPPermissions, and UsageRightsPermissions.
    
    Parameters:
    
    passwordPermissions - The password permissions.
    
    docMDPPermissions - The DocMDP permissions.
    
    usageRightsPermissions - The usage rights permissions.
    
    signaturePermissions - The signature permissions.
- Method Detail
  - isAssembleDocumentAllowed
```
public boolean isAssembleDocumentAllowed(boolean checkOwnerPassword)
```
    Returns true if all the document's permissions allow assembling the document:
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Permission to assemble the document.
  - isChangeDocumentAllowed
```
public boolean isChangeDocumentAllowed(boolean checkOwnerPassword)
```
    Returns true if all the document's permissions allow changing the document.
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Permission to change the document.
  - isCreateModifyFieldsAllowed
```
public boolean isCreateModifyFieldsAllowed(boolean checkOwnerPassword)
```
    Returns true if all the document's permissions allow modifying annotations and changing the document.
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Permission to change the document.
  - isExtractTextGraphicsAllowed
```
public boolean isExtractTextGraphicsAllowed(boolean checkOwnerPassword)
```
    Returns true if all the document's permissions allow extracting text graphics from the document.
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Permission to extract text graphics from the document.
  - isExtractTextGraphicsForAccessibilityAllowed
```
public boolean isExtractTextGraphicsForAccessibilityAllowed(boolean checkOwnerPassword)
```
    Returns true if all the document's permissions allow extracting text graphics for accessibility from the document.
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Permission to extract text graphics for accessibility.
  - isFillFormFieldsAllowed
```
public boolean isFillFormFieldsAllowed(boolean checkOwnerPassword)
```
    Returns true if all the document's permissions allow filling form field.
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Permission to fill form fields.
  - isModifyAnnotsAllowed
```
public boolean isModifyAnnotsAllowed(boolean checkOwnerPassword)
```
    Returns true if all the document's permissions allow modifying annotations.
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Permission to modify annotations.
  - isPrintAllowed
```
public boolean isPrintAllowed(boolean checkOwnerPassword)
```
    Returns true if all the document's permissions allow printing the document.
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Permission to print the document.
  - isPrintHighResAllowed
```
public boolean isPrintHighResAllowed(boolean checkOwnerPassword)
```
    Returns true if all the document's permissions allow printing the document at high resolution.
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Permission to print the document at high resolution.
  - getAssembleDocumentRestrictions
```
public Restrictions getAssembleDocumentRestrictions(boolean checkOwnerPassword)
```
    Returns a new Restrictions object that contains information about which type of Permission restricts assembling the document:
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Restrictions for assembling the document.
  - getChangeDocumentRestrictions
```
public Restrictions getChangeDocumentRestrictions(boolean checkOwnerPassword)
```
    Returns a new Restrictions object that contains information about which type of Permission restricts changing the document:
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Restrictions for changing the document.
  - getExtractTextGraphicsRestrictions
```
public Restrictions getExtractTextGraphicsRestrictions(boolean checkOwnerPassword)
```
    Returns a new Restrictions object that contains information about which type of Permission restricts extracting text graphics:
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Restrictions for extracting text graphics.
  - getExtractTextGraphicsForAccessibilityRestrictions
```
public Restrictions getExtractTextGraphicsForAccessibilityRestrictions(boolean checkOwnerPassword)
```
    Returns a new Restrictions object that contains information about which type of Permission restricts extracting text graphics for accessibility:
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Restrictions for extracting text graphics for accessibility.
  - getFillFormFieldsRestrictions
```
public Restrictions getFillFormFieldsRestrictions(boolean checkOwnerPassword)
```
    Returns a new Restrictions object that contains information about which type of Permission restricts filling form fields:
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Restrictions for filling form fields.
  - getModifyAnnotsRestrictions
```
public Restrictions getModifyAnnotsRestrictions(boolean checkOwnerPassword)
```
    Returns a new Restrictions object that contains information about which type of Permission restricts modifying annotations:
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Restrictions for modifying annotations.
  - getPrintRestrictions
```
public Restrictions getPrintRestrictions(boolean checkOwnerPassword)
```
    Returns a new Restrictions object that contains information about which type of Permission restricts printing the document:
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Restrictions for printing the document.
  - getPrintHighResRestrictions
```
public Restrictions getPrintHighResRestrictions(boolean checkOwnerPassword)
```
    Returns a new Restrictions object that contains information about which type of Permission restricts printing the document at high resolution:
    
    Parameters:
    
    checkOwnerPassword - Set to true to check the owner password. If this is true and the owner's password has been entered, then this permission will be allowed by PasswordPermissions. However, this permission could still be restricted by other permission types.
    
    Returns:
    
    Restrictions for printing the document at high resolution.
  - getPasswordPermissions
```
public PasswordPermissions getPasswordPermissions()
```
    Returns the permission object for this document. A new permissions object with all permissions is returned if the document is not encrypted.
    
    Returns:
    
    The permission object.
  - getDocMDPPermissions
```
public DocMDPPermissions getDocMDPPermissions()
```
    Returns the Document Modification Detection and Prevention permissions. May be null.
    
    Returns:
    
    DocMDP permissions, may be null.
  - getUsageRightsPermissions
```
public UsageRightsPermissions getUsageRightsPermissions()
```
    Returns the Usage Rights permissions. May be null.
    
    Returns:
    
    Usage Rights permissions, may be null.
  - getSignaturePermissions
```
public SignaturePermissions getSignaturePermissions()
```
    Returns permissions related to a digital signature. May be null.
    
    Returns:
    
    Signature permissions, may be null.
  - setEnforceSignaturePermissions
```
public static void setEnforceSignaturePermissions(boolean enforce)
```
    Sets the flag to enforce or ignore signature permissions. When set to true, documents that are signed will have restrictions on document assembly and changing the document. When set to false, signatures will not restrict document actions. The default value is true. Note that enforcing signature permissions prevents users from making any changes to signed documents that could invalidate digital signatures present on the document. When a document is signed, it is recommended to clear signature before manipulating it, then apply new signature(s) on the modified document. Only set this flag to false in a controlled environment where signed PDF documents need to be manipulated with the risk of invalidating digital signatures.
    
    Parameters:
    
    enforce - Set to true to enforce signature permissions or false to ignore them. The default value is true.
  - isEnforceSignaturePermissions
```
public static boolean isEnforceSignaturePermissions()
```
    Returns true if signature permissions will be enforced.
    
    Returns:
    
    true if signature permissions will be enforced.
  - setEnforceDocMDPPermissions
```
public static void setEnforceDocMDPPermissions(boolean enforce)
```
    Sets the flag to enforce or ignore DocMDP permissions. When set to true, documents that are certified will have restrictions according to their permissions flag. When set to false, certifying signatures will not restrict document actions. The default value is true. Note that enforcing Doc MDP permissions prevents users from making any changes to signed documents that could invalidate certifying signatures present on the document. When a document is certified, it is recommended to clear signature before manipulating it, then apply new signature(s) on the modified document. Only set this flag to false in a controlled environment where certified PDF documents need to be manipulated with the risk of invalidating certifying signatures.
    
    Parameters:
    
    enforce - Set to true to enforce Doc MDP permissions or false to ignore them. The default value is true.
  - isEnforceDocMDPPermissions
```
public static boolean isEnforceDocMDPPermissions()
```
    Returns true if Doc MDP permissions will be enforced.
    
    Returns:
    
    true if Doc MDP permissions will be enforced.

Class AllPDFPermissions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AllPDFPermissions

Method Detail

isAssembleDocumentAllowed

isChangeDocumentAllowed

isCreateModifyFieldsAllowed

isExtractTextGraphicsAllowed

isExtractTextGraphicsForAccessibilityAllowed

isFillFormFieldsAllowed

isModifyAnnotsAllowed

isPrintAllowed

isPrintHighResAllowed

getAssembleDocumentRestrictions

getChangeDocumentRestrictions

getExtractTextGraphicsRestrictions

getExtractTextGraphicsForAccessibilityRestrictions

getFillFormFieldsRestrictions

getModifyAnnotsRestrictions

getPrintRestrictions

getPrintHighResRestrictions

getPasswordPermissions

getDocMDPPermissions

getUsageRightsPermissions

getSignaturePermissions

setEnforceSignaturePermissions

isEnforceSignaturePermissions

setEnforceDocMDPPermissions

isEnforceDocMDPPermissions