org.kuali.rice.krms.api.repository.language
Class NaturalLanguageUsage.Builder

java.lang.Object
  org.kuali.rice.krms.api.repository.language.NaturalLanguageUsage.Builder

All Implemented Interfaces:

Serializable, Inactivatable, Identifiable, Versioned, ModelBuilder, NaturalLanguageUsageContract

Enclosing class:

NaturalLanguageUsage

public static final class NaturalLanguageUsage.Builder
extends Object
implements Serializable, ModelBuilder, NaturalLanguageUsageContract

A builder which can be used to construct NaturalLanguageUsage instances. Enforces the constraints of the NaturalLanguageUsageContract.

See Also:

Serialized Form

Method Summary

NaturalLanguageUsage	build() Builds an instance of a NaturalLanguageUsage based on the current state of the builder.
static NaturalLanguageUsage.Builder	create(NaturalLanguageUsageContract contract)
static NaturalLanguageUsage.Builder	create(String name, String namespace)
String	getDescription() This is the Description of the NaturalLanguageUsage
String	getId() The unique identifier for an object.
String	getName() This is the name of the NaturalLanguageUsage
String	getNamespace() This is the namespace of the NaturalLanguageUsage
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.
void	setActive(boolean active) Sets the value of active on this builder to the given value.
void	setDescription(String description) Sets the value of description on this builder to the given value.
void	setId(String id) Sets the value of id on this builder to the given value.
void	setName(String name) Sets the value of name on this builder to the given value.
void	setNamespace(String namespace) Sets the value of namespace on this builder to the given value.
void	setVersionNumber(Long versionNumber) Sets the value of versionNumber on this builder to the given value.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static NaturalLanguageUsage.Builder create(String name,
                                                  String namespace)

create

public static NaturalLanguageUsage.Builder create(NaturalLanguageUsageContract contract)

build

public NaturalLanguageUsage build()

Builds an instance of a NaturalLanguageUsage based on the current state of the builder.

Specified by:

build in interface ModelBuilder

Returns:

the fully-constructed NaturalLanguageUsage.

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.

getDescription

public String getDescription()

Description copied from interface: NaturalLanguageUsageContract

This is the Description of the NaturalLanguageUsage

The Description of the NaturalLanguageUsage

Specified by:

getDescription in interface NaturalLanguageUsageContract

Returns:

the Description of the NaturalLanguageUsage

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

getName

public String getName()

Description copied from interface: NaturalLanguageUsageContract

This is the name of the NaturalLanguageUsage

The name of the NaturalLanguageUsage

Specified by:

getName in interface NaturalLanguageUsageContract

Returns:

the name of the NaturalLanguageUsage

getNamespace

public String getNamespace()

Description copied from interface: NaturalLanguageUsageContract

This is the namespace of the NaturalLanguageUsage

The namespace of the NaturalLanguageUsage

Specified by:

getNamespace in interface NaturalLanguageUsageContract

Returns:

the namespace of the NaturalLanguageUsage

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

setActive

public void setActive(boolean active)

Sets the value of active on this builder to the given value.

Parameters:

active - the active value to set.

setDescription

public void setDescription(String description)

Sets the value of description on this builder to the given value.

Parameters:

description - the description value to set.

setId

public void setId(String id)

Sets the value of id on this builder to the given value.

Parameters:

id - the id value to set., may be null, representing the Object has not been persisted, but must not be blank.

Throws:

IllegalArgumentException - if the id is blank

setName

public void setName(String name)

Sets the value of name on this builder to the given value.

Parameters:

name - the name value to set., must not be null or blank

Throws:

IllegalArgumentException - if the name is null or blank

setNamespace

public void setNamespace(String namespace)

Sets the value of namespace on this builder to the given value.

Parameters:

namespace - the namespace value to set., must not be null or blank

Throws:

IllegalArgumentException - if the namespace is null or blank

setVersionNumber

public void setVersionNumber(Long versionNumber)

Sets the value of versionNumber on this builder to the given value.

Parameters:

versionNumber - the versionNumber value to set.