Package 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, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.core.api.mo.ModelObjectComplete, TemplateContract

public final class Template
extends org.kuali.rice.core.api.mo.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

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
String	getDescription()	The description of the KIM Permission Template.
String	getId()
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()
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 org.kuali.rice.core.api.mo.common.Identifiable

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

Specified by:

isActive in interface org.kuali.rice.core.api.mo.common.active.Inactivatable

See Also:

• Inactivatable.isActive()

getVersionNumber

public Long getVersionNumber()

Specified by:

getVersionNumber in interface org.kuali.rice.core.api.mo.common.Versioned

See Also:

• Versioned.getVersionNumber()

getObjectId

public String getObjectId()

Specified by:

getObjectId in interface org.kuali.rice.core.api.mo.common.GloballyUnique

See Also:

• GloballyUnique.getObjectId()