com.waveset.object
Class UserEntitlement

java.lang.Object
  extended bycom.waveset.object.PersistentObject
      extended bycom.waveset.object.UserEntitlement
All Implemented Interfaces:
java.lang.Comparable, javax.naming.Referenceable, XmlObject

public class UserEntitlement
extends PersistentObject

UserEntitlement contains a User's account attributes at the time of an Access scan.


Nested Class Summary
 
Nested classes inherited from class com.waveset.object.PersistentObject
PersistentObject.Comparator, PersistentObject.InitialInstance
 
Field Summary
static java.lang.String APPROVED
          APPROVED indicates all attestor(s) have approved the UE
static java.lang.String CANCELLED
          CANCELLED indicates the Review has been cancelled
static java.lang.String code_id
           
static java.lang.String PENDING
          PENDING indicates the UE is awaiting action from an attestor
static java.lang.String REJECTED
          REJECTED indicates one of the attestors has rejected the UE
static java.lang.String REMEDIATING
          REMEDIATING indicates the UE has an associated CV, and is due for change
 
Fields inherited from class com.waveset.object.PersistentObject
_trace, trace
 
Constructor Summary
UserEntitlement()
          Create an entitlement record to be filled by setters
UserEntitlement(org.w3c.dom.Element e)
          Flesh out policy object by parsing its XML representation.
UserEntitlement(WSUser user)
          Create an entitlement record for a specific user
 
Method Summary
 void addAttestationEntry(AttestationEntry entry)
           
protected  void addSubclassAttributes(java.lang.StringBuffer b)
          Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist).
protected  void addSubclassElements(java.lang.StringBuffer b)
          Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist).
 void approve()
           
 void cancel()
           
 java.lang.String getAccessScanDefinition()
           
 java.lang.String getAccessScanInstance()
           
 java.util.List getAttestationEntries()
           
 ObjectRef getAttestationWorkflow()
           
 java.util.List getAttestorNames()
           
protected  WSAttribute getAttributeValues(java.lang.String attrName)
           
 java.lang.String getParDefinition()
           
 java.lang.String getParInstance()
           
 java.util.Date getParStartDate()
           
 java.util.Map getRuleOutput()
           
 java.lang.Object getRuleOutput(java.lang.String key)
           
 java.lang.String getStatus()
           
 Type getType()
          Returns the associated Type object.
 ObjectRef getUser()
           
 java.util.Map getUserView()
           
 java.util.List listQueryableAttributes()
           
 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).
protected  void parseSubclassAttributes(org.w3c.dom.Element e)
          Each concrete subclass should parse from the XML buffer any persisted subclass-specific fields (generally, the same ones that it writes into the buffer).
protected  void parseSubclassElements(org.w3c.dom.Element e)
          Each concrete subclass should parse from the XML buffer any persisted subclass-specific elements (generally, the same ones that it writes into the buffer).
 void reject()
           
 void setAccessScanDefinition(java.lang.String id)
           
 void setAccessScanInstance(java.lang.String id)
           
 void setAttestationEntries(java.util.List entries)
           
 void setAttestationWorkflow(TaskInstance task)
           
 void setAttestationWorkflowRef(ObjectRef objectRef)
           
 void setParDefinition(java.lang.String id)
           
 void setParInstance(java.lang.String id)
           
 void setParStartDate(java.util.Date startDate)
           
 void setRuleOutput(java.util.Map results)
           
 void setStatus(java.lang.String status)
           
 void setUser(WSUser user)
           
 void setUserView(java.util.Map userView)
           
 
Methods inherited from class com.waveset.object.PersistentObject
addCommonElements, addEndTag, addMemberObjectGroup, addMemberObjectGroup, addPersistentAttributes, addStartTag, addSummaryAttributes, addXmlHeader, attributesMatch, attributesMatch, attributesMatch, checkReference, checkReferences, clearId, cloneAs, cloneObject, compareTo, create, create, create, create, createLastModItem, createLastModItem, createLastModItemList, directObjectGroupMember, dump, dumpFile, equals, fakeId, getAttribute, getAttributeValues, getAuthReferences, getAuthType, 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, getReferences, getRuleDrivenMemberObjectGroupRefs, getRuleDrivenMemberObjectGroupRefsUpTo, getRuleDrivenMemberObjectGroups, getSubtype, getSummaryAttributes, getSummaryString, hasEncryptedData, hashCode, identityEquals, isAlias, isHidden, isId, isProtected, isProtectedFromDelete, isReferencedIn, listOperationalAttributes, listQueryableReferenceAttributes, objectGroupMember, objectGroupMemberRef, parseCommonElement, parseCommonElements, parsePersistentAttributes, parseXml, parseXml, prepareForSerialization, prepareToSerialize, println, reEncrypt, reEncryptSubclassAttributes, removeMemberObjectGroup, removeProperty, resolve, resolve, resolve, resolveArray, resolveArrayByFetching, resolveObjectReference, resolveObjectReferences, resolveReference, resolveSummaryAttributes, resolveSummaryAttributes, ruleDrivenObjectGroupMemberRef, setAuthType, setAuthType, setCache, setCreateDate, setCreator, setDisplayName, setDisplayName, setHidden, setIsAlias, setLastMod, setLastMod, setLastModDate, setLastModifier, setMemberObjectGroupRef, setMemberObjectGroupRefs, setMemberObjectGroups, setName, setProperties, setProperty, setPropertyList, setProtected, setProtectedFromDelete, setRuleDrivenMembersCache, setSubtype, setTrace, toString, toXml, toXml, toXml, toXmlFile, visit
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

code_id

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

PENDING

public static final java.lang.String PENDING
PENDING indicates the UE is awaiting action from an attestor

See Also:
Constant Field Values

REMEDIATING

public static final java.lang.String REMEDIATING
REMEDIATING indicates the UE has an associated CV, and is due for change

See Also:
Constant Field Values

APPROVED

public static final java.lang.String APPROVED
APPROVED indicates all attestor(s) have approved the UE

See Also:
Constant Field Values

REJECTED

public static final java.lang.String REJECTED
REJECTED indicates one of the attestors has rejected the UE

See Also:
Constant Field Values

CANCELLED

public static final java.lang.String CANCELLED
CANCELLED indicates the Review has been cancelled

See Also:
Constant Field Values
Constructor Detail

UserEntitlement

public UserEntitlement()
Create an entitlement record to be filled by setters


UserEntitlement

public UserEntitlement(WSUser user)
Create an entitlement record for a specific user


UserEntitlement

public UserEntitlement(org.w3c.dom.Element e)
                throws WavesetException
Flesh out policy object by parsing its XML representation.

Method Detail

getType

public Type getType()
Returns the associated Type object.

Specified by:
getType in class PersistentObject

getUser

public ObjectRef getUser()

setUser

public void setUser(WSUser user)

getStatus

public java.lang.String getStatus()

setStatus

public void setStatus(java.lang.String status)

approve

public void approve()

reject

public void reject()

cancel

public void cancel()

setAttestationWorkflow

public void setAttestationWorkflow(TaskInstance task)

setAttestationWorkflowRef

public void setAttestationWorkflowRef(ObjectRef objectRef)

getAttestationWorkflow

public ObjectRef getAttestationWorkflow()

getParDefinition

public java.lang.String getParDefinition()

setParDefinition

public void setParDefinition(java.lang.String id)

getParInstance

public java.lang.String getParInstance()

setParInstance

public void setParInstance(java.lang.String id)

getParStartDate

public java.util.Date getParStartDate()

setParStartDate

public void setParStartDate(java.util.Date startDate)

getAccessScanDefinition

public java.lang.String getAccessScanDefinition()

setAccessScanDefinition

public void setAccessScanDefinition(java.lang.String id)

getAccessScanInstance

public java.lang.String getAccessScanInstance()

setAccessScanInstance

public void setAccessScanInstance(java.lang.String id)

getUserView

public java.util.Map getUserView()

setUserView

public void setUserView(java.util.Map userView)

getRuleOutput

public java.util.Map getRuleOutput()

getRuleOutput

public java.lang.Object getRuleOutput(java.lang.String key)

setRuleOutput

public void setRuleOutput(java.util.Map results)

getAttestationEntries

public java.util.List getAttestationEntries()

setAttestationEntries

public void setAttestationEntries(java.util.List entries)

addAttestationEntry

public void addAttestationEntry(AttestationEntry entry)

getAttestorNames

public java.util.List getAttestorNames()

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.


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 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.

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

getAttributeValues

protected WSAttribute getAttributeValues(java.lang.String attrName)
Overrides:
getAttributeValues in class PersistentObject
Parameters:
attrName - - the name of the attribute for which to return values.
Returns:
a WSAttribute that represents the value (or values) that this object contains for the specified attribute.


addSubclassAttributes

protected void addSubclassAttributes(java.lang.StringBuffer b)
Description copied from class: PersistentObject
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). PersistentObject's default implementation is a no-op.

NOTE: Any subclass that overrides this method must similarly override parseSubclassAttributes() so that the subclass attributes are restored.

Overrides:
addSubclassAttributes in class PersistentObject
See Also:


addSubclassElements

protected void addSubclassElements(java.lang.StringBuffer b)
Description copied from class: PersistentObject
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). PersistentObject's default implementation is a no-op.

NOTE: Any subclass that overrides this method must similarly override parseSubclassElements() so that the subclass elements are restored.

Overrides:
addSubclassElements in class PersistentObject
See Also:


parseSubclassAttributes

protected void parseSubclassAttributes(org.w3c.dom.Element e)
                                throws WavesetException
Description copied from class: PersistentObject
Each concrete subclass should parse from the XML buffer any persisted subclass-specific fields (generally, the same ones that it writes into the buffer).

Overrides:
parseSubclassAttributes in class PersistentObject
Throws:
WavesetException
See Also:

PersistentObject's default implementation is a no-op.

, PersistentObject.parseXml(Element)

parseSubclassElements

protected void parseSubclassElements(org.w3c.dom.Element e)
                              throws WavesetException
Description copied from class: PersistentObject
Each concrete subclass should parse from the XML buffer any persisted subclass-specific elements (generally, the same ones that it writes into the buffer).

Overrides:
parseSubclassElements in class PersistentObject
Throws:
WavesetException
See Also:

PersistentObject's default implementation is a no-op.

, PersistentObject.parseXml(Element)