org.kuali.rice.kim.api.common.template
Class Template

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kim.api.common.template.Template

All Implemented Interfaces:

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

public final class Template
extends AbstractDataTransferObject
implements TemplateContract

An immutable representation of a TemplateContract.

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

See Also:

Serialized Form

Nested Class Summary

static class	Template.Builder This builder constructs a Template enforcing the constraints of the TemplateContract.
static class	Template.Cache

Method Summary

String	getDescription() The description of the KIM Permission Template.
String	getId() The unique identifier for an object.
String	getKimTypeId() The KIM Type ID referenced by the KIM Permission Template.
String	getName() The name of the KIM Permission Template.
String	getNamespaceCode() The namespace code that this KIM Permission Template belongs too.
String	getObjectId() Return the globally unique object id of this object.
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: TemplateContract

The namespace code that this KIM Permission Template belongs too.

Specified by:

getNamespaceCode in interface TemplateContract

Returns:

namespaceCode

See Also:

TemplateContract.getNamespaceCode()

getName

public String getName()

Description copied from interface: TemplateContract

The name of the KIM Permission Template.

Specified by:

getName in interface TemplateContract

Returns:

name

See Also:

TemplateContract.getName()

getDescription

public String getDescription()

Description copied from interface: TemplateContract

The description of the KIM Permission Template.

Specified by:

getDescription in interface TemplateContract

Returns:

description

See Also:

TemplateContract.getDescription()

getKimTypeId

public String getKimTypeId()

Description copied from interface: TemplateContract

The KIM Type ID referenced by the KIM Permission Template.

Specified by:

getKimTypeId in interface TemplateContract

Returns:

typeId

See Also:

TemplateContract.getKimTypeId()

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

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