org.kuali.rice.kim.api.responsibility
Class Responsibility

java.lang.Object
  extended by org.kuali.rice.core.api.mo.AbstractDataTransferObject
      extended by org.kuali.rice.kim.api.responsibility.Responsibility
All Implemented Interfaces:
Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, ResponsibilityContract

public final class Responsibility
extends AbstractDataTransferObject
implements ResponsibilityContract

An immutable representation of a ResponsibilityContract.

To construct an instance of a Permission, use the Responsibility.Builder class.

See Also:
ResponsibilityContract, Serialized Form

Nested Class Summary
static class Responsibility.Builder
          This builder constructs a Responsibility enforcing the constraints of the ResponsibilityContract.
static class Responsibility.Cache
           
 
Method Summary
 Map<String,String> getAttributes()
          Attributes for a Responsibility.
 String getDescription()
          The description of the Responsibility.
 String getId()
          The unique identifier for an object.
 String getName()
          The name of the Responsibility.
 String getNamespaceCode()
          The namespace code that this Responsibility belongs too.
 String getObjectId()
          Return the globally unique object id of this object.
 Template getTemplate()
          The Template referenced by the Responsibility.
 Long getVersionNumber()
          Returns the version number for this object.
 boolean isActive()
          The active indicator for an object.
 
Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject
afterUnmarshal, beforeUnmarshal, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

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
See Also:
Identifiable.getId()

getNamespaceCode

public String getNamespaceCode()
Description copied from interface: ResponsibilityContract
The namespace code that this Responsibility belongs too.

Specified by:
getNamespaceCode in interface ResponsibilityContract
Returns:
namespaceCode
See Also:
ResponsibilityContract.getNamespaceCode()

getName

public String getName()
Description copied from interface: ResponsibilityContract
The name of the Responsibility.

Specified by:
getName in interface ResponsibilityContract
Returns:
name
See Also:
ResponsibilityContract.getName()

getDescription

public String getDescription()
Description copied from interface: ResponsibilityContract
The description of the Responsibility.

Specified by:
getDescription in interface ResponsibilityContract
Returns:
description
See Also:
ResponsibilityContract.getDescription()

getTemplate

public Template getTemplate()
Description copied from interface: ResponsibilityContract
The Template referenced by the Responsibility.

Specified by:
getTemplate in interface ResponsibilityContract
Returns:
templateId
See Also:
ResponsibilityContract.getTemplate()

isActive

public boolean isActive()
Description copied from interface: Inactivatable
The active indicator for an object.

Specified by:
isActive in interface Inactivatable
Returns:
true if active false if not.
See Also:
Inactivatable.isActive()

getAttributes

public Map<String,String> getAttributes()
Description copied from interface: ResponsibilityContract
Attributes for a Responsibility.

Specified by:
getAttributes in interface ResponsibilityContract
Returns:
attributes
See Also:
ResponsibilityContract.getAttributes()

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
See Also:
Versioned.getVersionNumber()

getObjectId

public String getObjectId()
Description copied from interface: GloballyUnique
Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.

Specified by:
getObjectId in interface GloballyUnique
Returns:
the objectId of this object, or null if it has not been set yet
See Also:
GloballyUnique.getObjectId()


Copyright © 2005-2011 The Kuali Foundation. All Rights Reserved.