org.kuali.rice.kim.api.permission
Class Permission

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kim.api.permission.Permission

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, PermissionContract

public final class Permission
extends AbstractDataTransferObject
implements PermissionContract

An immutable representation of a PermissionContract.

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

See Also:

PermissionContract, Serialized Form

Nested Class Summary

static class	Permission.Builder This builder constructs a Permission enforcing the constraints of the PermissionContract.
static class	Permission.Cache

Method Summary

Map<String,String>	getAttributes() Attributes for a Permission.
String	getDescription() The description of the Permission.
String	getId() The unique identifier for an object.
String	getName() The name of the Permission.
String	getNamespaceCode() The namespace code that this Permission belongs too.
String	getObjectId() Return the globally unique object id of this object.
Template	getTemplate() The Template referenced by the Permission.
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: PermissionContract

The namespace code that this Permission belongs too.

Specified by:

getNamespaceCode in interface PermissionContract

Returns:

namespaceCode

See Also:

PermissionContract.getNamespaceCode()

getName

public String getName()

Description copied from interface: PermissionContract

The name of the Permission.

Specified by:

getName in interface PermissionContract

Returns:

name

See Also:

PermissionContract.getName()

getDescription

public String getDescription()

Description copied from interface: PermissionContract

The description of the Permission.

Specified by:

getDescription in interface PermissionContract

Returns:

description

See Also:

PermissionContract.getDescription()

getTemplate

public Template getTemplate()

Description copied from interface: PermissionContract

The Template referenced by the Permission.

Specified by:

getTemplate in interface PermissionContract

Returns:

templateId

See Also:

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

Attributes for a Permission.

Specified by:

getAttributes in interface PermissionContract

Returns:

attributes

See Also:

PermissionContract.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()