Package 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

Nested Classes

Modifier and Type	Class	Description
static final class	Permission.Builder	This builder constructs a Permission enforcing the constraints of the PermissionContract.
static class	Permission.Cache

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getAttributes()	Attributes for a Permission.
String	getDescription()	The description of the Permission.
String	getId()
String	getName()	The name of the Permission.
String	getNamespaceCode()	The namespace code that this Permission belongs too.
String	getObjectId()
Template	getTemplate()	The Template referenced by the Permission.
Long	getVersionNumber()
boolean	isActive()

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

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

Method Details

getId

public String getId()

Specified by:

getId in interface Identifiable

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

Specified by:

isActive in interface Inactivatable

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

Specified by:

getVersionNumber in interface Versioned

See Also:

• Versioned.getVersionNumber()

getObjectId

public String getObjectId()

Specified by:

getObjectId in interface GloballyUnique

See Also:

• GloballyUnique.getObjectId()