Packagecom.adobe.idp.um.api.infomodel
Interfacepublic interface Permission

A Permission object.



Packagecom.adobe.livecycle.rightsmanagement.client.infomodel
Interfacepublic interface Permission

The com.adobe.livecycle.rightsmanagement.client.infomodel.Permission interface defines the constants that represent the different types of policy permissions. The getName() method provides a way to retrieve the name of the type given the constant.

com.adobe.livecycle.rightsmanagement.client.infomodel.PolicyEntry objects require com.adobe.livecycle.rightsmanagement.client.infomodel.Permission objects as parameters when adding or removing permissions to policy entries.

See also

PolicyEntry


Public Methods
 MethodDefined By
  
String getDesc()
Retrieves the permission description.
Permission
  
String getName()
Retrieves the permission name.
Permission
  
String getOid()
Retrieves the permission identifier.
Permission
  
Retrieves the permission name resource type identifier.
Permission
  
boolean isDefault()
Determines whether this permission is a default permission for the associated resource type.
Permission
  
void setDefaultStatus(boolean isDefault)
Sets whether this permission is a default permission for the associated resource type.
Permission
  
void setDesc(String desc)
Sets the permission description.
Permission
  
void setName(String localizedPermissionName)
Sets the permission name.
Permission
  
void setOid(String oid)
Sets the permission identifier.
Permission
  
void setResourceTypeId(String resTypeId)
Sets the permission name resource type identifier.
Permission
Public Methods
 MethodDefined By
  
int getName()
Retrieves the type of the permission that this com.adobe.livecycle.rightsmanagement.client.infomodel.Permission object represents.
Permission
Public Constants
 ConstantDefined By
  ACCESSIBLE
[static] Represents the permission that enables screen reader devices for users that are visually impaired to access the text in documents.
Permission
  CHANGES_ALL_EXCEPT_EXTRACT_CONTENT
[static] Represents the permission that enables users to make any change to documents except extracting pages.
Permission
  CHANGES_COMMENTING_FORM_FILL_IN_AND_SIGNING
[static] Represents the permission that enables users to add comments to documents, fill in form objects, and sign documents.
Permission
  CHANGES_FORM_FILL_IN_AND_SIGNING
[static] Represents the permission that enables users to fill in form objects and sign documents.
Permission
  CHANGES_INSERT_DELETE_ROTATE_PAGES
[static] Represents the permission that enables users to insert, delete, and rotate the pages of documents.
Permission
  COPY
[static] Represents the permission that enables users to copy the contents of documents.
Permission
  OPEN_OFFLINE
[static] Represents the permission that enables users to open documents offline.
Permission
  OPEN_ONLINE
[static] Represents the permission that enables users to open documents online.
Permission
  POLICY_SWITCH
[static] Represents the permission that enables users to switch the policies that are protecting documents.
Permission
  PRINT_HIGH
[static] Represents the permission that allows high-resolution and low-resolution printing of documents.
Permission
  PRINT_LOW
[static] Represents the permission that allows only low-resolution printing of documents.
Permission
  REVOKE
[static] Represents the permission that enables users to revoke documents.
Permission
Method Detail
getDesc()
public String getDesc()

Retrieves the permission description.

Returns
The permission description.
getName() 
public String getName()

Retrieves the permission name. For example, PERM_DOC_CREATE is a permission name.

Returns
The permission name.
getOid() 
public String getOid()

Retrieves the permission identifier.

Returns
The permission identifier.
getResourceTypeId() 
public String getResourceTypeId()

Retrieves the permission name resource type identifier.

Returns
The permission name resource type identifier.
isDefault() 
public boolean isDefault()

Determines whether this permission is a default permission for the associated resource type. The default permission is automatically assigned to the default principals for the resource type's default access control list for the registered resource.

Returns
true if this permission is a default permission for the associated resource type, false otherwise.
setDefaultStatus() 
public void setDefaultStatus(boolean isDefault)

Sets whether this permission is a default permission for the associated resource type.

Parameters

isDefaulttrue if this permission is a default permission for the associated resource type, false otherwise.

setDesc() 
public void setDesc(String desc)

Sets the permission description.

Parameters

desc — The permission description.

setName() 
public void setName(String localizedPermissionName)

Sets the permission name.

Parameters

localizedPermissionName — The permission name.

setOid() 
public void setOid(String oid)

Sets the permission identifier.

Parameters

oid — The permission identifier.

setResourceTypeId() 
public void setResourceTypeId(String resTypeId)

Sets the permission name resource type identifier.

Parameters

resTypeId — The permission name resource type identifier.

Method Detail
getName()
public int getName()

Retrieves the type of the permission that this com.adobe.livecycle.rightsmanagement.client.infomodel.Permission object represents.

Returns
An integer whose value represents the permission type.
Constant Detail
ACCESSIBLEConstant
public static final ACCESSIBLE

Represents the permission that enables screen reader devices for users that are visually impaired to access the text in documents.

CHANGES_ALL_EXCEPT_EXTRACT_CONTENTConstant 
public static final CHANGES_ALL_EXCEPT_EXTRACT_CONTENT

Represents the permission that enables users to make any change to documents except extracting pages.

CHANGES_COMMENTING_FORM_FILL_IN_AND_SIGNINGConstant 
public static final CHANGES_COMMENTING_FORM_FILL_IN_AND_SIGNING

Represents the permission that enables users to add comments to documents, fill in form objects, and sign documents.

CHANGES_FORM_FILL_IN_AND_SIGNINGConstant 
public static final CHANGES_FORM_FILL_IN_AND_SIGNING

Represents the permission that enables users to fill in form objects and sign documents.

CHANGES_INSERT_DELETE_ROTATE_PAGESConstant 
public static final CHANGES_INSERT_DELETE_ROTATE_PAGES

Represents the permission that enables users to insert, delete, and rotate the pages of documents.

COPYConstant 
public static final COPY

Represents the permission that enables users to copy the contents of documents.

OPEN_OFFLINEConstant 
public static final OPEN_OFFLINE

Represents the permission that enables users to open documents offline.

OPEN_ONLINEConstant 
public static final OPEN_ONLINE

Represents the permission that enables users to open documents online.

POLICY_SWITCHConstant 
public static final POLICY_SWITCH

Represents the permission that enables users to switch the policies that are protecting documents.

PRINT_HIGHConstant 
public static final PRINT_HIGH

Represents the permission that allows high-resolution and low-resolution printing of documents.

PRINT_LOWConstant 
public static final PRINT_LOW

Represents the permission that allows only low-resolution printing of documents.

PRINT_HIGH also allows low-resolution printing.

REVOKEConstant 
public static final REVOKE

Represents the permission that enables users to revoke documents.





 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/livecycle/rightsmanagement/client/infomodel/Permission.html