com.adobe.livecycle.rightsmanagement.client.infomodel
Interface PolicySet


public interface PolicySet

The PolicySet interface provides methods for creating and manipulating policy sets.

Policies can also have one or more of the following properties defined:


Method Summary
 java.util.ArrayList getCoordinatorAndPerms()
          retrieves the co-ordinators and their permissions for the policy set
 java.util.Date getCreationTime()
          retrieves the creation time of the policy set
 java.lang.String getDescription()
          retrieves the description for the policy set
 java.lang.String getId()
          Retrieves the identification value of the policy set.
 java.util.Date getModifyTime()
          retrieves the modification time of the policy set
 java.lang.String getName()
          retrieves the name of the policy set
 java.util.List getPolicyList()
          retrieves the policies for the policy set
 java.util.ArrayList getPublisherIds()
          retrieves the publisher ids for the policy set
 java.util.ArrayList getVisibleUserGroupIds()
          retrieves the visible users and group ids for the policy set
 void setCoordinatorAndPerms(java.util.ArrayList coordinatorAndPermsList)
          Sets the co-ordinators and their permissions for the policy set
 void setCreationTime(java.util.Date creationTime)
          Sets the creation time for the policy set
 void setDescription(java.lang.String description)
          Sets the description for the policy set
 void setId(java.lang.String value)
          Sets the id of the policy set
 void setModifyTime(java.util.Date modifyTime)
          Sets the modify time for the policy set
 void setName(java.lang.String name)
          Sets the name for the policy set
 void setPolicyList(java.util.List policyList)
          Sets the policies for the policy set
 void setPublisherIds(java.util.ArrayList publisherIds)
          Sets the publisher ids for the policy set
 void setVisibleUserGroupIds(java.util.ArrayList visibleUserGroupIds)
          Sets the visible users and group ids for the policy set
 

Method Detail

getId

java.lang.String getId()
Retrieves the identification value of the policy set.

Returns:
A java.lang.String that specifies the identification value of the policy set and null if this Policy Set object represents a policy set not yet registered with the Rights Management service.

setId

void setId(java.lang.String value)
Sets the id of the policy set

Parameters:
A - java.lang.String that specifies the identification value of the policy set. This is not to be used in normal scenarios as id is set internally after the policy set is registered with the Rights Management service.

getPublisherIds

java.util.ArrayList getPublisherIds()
retrieves the publisher ids for the policy set

Returns:
Returns the publisherIds.

setPublisherIds

void setPublisherIds(java.util.ArrayList publisherIds)
Sets the publisher ids for the policy set

Parameters:
publisherIds - The publisherIds to set.

getDescription

java.lang.String getDescription()
retrieves the description for the policy set

Returns:
Returns the description.

setDescription

void setDescription(java.lang.String description)
Sets the description for the policy set

Parameters:
description - The description to set.

getName

java.lang.String getName()
retrieves the name of the policy set

Returns:
Returns the name.

setName

void setName(java.lang.String name)
Sets the name for the policy set

Parameters:
name - The name to set.

getCreationTime

java.util.Date getCreationTime()
retrieves the creation time of the policy set

Returns:
Returns the creationTime.

setCreationTime

void setCreationTime(java.util.Date creationTime)
Sets the creation time for the policy set

Parameters:
creationTime - The creationTime to set.

getModifyTime

java.util.Date getModifyTime()
retrieves the modification time of the policy set

Returns:
Returns the modifyTime.

setModifyTime

void setModifyTime(java.util.Date modifyTime)
Sets the modify time for the policy set

Parameters:
modifyTime - The modifyTime to set.

getVisibleUserGroupIds

java.util.ArrayList getVisibleUserGroupIds()
retrieves the visible users and group ids for the policy set

Returns:
Returns the VisibleUserGroupIds.

setVisibleUserGroupIds

void setVisibleUserGroupIds(java.util.ArrayList visibleUserGroupIds)
Sets the visible users and group ids for the policy set

Parameters:
VisibleUserGroupIds - The VisibleUserGroupIds to set.

setCoordinatorAndPerms

void setCoordinatorAndPerms(java.util.ArrayList coordinatorAndPermsList)
Sets the co-ordinators and their permissions for the policy set

Parameters:
coordinatorAndPermsList - The CoordinatorAndPerms to set.

getCoordinatorAndPerms

java.util.ArrayList getCoordinatorAndPerms()
retrieves the co-ordinators and their permissions for the policy set

Returns:
Returns the CoordinatorAndPermsList.

getPolicyList

java.util.List getPolicyList()
retrieves the policies for the policy set

Returns:
the policyList

setPolicyList

void setPolicyList(java.util.List policyList)
Sets the policies for the policy set

Parameters:
policyList - the policyList to set