com.adobe.livecycle.contentservices.client.impl
Class ContentAccessPermission

java.lang.Object
  com.adobe.livecycle.contentservices.client.impl.ContentAccessPermission

All Implemented Interfaces:

java.io.Serializable

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

Represents a permission that can be set for a Content Services ES2 node. Setting permissions enable you to control the ability of users to perform tasks on content. For example, you can set a permission that results in users not being able to delete content. To view a list of permissions, see the Setting Content Services ES Permissions topic in Programming with LiveCycle ES4.

To see an object of this type used in a code example, see the Setting Content Services ES Permissions using the Java API quick start in Programming with LiveCycle ES4.

See Also:

Serialized Form

Constructor Summary

ContentAccessPermission()
A constructor that creates a ContentAccessPermission object.

Method Summary

boolean	equals(java.lang.Object o) For internal use only.
java.lang.String	getAuthority() Returns the authority that is associated with this permission.
java.lang.String	getAuthorityType() Returns the authority type that is associated with this permission.
java.lang.Boolean	getIsAllowed() Returns the value of the isallowed option.
java.lang.String	getPermission() Returns the permission associated with this object.
int	hashCode() For internal use only.
void	setAuthority(java.lang.String authority) Sets the authority that is associated with this permission.
void	setAuthorityType(java.lang.String authorityType) Sets the authority type that is associated with this permission.
void	setIsAllowed(java.lang.Boolean isAllowed) Returns the value of the isallowed option.
void	setPermission(java.lang.String permission) Sets the permission associated with this object.
java.lang.String	toString() For internal use only.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ContentAccessPermission

public ContentAccessPermission()

A constructor that creates a ContentAccessPermission object.

Method Detail

getAuthority

public java.lang.String getAuthority()

Returns the authority that is associated with this permission. An authority defines the user or group to which the permission applies.

Returns:

A string value that represents the authority that is associated with this permission.

setAuthority

public void setAuthority(java.lang.String authority)

Sets the authority that is associated with this permission. An authority defines the user or group to which the permission applies.

To see this method used in a code example, see the Setting Content Services ES Permissions using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

authority - A string value that represents the authority that is associated with this permission.

getAuthorityType

public java.lang.String getAuthorityType()

Returns the authority type that is associated with this permission.

Returns:

A string value that represents the authority type that is associated with this permission.

setAuthorityType

public void setAuthorityType(java.lang.String authorityType)

Sets the authority type that is associated with this permission.

Parameters:

authorityType - A string value that represents the authority type that is associated with this permission.

getPermission

public java.lang.String getPermission()

Returns the permission associated with this object.

Returns:

A string value that represents the permission that is associated with this object.

setPermission

public void setPermission(java.lang.String permission)

Sets the permission associated with this object. Specify one of the following values:

• Coordinator
• Collaborator
• Contributor
• Editor
• Consumer

To see this method used in a code example, see the Setting Content Services ES Permissions using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

permission - A string value that represents the permission that is associated with this object.

getIsAllowed

public java.lang.Boolean getIsAllowed()

Returns the value of the isallowed option. This value indicates whether the specified users or groups have the selected usage permissions for the folder or content. A value of true indicates that all the specified users or groups have the permission to use the folder or content. A value of false indicates that all the specified users or groups do not have the permission to use the folder or content.

Returns:

A Boolean value that specifies the value of the isallowed option.

setIsAllowed

public void setIsAllowed(java.lang.Boolean isAllowed)

Returns the value of the isallowed option. This value indicates whether the specified users or groups have the selected usage permissions for the folder or content. A value of true indicates that all the specified users or groups have the permission to use the folder or content. A value of false indicates that all the specified users or groups do not have the permission to use the folder or content.

To see this method used in a code example, see the Setting Content Services ES Permissions using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

isAllowed - A Boolean value that specifies the value of the isallowed option.

equals

public boolean equals(java.lang.Object o)

For internal use only. Overrides the standard equal method.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

For internal use only. Overrides the standard toString method.

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

For internal use only.

Overrides:

hashCode in class java.lang.Object