org.kuali.rice.krms.api.repository.language

Class NaturalLanguageTemplate

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.krms.api.repository.language.NaturalLanguageTemplate

All Implemented Interfaces:

Serializable, Inactivatable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, NaturalLanguageTemplateContract

public final class NaturalLanguageTemplate
extends AbstractDataTransferObject
implements NaturalLanguageTemplateContract

Generated using JVM arguments -DNOT_BLANK=languageCode,naturalLanguageUsageId,typeId,template -DFOREIGN_KEY=naturalLanguageUsageId:org.kuali.rice.krms.api.repository.language.NaturalLanguageUsage,typeId:org.kuali.rice.krms.api.repository.type.KrmsTypeDefinition Concrete model object implementation, immutable. Instances can be (un)marshalled to and from XML.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

NaturalLanguageTemplateContract, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NaturalLanguageTemplate.Builder A builder which can be used to construct NaturalLanguageTemplate instances.
static class	NaturalLanguageTemplate.Cache

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getAttributes() This method returns a list of custom/remote attributes associated with the agenda.
String	getId() The unique identifier for an object.
String	getLanguageCode() This is the Language Code of the NaturalLanguageTemplate
String	getNaturalLanguageUsageId() This is the NaturalLanguageUsageId of the NaturalLanguageTemplate
String	getTemplate() This is the Template of the NaturalLanguageTemplate
String	getTypeId() This is the TypeId of the NaturalLanguageTemplate
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, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

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

Method Detail

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: NaturalLanguageTemplateContract

This method returns a list of custom/remote attributes associated with the agenda.

The attributes of the NaturalLanguageUsage

Specified by:

getAttributes in interface NaturalLanguageTemplateContract

Returns:

a list of custom/remote attribute of the agenda.

getLanguageCode

public String getLanguageCode()

Description copied from interface: NaturalLanguageTemplateContract

This is the Language Code of the NaturalLanguageTemplate

The Language Code of the NaturalLanguageTemplate

Specified by:

getLanguageCode in interface NaturalLanguageTemplateContract

Returns:

the Language Code of the NaturalLanguageTemplate

getNaturalLanguageUsageId

public String getNaturalLanguageUsageId()

Description copied from interface: NaturalLanguageTemplateContract

This is the NaturalLanguageUsageId of the NaturalLanguageTemplate

The NaturalLanguageUsageId of the NaturalLanguageTemplate

Specified by:

getNaturalLanguageUsageId in interface NaturalLanguageTemplateContract

Returns:

the NaturalLanguageUsageId of the NaturalLanguageTemplate

getTypeId

public String getTypeId()

Description copied from interface: NaturalLanguageTemplateContract

This is the TypeId of the NaturalLanguageTemplate

The TypeId of the NaturalLanguageTemplate

Specified by:

getTypeId in interface NaturalLanguageTemplateContract

Returns:

the TypeId of the NaturalLanguageTemplate

getTemplate

public String getTemplate()

Description copied from interface: NaturalLanguageTemplateContract

This is the Template of the NaturalLanguageTemplate

The Template of the NaturalLanguageTemplate

Specified by:

getTemplate in interface NaturalLanguageTemplateContract

Returns:

the Template of the NaturalLanguageTemplate

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

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.

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