com.adobe.idp.um.api.infomodel
Interface Permission

public interface Permission

Represents a permission that a LiveCycle ES2 user or group has.

Method Summary

java.lang.String	getDesc() Retrieves the permission description.
java.lang.String	getName() Retrieves the permission name.
java.lang.String	getOid() Retrieves the permission identifier.
java.lang.String	getResourceTypeId() Retrieves the permission name resource type identifier.
boolean	isDefault() Determines whether this permission is a default permission for the associated resource type.
void	setDefaultStatus(boolean isDefault) Sets whether this permission is a default permission for the associated resource type.
void	setDesc(java.lang.String desc) Sets the permission description.
void	setName(java.lang.String localizedPermissionName) Sets the permission name.
void	setOid(java.lang.String oid) Sets the permission identifier.
void	setResourceTypeId(java.lang.String resTypeId) Sets the permission name resource type identifier.

Method Detail

getOid

java.lang.String getOid()

Retrieves the permission identifier.

Returns:

The permission identifier.

setOid

void setOid(java.lang.String oid)

Sets the permission identifier.

Parameters:

oid - The permission identifier.

getName

java.lang.String getName()

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

Returns:

A string value that represents the permission name.

setName

void setName(java.lang.String localizedPermissionName)

Sets the permission name.

Parameters:

localizedPermissionName - A string value that represents the permission name.

getResourceTypeId

java.lang.String getResourceTypeId()

Retrieves the permission name resource type identifier.

Returns:

The permission name resource type identifier.

setResourceTypeId

void setResourceTypeId(java.lang.String resTypeId)

Sets the permission name resource type identifier.

Parameters:

resTypeId - The permission name resource type identifier.

getDesc

java.lang.String getDesc()

Retrieves the permission description.

Returns:

The permission description.

setDesc

void setDesc(java.lang.String desc)

Sets the permission description.

Parameters:

desc - The permission description.

isDefault

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:

The value true if this permission is a default permission for the associated resource type, false otherwise.

setDefaultStatus

void setDefaultStatus(boolean isDefault)

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

Parameters:

isDefault - true if this permission is a default permission for the associated resource type, false otherwise.