org.kuali.rice.kim.api.role
Class RoleResponsibilityAction

java.lang.Object
  org.kuali.rice.kim.api.role.RoleResponsibilityAction

All Implemented Interfaces:

Serializable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, RoleResponsibilityActionContract

public class RoleResponsibilityAction
extends Object
implements RoleResponsibilityActionContract, ModelObjectComplete

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Nested Class Summary

static class	RoleResponsibilityAction.Builder
(package private) static class	RoleResponsibilityAction.Constants Defines some internal constants used on this class.
(package private) static class	RoleResponsibilityAction.Elements A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.

Field Summary

private Collection<Element>	_futureElements
private String	actionPolicyCode
private String	actionTypeCode
private boolean	forceAction
private String	id
private Integer	priorityNumber
private String	roleMemberId
private RoleResponsibility	roleResponsibility
private String	roleResponsibilityId
private Long	versionNumber

Constructor Summary

private	RoleResponsibilityAction() Private default constructor should only be called by JAXB
private	RoleResponsibilityAction(RoleResponsibilityAction.Builder b)

Method Summary

boolean	equals(Object obj) All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.
String	getActionPolicyCode() Returns the action policy code.
String	getActionTypeCode() A string representation of the action type to be taken on this RoleResponsibilityAction.
String	getId() The unique identifier for an object.
Integer	getPriorityNumber()
String	getRoleMemberId() String identifier for an associated RoleMember
RoleResponsibility	getRoleResponsibility() Returns a RoleResponsibility instances associated with this action.
String	getRoleResponsibilityId() Id of the contained RoleResponsibility object.
Long	getVersionNumber() Returns the version number for this object.
int	hashCode() All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.
boolean	isForceAction()
String	toString() This will return a proper string representation of the Model Object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

private final String id

roleResponsibilityId

private final String roleResponsibilityId

roleMemberId

private final String roleMemberId

actionTypeCode

private final String actionTypeCode

actionPolicyCode

private final String actionPolicyCode

forceAction

private final boolean forceAction

priorityNumber

private final Integer priorityNumber

roleResponsibility

private final RoleResponsibility roleResponsibility

versionNumber

private final Long versionNumber

_futureElements

private final Collection<Element> _futureElements

Constructor Detail

RoleResponsibilityAction

private RoleResponsibilityAction()

Private default constructor should only be called by JAXB

RoleResponsibilityAction

private RoleResponsibilityAction(RoleResponsibilityAction.Builder b)

Method Detail

getId

public String getId()

Description copied from interface: Identifiable

The unique identifier for an object. This can be null.

Specified by:

getId in interface Identifiable

Returns:

the id

getRoleResponsibilityId

public String getRoleResponsibilityId()

Description copied from interface: RoleResponsibilityActionContract

Id of the contained RoleResponsibility object.

Specified by:

getRoleResponsibilityId in interface RoleResponsibilityActionContract

Returns:

A RoleResponsibility Id. Can be null if there is no associated RoleResponsibility.

getActionTypeCode

public String getActionTypeCode()

Description copied from interface: RoleResponsibilityActionContract

A string representation of the action type to be taken on this RoleResponsibilityAction.

Examples are

• "A" - Approve
• "F" - FYI
• "K" - Acknowledge

Specified by:

getActionTypeCode in interface RoleResponsibilityActionContract

Returns:

String representing the action type. This can be null.

getPriorityNumber

public Integer getPriorityNumber()

Specified by:

getPriorityNumber in interface RoleResponsibilityActionContract

Returns:

Integer representing the priority assigned to this Action. This can be a null value.

getActionPolicyCode

public String getActionPolicyCode()

Description copied from interface: RoleResponsibilityActionContract

Returns the action policy code.

Specified by:

getActionPolicyCode in interface RoleResponsibilityActionContract

Returns:

String for the policy code. This can be null.

getRoleMemberId

public String getRoleMemberId()

Description copied from interface: RoleResponsibilityActionContract

String identifier for an associated RoleMember

Specified by:

getRoleMemberId in interface RoleResponsibilityActionContract

Returns:

RoleMember identifier. This can be null.

getRoleResponsibility

public RoleResponsibility getRoleResponsibility()

Description copied from interface: RoleResponsibilityActionContract

Returns a RoleResponsibility instances associated with this action.

Specified by:

getRoleResponsibility in interface RoleResponsibilityActionContract

Returns:

Associated RoleResponsibility - can be null.

isForceAction

public boolean isForceAction()

Specified by:

isForceAction in interface RoleResponsibilityActionContract

Returns:

Whether this action should be is forced or not.

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet

hashCode

public int hashCode()

Description copied from interface: ModelObjectComplete

All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.

Specified by:

hashCode in interface ModelObjectComplete

Overrides:

hashCode in class Object

Returns:

the hashCode value

equals

public boolean equals(Object obj)

Description copied from interface: ModelObjectComplete

All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.

Specified by:

equals in interface ModelObjectComplete

Overrides:

equals in class Object

Parameters:

obj - to object to compare for equality

Returns:

if equal

toString

public String toString()

Description copied from interface: ModelObjectBasic

This will return a proper string representation of the Model Object. All of the fields comprising the "public" api should be represented in the return value.

Specified by:

toString in interface ModelObjectBasic

Overrides:

toString in class Object

Returns:

the string representation