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

Class Template.Builder

java.lang.Object

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

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelBuilder, TemplateContract

Enclosing class:

Template

public static final class Template.Builder
extends Object
implements TemplateContract, ModelBuilder, Serializable

This builder constructs a Template enforcing the constraints of the TemplateContract.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
Template	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static Template.Builder	create(String namespaceCode, String name, String kimTypeId) creates a KimPermission with the required fields.
static Template.Builder	create(TemplateContract contract) creates a KimPermission from an existing TemplateContract.
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.
void	setActive(boolean active)
void	setDescription(String description)
void	setId(String id)
void	setKimTypeId(String kimTypeId)
void	setName(String name)
void	setNamespaceCode(String namespaceCode)
void	setObjectId(String objectId)
void	setVersionNumber(Long versionNumber)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Template.Builder create(String namespaceCode,
                                      String name,
                                      String kimTypeId)

creates a KimPermission with the required fields.

create

public static Template.Builder create(TemplateContract contract)

creates a KimPermission from an existing TemplateContract.

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

setId

public void setId(String id)

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

setNamespaceCode

public void setNamespaceCode(String namespaceCode)

getName

public String getName()

Description copied from interface: TemplateContract

The name of the KIM Permission Template.

Specified by:

getName in interface TemplateContract

Returns:

name

setName

public void setName(String name)

getDescription

public String getDescription()

Description copied from interface: TemplateContract

The description of the KIM Permission Template.

Specified by:

getDescription in interface TemplateContract

Returns:

description

setDescription

public void setDescription(String description)

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

setKimTypeId

public void setKimTypeId(String kimTypeId)

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.

setActive

public void setActive(boolean active)

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

setVersionNumber

public void setVersionNumber(Long versionNumber)

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

setObjectId

public void setObjectId(String objectId)

build

public Template build()

Description copied from interface: ModelBuilder

Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:

build in interface ModelBuilder

Returns:

an instance of the object being built by this builder, should never return null