com.waveset.object
Class Role

java.lang.Object
  extended by com.waveset.object.PersistentObject
      extended by com.waveset.object.Service
          extended by com.waveset.object.Role
All Implemented Interfaces:
com.waveset.object.AttributeBag, XmlObject, java.lang.Comparable, javax.naming.Referenceable

public class Role
extends Service
implements java.lang.Comparable

An object defining a collection of services (resources, applications, and other roles) to be assigned to a user.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.waveset.object.PersistentObject
PersistentObject.Comparator, PersistentObject.InitialInstance
 
Field Summary
static java.lang.String code_id
           
static java.lang.String EL_AUTHENTICATOR
           
static java.lang.String EL_RESOURCES
           
static java.lang.String EL_ROLEATTRIBUTES
           
static java.lang.String EL_ROLEEXCLUSIONREFS
           
static java.lang.String EL_SERVICES
           
static java.lang.String EL_SUPERROLES
           
 
Fields inherited from class com.waveset.object.PersistentObject
INITIAL_OBJECT_VERSION
 
Constructor Summary
Role(org.w3c.dom.Element e)
          Create a role by parsing its DOM representation.
Role(com.sun.idm.object.IDMObjectClass objectClass)
           
 
Method Summary
 void addApprover(com.waveset.object.ObjectRef ref)
          Add one approver to our approver list.
 void addApprover(WSUser admin)
          Add one approver to our approver list.
 void addContainedRole(com.waveset.object.ContainedRole containedRole)
          Add a contained role
 void addResource(com.waveset.object.ObjectRef r)
          Adds a resource to the application.
 void addResource(com.waveset.object.Resource r)
          Add a new resource to the application.
 void addRoleAttribute(com.waveset.object.RoleAttribute ra)
          Adds a RoleAttribute(value assignment) to the role.
 void addRoleExclusionRef(com.waveset.object.ObjectRef or)
           
 void addService(com.waveset.object.ObjectRef r)
          Adds a service reference to the application.
 void addService(Service s)
          Add one service to the list.
 void addSuperRole(com.waveset.object.ObjectRef r)
           
 void addSuperRole(Role s)
           
 void clearApprovers()
          Clear the approvers list.
 void clearContainedRoles()
           
 void clearResources()
          Removes all resources from the application.
 void clearRoleAttributes()
          Clear the list of RoleAttribute(value assignment) objects, which correspond to the attributes assigned to an account when a Role is assigned - not the (extended and built-in) attributes of a Role.
 void clearRoleExclusionRefs()
           
 void clearServices()
          Clear the services list.
 void clearSuperRoles()
           
 WSUser getAdministrator()
          Get the approval administrator for this role.
 java.util.List getApplicationRefs()
          Gets the list of applications references in this application.
 com.waveset.object.Application[] getApplications()
          Return the current list of applications assigned to this role/
 java.util.List getApproverRefs()
          Get the list of references to approvers for this role.
 WSUser[] getApprovers()
          Get an array of resolved approver objects for this role.
 com.waveset.object.ObjectRef getApproversRuleRef()
           
 java.util.List getAssignedApplicationRefs()
          return Application refs directly assigned to this role
 java.util.List getAssignedRefs(com.waveset.object.Type type)
          Gets the list of resource references directly assigned to this role
 java.util.List getAssignedResourceRefs()
          return Resource refs directly assigned to this role
 java.util.List getAssignedRoleRefs()
          return Role refs directly assigned to this role
 java.util.List getAssignmentRefs()
          return possibly qualified Resource refs directly assigned to this role
 com.waveset.object.ObjectRef getAuthenticatorRef()
           
 java.lang.String getAuthType()
          Return the authorization type of this object.
 com.waveset.object.ContainedRole getContainedRole(java.lang.String roleName)
          Return the ContainedRole for the given role name.
 java.util.List<com.waveset.object.ContainedRole> getContainedRoles()
           
 java.lang.String getDescription()
           
 WSAttribute getExtendedAttribute(java.lang.String attributeName)
          Get a (copy of a) role attribute.
 WSAttributes getExtendedAttributes()
          Get the collection of all attributes for this role.
 java.util.List getNotificationRefs()
          Get the list of references to notification listeners for this role.
 WSUser[] getNotifications()
           
 com.waveset.object.ObjectRef getNotificationsRuleRef()
           
 java.util.List getOwnerRefs()
           
 WSUser[] getOwners()
          Get an array of resolved owner objects for this role.
 com.waveset.object.ObjectRef getOwnersRuleRef()
           
 GenericObject getPolicyUpgradeMap()
          Create a map of the attributes and elements that make up what has moved to the LighthouseAccountPolicy - specifically: Attributes: idSource String passwordSource String questionPolicy String randomQuestionCount int roundRobinQuestionIndex int accountLock boolean resetOption String resetCheck String Elements: PasswordExpiry Util.TimePeriod PasswordExpiryWarning Util.TimePeriod TempPasswordExpiry Util.TimePeriod AuthenticationQuestions List of GenericObject, attributes id & question ResetLimit int resetLimitPeriod resetLimitPeriod
 com.sun.idm.object.IDMObjectClass getPrimaryObjectClass()
           
 java.util.ArrayList getReferences()
          Return the list of references within this object.
 java.util.Set getResourceAssignmentRefs()
          Gets the list of possibly qualified resource references in this application.
 java.util.Set getResourceAssignments()
          Return the set of ResourceAssignments encapsulated by this Service and any Services it contains.
 java.util.List getResourceRefs()
          Gets the list of resource references in this application.
 com.waveset.object.Resource[] getResources()
          Calculate a flattened list of resource objects referenced by this role.
 java.util.List<com.waveset.object.RoleAttribute> getRoleAttributes()
          RoleAttribute(value assignment) objects correspond to the attributes assigned to an account when a Role is assigned, not the (extended and built-in) attributes of a Role.
 java.util.List getRoleExclusionRefs()
           
 java.util.List getRoleRefs()
          Gets the list of applications references in this application.
 Role[] getRoles()
          Return array of current roles assigned to this role
 java.util.List getServiceRefs()
          Get the list of references to services.
 Service[] getServices()
          Resolve the list of service references, and return an array of service objects.
 java.util.List getSubRoleIdList()
          Return the current list of roles assigned to this role
 java.util.List getSubRoleList()
          Return the current list of roles assigned to this role
 java.util.List getSubRoleNameList()
          Return the current list of roles assigned to this role
 WSAttributes getSummaryAttributes()
           
 java.util.List getSuperRoleIdList()
          Return the current list of roles that assign this role
 java.util.List getSuperRoleList()
           
 java.util.List getSuperRoleRefs()
           
 Role[] getSuperRoles()
           
 com.waveset.object.Type getType()
          Returns the associated Type object.
 boolean isDisabled()
          Test the role disabled flag.
 boolean isOpaque()
          Test the opaque flag.
 boolean isOrdered()
          Override this if this service is a container and order is important.
 java.util.List listQueryableAttributes()
           
 java.util.List listQueryableReferenceAttributes()
           
 java.util.List listSummaryAttributes()
          Returns the complete list of defined attributes that this type of persistent object exposes as summary attributes (regardless of whether this particular object has a value for each).
 void removeApprover(com.waveset.object.ObjectRef ref)
          Remove one approver from our approver list.
 void removeApprover(WSUser admin)
          Remove one approver from our approver list.
 void removeContainedRole(com.waveset.object.ContainedRole containedRole)
          Remove a contained role
 void removeExtendedAttribute(java.lang.String attributeName)
          Removes the named attribute from the role.
 void removeResource(com.waveset.object.ObjectRef ref)
          Removes a resource reference.
 void removeResource(com.waveset.object.Resource r)
          Removes a resource reference.
 void removeService(com.waveset.object.ObjectRef ref)
          Removes a service.
 void removeService(Service s)
          Removes a service reference.
 void removeSuperRole(com.waveset.object.ObjectRef ref)
           
 void removeSuperRole(Role s)
           
static void resolveSummaryAttributes(com.waveset.object.ObjectCache cache, WSAttributes attrs)
           
 void setAdministrator(WSUser a)
          Set the approval administrator for this role.
 void setApprovers(java.util.List approvers)
           
 void setApproversRuleRef(com.waveset.object.ObjectRef ruleRef)
           
 void setAuthenticator(com.waveset.object.ObjectRef ref)
           
 void setDescription(java.lang.String description)
           
 void setDisabled(boolean b)
          Set the role disabled flag.
 void setExtendedAttribute(WSAttribute attribute)
          Set an account attribute to a copy of attribute.
 void setExtendedAttributes(WSAttributes extendedAttributes)
          Utility to replace all extended attributes on a Role at once.
 void setNotificationRefs(java.util.List refs)
           
 void setNotificationsRuleRef(com.waveset.object.ObjectRef ruleRef)
           
 void setOpaque(boolean b)
           
 void setOrdered(boolean b)
           
 void setOwnerRefs(java.util.List owners)
           
 void setOwnersRuleRef(com.waveset.object.ObjectRef ruleRef)
           
 void setRoleAttributes(java.util.List<com.waveset.object.RoleAttribute> list)
          Specify/Replace the list of RoleAttribute(value assignment) objects - these correspond to the attributes assigned to an account when a Role is assigned, not the (extended and built-in) attributes of a Role.
 void setRoleExclusionRefs(java.util.List list)
           
 void setServices(Service[] sarray)
          Set the services list in one operation by specifying an array of service objects.
 void setSuperRoles(Service[] sarray)
           
 void visit(com.waveset.object.Visitor v)
          Visitor interface.
 
Methods inherited from class com.waveset.object.Service
checkForReferenceCycles, dumpSummary, findApplications, findApplications, findResources, findRoleAttributes, findRoleExclusions, findRoles, findRoles, findServices, findServices, getFlatResourceAssignments, getFlatResourceAssignments, getFlatResourceAssignmentsNoRoles, getFlatResourceAssignmentsNoRoles, getFlatResources, getFlatResources, getFlatResources, getFlatResources, getFlatResourcesNoRoles, getFlatResourcesNoRoles, toIdentityString, toVerboseString, toVerboseString
 
Methods inherited from class com.waveset.object.PersistentObject
addMemberObjectGroup, addMemberObjectGroup, addXmlHeader, attributesMatch, attributesMatch, attributesMatch, checkReference, checkReferences, clearId, cloneAs, cloneObject, compareTo, create, create, create, create, createLastModItem, createLastModItem, createLastModItemList, directObjectGroupMember, dump, dumpFile, equals, getAttribute, getAttributeValues, getAuthReferences, getBasicAttributes, getBasicAttributes, getBasicAttributes, getCache, getCounterValue, getCreateDate, getCreator, getDisplayableName, getDisplayName, getElementName, getEncryptedValues, getId, getIdOrName, getInitialInstances, getLastMod, getLastModDate, getLastModifier, getLastModItemId, getLockInfo, getMemberObjectGroupRefs, getMemberObjectGroupRefsUpTo, getMemberObjectGroups, getName, getNameOrId, getProperties, getProperty, getPropertyAsString, getPropertyList, getQueryableAttributes, getReference, getRepositoryMod, getRuleDrivenMemberObjectGroupRefs, getRuleDrivenMemberObjectGroupRefsUpTo, getRuleDrivenMemberObjectGroups, getSubtype, getSummaryString, getXMLSize, hasEncryptedData, hashCode, identityEquals, isAlias, isHidden, isProtected, isProtectedFromDelete, isReferencedIn, listOperationalAttributes, objectGroupMember, objectGroupMemberRef, prepareForSerialization, prepareToSerialize, reEncrypt, removeMemberObjectGroup, removeProperty, resolve, resolve, resolve, resolveArray, resolveArrayByFetching, resolveObjectReferences, resolveReference, resolveSummaryAttributes, ruleDrivenObjectGroupMemberRef, setAuthType, setAuthType, setCache, setDisplayName, setDisplayName, setHidden, setIsAlias, setMemberObjectGroupRef, setMemberObjectGroupRefs, setMemberObjectGroups, setName, setProperties, setProperty, setPropertyList, setRuleDrivenMembersCache, setSubtype, setTrace, toString, toXml, toXml, toXml, toXmlFile
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

code_id

public static final java.lang.String code_id
See Also:
Constant Field Values

EL_AUTHENTICATOR

public static final java.lang.String EL_AUTHENTICATOR
See Also:
Constant Field Values

EL_RESOURCES

public static final java.lang.String EL_RESOURCES
See Also:
Constant Field Values

EL_ROLEATTRIBUTES

public static final java.lang.String EL_ROLEATTRIBUTES
See Also:
Constant Field Values

EL_ROLEEXCLUSIONREFS

public static final java.lang.String EL_ROLEEXCLUSIONREFS
See Also:
Constant Field Values

EL_SERVICES

public static final java.lang.String EL_SERVICES
See Also:
Constant Field Values

EL_SUPERROLES

public static final java.lang.String EL_SUPERROLES
See Also:
Constant Field Values
Constructor Detail

Role

public Role(org.w3c.dom.Element e)
     throws com.waveset.util.WavesetException
Create a role by parsing its DOM representation.

Parameters:
e - XML element
Throws:
com.waveset.util.WavesetException - if the XML can't be parsed.

Role

public Role(com.sun.idm.object.IDMObjectClass objectClass)
Method Detail

addApprover

public void addApprover(com.waveset.object.ObjectRef ref)
Add one approver to our approver list.

These should be administrators with APPROVAL rights. Can't check that here, it will have to be done as part of the Checkin validator. The GUI currently tries to prevent selection of bad values.

Parameters:
ref - ObjectRef to approver

addApprover

public void addApprover(WSUser admin)
Add one approver to our approver list.

These should be administrators with APPROVAL rights. Can't check that here, it will have to be done as part of the Checkin validator. The GUI currently tries to prevent selection of bad values.

If you want to specify a completely new list, call clearApprovers first.

See Also:
clearApprovers()

addContainedRole

public void addContainedRole(com.waveset.object.ContainedRole containedRole)
Add a contained role


addResource

public void addResource(com.waveset.object.ObjectRef r)
Adds a resource to the application.


addResource

public void addResource(com.waveset.object.Resource r)
Add a new resource to the application.


addRoleAttribute

public void addRoleAttribute(com.waveset.object.RoleAttribute ra)
Adds a RoleAttribute(value assignment) to the role. These correspond to the attributes assigned to an account when a Role is assigned, not the (extended and built-in) attributes of a Role.

Parameters:
ra - role attribute value assignment for the role

addRoleExclusionRef

public void addRoleExclusionRef(com.waveset.object.ObjectRef or)

addService

public void addService(com.waveset.object.ObjectRef r)
Adds a service reference to the application.


addService

public void addService(Service s)
Add one service to the list.


addSuperRole

public void addSuperRole(com.waveset.object.ObjectRef r)

addSuperRole

public void addSuperRole(Role s)

clearApprovers

public void clearApprovers()
Clear the approvers list.


clearContainedRoles

public void clearContainedRoles()

clearResources

public void clearResources()
Removes all resources from the application.


clearRoleAttributes

public void clearRoleAttributes()
Clear the list of RoleAttribute(value assignment) objects, which correspond to the attributes assigned to an account when a Role is assigned - not the (extended and built-in) attributes of a Role.


clearRoleExclusionRefs

public void clearRoleExclusionRefs()

clearServices

public void clearServices()
Clear the services list.


clearSuperRoles

public void clearSuperRoles()

getAdministrator

public WSUser getAdministrator()
                        throws com.waveset.util.WavesetException
Get the approval administrator for this role.

Deprecated, you should be using getApprovers. If there are more than approvers, the first one is returned. #see #getApprovers

Throws:
com.waveset.util.WavesetException

getApplicationRefs

public java.util.List getApplicationRefs()
                                  throws com.waveset.util.WavesetException
Gets the list of applications references in this application.

Throws:
com.waveset.util.WavesetException

getApplications

public com.waveset.object.Application[] getApplications()
                                                 throws com.waveset.util.WavesetException
Return the current list of applications assigned to this role/

Throws:
com.waveset.util.WavesetException

getApproverRefs

public java.util.List getApproverRefs()
Get the list of references to approvers for this role.

Returns:
lift of ObjectRefs to approvers.

getApprovers

public WSUser[] getApprovers()
                      throws com.waveset.util.WavesetException
Get an array of resolved approver objects for this role.

Throws:
com.waveset.util.WavesetException

getApproversRuleRef

public com.waveset.object.ObjectRef getApproversRuleRef()

getAssignedApplicationRefs

public java.util.List getAssignedApplicationRefs()
return Application refs directly assigned to this role


getAssignedRefs

public java.util.List getAssignedRefs(com.waveset.object.Type type)
Gets the list of resource references directly assigned to this role


getAssignedResourceRefs

public java.util.List getAssignedResourceRefs()
return Resource refs directly assigned to this role


getAssignedRoleRefs

public java.util.List getAssignedRoleRefs()
return Role refs directly assigned to this role


getAssignmentRefs

public java.util.List getAssignmentRefs()
return possibly qualified Resource refs directly assigned to this role


getAuthenticatorRef

public com.waveset.object.ObjectRef getAuthenticatorRef()

getAuthType

public java.lang.String getAuthType()
Return the authorization type of this object. An authorization type may be used to further control access to the object beyond that defined for the base repository type.

Overrides:
getAuthType in class PersistentObject

getContainedRole

public com.waveset.object.ContainedRole getContainedRole(java.lang.String roleName)
Return the ContainedRole for the given role name.


getContainedRoles

public java.util.List<com.waveset.object.ContainedRole> getContainedRoles()
Returns:
the current list of contained roles

getDescription

public java.lang.String getDescription()

getExtendedAttribute

public WSAttribute getExtendedAttribute(java.lang.String attributeName)
Get a (copy of a) role attribute.

The attribute is returned as a WSAttribute object.

Note that the WSAttribute returned is a copy of the role's attribute, so modifying the returned value will not change the role's attribute value. Use setExtendedAttribute(WSAttribute) to change the value on the role.

Parameters:
attributeName - name of attribute to retrieve
Returns:
A copy of the role's attribute.

getExtendedAttributes

public WSAttributes getExtendedAttributes()
Get the collection of all attributes for this role.

Note the collection is a copy of the attributes, so modifying any of the values will not be reflected on the role. To change a role's attribute, use setExtendedAttribute(WSAttribute).

Returns:
A copy of the WSAttributes for the role.

getNotificationRefs

public java.util.List getNotificationRefs()
Get the list of references to notification listeners for this role.


getNotifications

public WSUser[] getNotifications()
                          throws com.waveset.util.WavesetException
Throws:
com.waveset.util.WavesetException

getNotificationsRuleRef

public com.waveset.object.ObjectRef getNotificationsRuleRef()

getOwnerRefs

public java.util.List getOwnerRefs()

getOwners

public WSUser[] getOwners()
                   throws com.waveset.util.WavesetException
Get an array of resolved owner objects for this role.

Throws:
com.waveset.util.WavesetException

getOwnersRuleRef

public com.waveset.object.ObjectRef getOwnersRuleRef()

getPolicyUpgradeMap

public GenericObject getPolicyUpgradeMap()
Create a map of the attributes and elements that make up what has moved to the LighthouseAccountPolicy - specifically: Attributes: idSource String passwordSource String questionPolicy String randomQuestionCount int roundRobinQuestionIndex int accountLock boolean resetOption String resetCheck String Elements: PasswordExpiry Util.TimePeriod PasswordExpiryWarning Util.TimePeriod TempPasswordExpiry Util.TimePeriod AuthenticationQuestions List of GenericObject, attributes id & question ResetLimit int resetLimitPeriod resetLimitPeriod


getPrimaryObjectClass

public com.sun.idm.object.IDMObjectClass getPrimaryObjectClass()
Overrides:
getPrimaryObjectClass in class PersistentObject
Returns:
primary object class for this role.

getReferences

public java.util.ArrayList getReferences()
Return the list of references within this object.

Overrides:
getReferences in class PersistentObject

getResourceAssignmentRefs

public java.util.Set getResourceAssignmentRefs()
                                        throws com.waveset.util.WavesetException
Gets the list of possibly qualified resource references in this application. Now that we can contain other Services as well as resources, we have to calculate this.

Specified by:
getResourceAssignmentRefs in class Service
Throws:
com.waveset.util.WavesetException

getResourceAssignments

public java.util.Set getResourceAssignments()
                                     throws com.waveset.util.WavesetException
Description copied from class: Service
Return the set of ResourceAssignments encapsulated by this Service and any Services it contains.

Specified by:
getResourceAssignments in class Service
Throws:
com.waveset.util.WavesetException

getResourceRefs

public java.util.List getResourceRefs()
                               throws com.waveset.util.WavesetException
Gets the list of resource references in this application. Now that we can contain other Services as well as resources, we have to calculate this.

Specified by:
getResourceRefs in class Service
Throws:
com.waveset.util.WavesetException

getResources

public com.waveset.object.Resource[] getResources()
                                           throws com.waveset.util.WavesetException
Calculate a flattened list of resource objects referenced by this role.

We formerly tried to cache this, but its fragile. Now the array is calculated every time.

Specified by:
getResources in class Service
Throws:
com.waveset.util.WavesetException

getRoleAttributes

public java.util.List<com.waveset.object.RoleAttribute> getRoleAttributes()
RoleAttribute(value assignment) objects correspond to the attributes assigned to an account when a Role is assigned, not the (extended and built-in) attributes of a Role.

Returns:
a List of RoleAttribute (value assignment) objects

getRoleExclusionRefs

public java.util.List getRoleExclusionRefs()

getRoleRefs

public java.util.List getRoleRefs()
                           throws com.waveset.util.WavesetException
Gets the list of applications references in this application.

Throws:
com.waveset.util.WavesetException

getRoles

public Role[] getRoles()
                throws com.waveset.util.WavesetException
Return array of current roles assigned to this role

Throws:
com.waveset.util.WavesetException

getServiceRefs

public java.util.List getServiceRefs()
Get the list of references to services.

Specified by:
getServiceRefs in class Service

getServices

public Service[] getServices()
                      throws com.waveset.util.WavesetException
Resolve the list of service references, and return an array of service objects.

Formerly the array was cached for subsequent calls, but that was fragile, and I don't think was all that necessary.

Specified by:
getServices in class Service
Throws:
com.waveset.util.WavesetException

getSubRoleIdList

public java.util.List getSubRoleIdList()
                                throws com.waveset.util.WavesetException
Return the current list of roles assigned to this role

Throws:
com.waveset.util.WavesetException

getSubRoleList

public java.util.List getSubRoleList()
                              throws com.waveset.util.WavesetException
Return the current list of roles assigned to this role

Throws:
com.waveset.util.WavesetException

getSubRoleNameList

public java.util.List getSubRoleNameList()
                                  throws com.waveset.util.WavesetException
Return the current list of roles assigned to this role

Throws:
com.waveset.util.WavesetException

getSummaryAttributes

public WSAttributes getSummaryAttributes()
Overrides:
getSummaryAttributes in class PersistentObject
Returns:
attribute values to be displayed when this object appears in a list. The WSAttributes contains a WSAttribute for each summary attribute. Each WSAttribute may contain multiple values.

Any subclass of PersistentObject that overrides this method should first invoke super.getSummaryAttributes() to ensure that the subclass includes summary attributes that are common to all PersistentObjects.

See Also:

If a subclass wants to expose a different set of summary attributes, that subclass should override {@link #listSummaryAttributes}. In order to supply values for summary attributes that may not be available in PersistentObject (e.g., from a field specified to that subclass), such a subclass may also override {@link #getAttributeValues(String)}.

A subclass should not need to override this method (except to limit the number of values for a summary attribute).


getSuperRoleIdList

public java.util.List getSuperRoleIdList()
                                  throws com.waveset.util.WavesetException
Return the current list of roles that assign this role

Throws:
com.waveset.util.WavesetException

getSuperRoleList

public java.util.List getSuperRoleList()
                                throws com.waveset.util.WavesetException
Throws:
com.waveset.util.WavesetException

getSuperRoleRefs

public java.util.List getSuperRoleRefs()

getSuperRoles

public Role[] getSuperRoles()
                     throws com.waveset.util.WavesetException
Throws:
com.waveset.util.WavesetException

getType

public com.waveset.object.Type getType()
Returns the associated Type object.

Specified by:
getType in class PersistentObject
Returns:
type of this persistent object.

isDisabled

public boolean isDisabled()
Test the role disabled flag.

Returns:
whether the role is disabled.

isOpaque

public boolean isOpaque()
Test the opaque flag.


isOrdered

public boolean isOrdered()
Description copied from class: Service
Override this if this service is a container and order is important.

Overrides:
isOrdered in class Service

listQueryableAttributes

public java.util.List listQueryableAttributes()
Overrides:
listQueryableAttributes in class PersistentObject
Returns:
the complete list of defined attributes that this type of persistent object exposes as queryable attributes (regardless of whether this particular object has a value for each).

Any subclass of PersistentObject that overrides this method should first invoke super.listQueryableAttributes() to ensure that the subclass includes queryable attributes that are common to all PersistentObjects.


listQueryableReferenceAttributes

public java.util.List listQueryableReferenceAttributes()
Overrides:
listQueryableReferenceAttributes in class PersistentObject
Returns:
the list of defined attributes that this type of persistent object exposes as queryable and for which each value is a reference to another persistent object.

listSummaryAttributes

public java.util.List listSummaryAttributes()
Description copied from class: PersistentObject
Returns the complete list of defined attributes that this type of persistent object exposes as summary attributes (regardless of whether this particular object has a value for each).

Any subclass of PersistentObject that overrides this method should first invoke super.listSummaryAttributes() to ensure that the subclass includes summary attributes that are common to all PersistentObjects.

Any subclass that overrides this implementation must also consider the length of the summary string that will be generated from these attributes.

Overrides:
listSummaryAttributes in class PersistentObject
Returns:
the complete list of defined attributes that this type of persistent object exposes as summary attributes (regardless of whether this object has a value for each).

Any subclass of PersistentObject that overrides this method should first invoke super.listSummaryAttributes() to ensure that the subclass includes summary attributes that are common to all PersistentObjects.

See Also:
Constants.MAX_SUMMARY_STRING_LENGTH, PersistentObject.getSummaryString()

removeApprover

public void removeApprover(com.waveset.object.ObjectRef ref)
Remove one approver from our approver list.


removeApprover

public void removeApprover(WSUser admin)
Remove one approver from our approver list.


removeContainedRole

public void removeContainedRole(com.waveset.object.ContainedRole containedRole)
Remove a contained role

Parameters:
containedRole -

removeExtendedAttribute

public void removeExtendedAttribute(java.lang.String attributeName)
Removes the named attribute from the role.

Parameters:
attributeName - name of attribute to remove.

removeResource

public void removeResource(com.waveset.object.ObjectRef ref)
Removes a resource reference.


removeResource

public void removeResource(com.waveset.object.Resource r)
Removes a resource reference.


removeService

public void removeService(com.waveset.object.ObjectRef ref)
Removes a service.


removeService

public void removeService(Service s)
Removes a service reference.

The reference is specified as a Service object.


removeSuperRole

public void removeSuperRole(com.waveset.object.ObjectRef ref)

removeSuperRole

public void removeSuperRole(Role s)

resolveSummaryAttributes

public static void resolveSummaryAttributes(com.waveset.object.ObjectCache cache,
                                            WSAttributes attrs)
                                     throws com.waveset.util.WavesetException
Throws:
com.waveset.util.WavesetException

setAdministrator

public void setAdministrator(WSUser a)
Set the approval administrator for this role.

Deprecated, you should be using addApprover. If there is currently more than one approver, the entire list will be cleared and set to this one.

See Also:
addApprover(com.waveset.object.ObjectRef)

setApprovers

public void setApprovers(java.util.List approvers)

setApproversRuleRef

public void setApproversRuleRef(com.waveset.object.ObjectRef ruleRef)

setAuthenticator

public void setAuthenticator(com.waveset.object.ObjectRef ref)

setDescription

public void setDescription(java.lang.String description)

setDisabled

public void setDisabled(boolean b)
Set the role disabled flag.

Parameters:
b - disabled flag

setExtendedAttribute

public void setExtendedAttribute(WSAttribute attribute)
Set an account attribute to a copy of attribute.

If this attribute is already set, the old value is replaced. Note: Modifying attribute after calling setWSAttribute will not change the value of the role's attribute. To change a role's attribute, use setExtendedAttribute(WSAttribute) with the revised attribute.

Parameters:
attribute - to set on the role.

setExtendedAttributes

public void setExtendedAttributes(WSAttributes extendedAttributes)
Utility to replace all extended attributes on a Role at once.

Parameters:
extendedAttributes - New collection of extended attributes.

setNotificationRefs

public void setNotificationRefs(java.util.List refs)

setNotificationsRuleRef

public void setNotificationsRuleRef(com.waveset.object.ObjectRef ruleRef)

setOpaque

public void setOpaque(boolean b)

setOrdered

public void setOrdered(boolean b)

setOwnerRefs

public void setOwnerRefs(java.util.List owners)

setOwnersRuleRef

public void setOwnersRuleRef(com.waveset.object.ObjectRef ruleRef)

setRoleAttributes

public void setRoleAttributes(java.util.List<com.waveset.object.RoleAttribute> list)
Specify/Replace the list of RoleAttribute(value assignment) objects - these correspond to the attributes assigned to an account when a Role is assigned, not the (extended and built-in) attributes of a Role.

Parameters:
list - of role attribute value definitions for the role.

setRoleExclusionRefs

public void setRoleExclusionRefs(java.util.List list)

setServices

public void setServices(Service[] sarray)
Set the services list in one operation by specifying an array of service objects. Applications ordinarily use addService instead.


setSuperRoles

public void setSuperRoles(Service[] sarray)

visit

public void visit(com.waveset.object.Visitor v)
           throws com.waveset.util.WavesetException
Visitor interface.

Overrides:
visit in class PersistentObject
Parameters:
v - Visitor for this persistent object.
Throws:
com.waveset.util.WavesetException - if there's a problem from visitPersistentObject