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

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

All Implemented Interfaces:

Serializable, Inactivatable, Versioned, ModelObjectBasic, ModelObjectComplete, RoleResponsibilityContract

public final class RoleResponsibility
extends Object
implements RoleResponsibilityContract, ModelObjectComplete

An lightweight association of a Responsibility and a Role represented by references to the identifiers of a Role and a Responsibility that are related to each other.

Author:

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

See Also:

Serialized Form

Nested Class Summary

static class	RoleResponsibility.Builder
(package private) static class	RoleResponsibility.Constants Defines some internal constants used on this class.
(package private) static class	RoleResponsibility.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 boolean	active
private String	responsibilityId
private String	roleId
private String	roleResponsibilityId
private static long	serialVersionUID
private Long	versionNumber

Constructor Summary

private	RoleResponsibility() This constructor should never be called except during JAXB unmarshalling.
private	RoleResponsibility(RoleResponsibility.Builder b)

Method Summary

boolean	equals(Object obj) All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.
String	getResponsibilityId() Returns the String identifier for the Responsibility represented by this Role/Responsibility association.
String	getRoleId() Returns the String identifier for the Role represented by this Role/Responsibility association.
String	getRoleResponsibilityId() Provides the String identifier for a given RoleResponsibility
Long	getVersionNumber() Returns the version number for this object.
int	hashCode() All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.
boolean	isActive() Returns a boolean value determining if the Object is Active or not.
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

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

roleResponsibilityId

private final String roleResponsibilityId

roleId

private final String roleId

responsibilityId

private final String responsibilityId

active

private final boolean active

versionNumber

private final Long versionNumber

_futureElements

private final Collection<Element> _futureElements

Constructor Detail

RoleResponsibility

private RoleResponsibility()

This constructor should never be called except during JAXB unmarshalling.

RoleResponsibility

private RoleResponsibility(RoleResponsibility.Builder b)

Method Detail

getResponsibilityId

public String getResponsibilityId()

Description copied from interface: RoleResponsibilityContract

Returns the String identifier for the Responsibility represented by this Role/Responsibility association.

Specified by:

getResponsibilityId in interface RoleResponsibilityContract

Returns:

Responsibility Id

getRoleId

public String getRoleId()

Description copied from interface: RoleResponsibilityContract

Returns the String identifier for the Role represented by this Role/Responsibility association.

Specified by:

getRoleId in interface RoleResponsibilityContract

Returns:

Role Id

getRoleResponsibilityId

public String getRoleResponsibilityId()

Description copied from interface: RoleResponsibilityContract

Provides the String identifier for a given RoleResponsibility

Specified by:

getRoleResponsibilityId in interface RoleResponsibilityContract

Returns:

id of the Role/Responsibility contract

isActive

public boolean isActive()

Description copied from interface: Inactivatable

Returns a boolean value determining if the Object is Active or not.

Specified by:

isActive in interface Inactivatable

Returns:

the active indicator

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