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

java.lang.Object
  extended by org.kuali.rice.krms.api.repository.language.NaturalLanguageTemplateAttribute.Builder
All Implemented Interfaces:
Serializable, Identifiable, Versioned, ModelBuilder, BaseAttributeContract, NaturalLanguageTemplateAttributeContract
Enclosing class:
NaturalLanguageTemplateAttribute

public static final class NaturalLanguageTemplateAttribute.Builder
extends Object
implements Serializable, ModelBuilder, NaturalLanguageTemplateAttributeContract

A builder which can be used to construct NaturalLanguageTemplateAttribute instances. Enforces the constraints of the NaturalLanguageTemplateAttributeContract.

See Also:
Serialized Form

Method Summary
 NaturalLanguageTemplateAttribute build()
          Builds an instance of a NaturalLanguageTemplateAttribute based on the current state of the builder.
static NaturalLanguageTemplateAttribute.Builder create()
           
static NaturalLanguageTemplateAttribute.Builder create(NaturalLanguageTemplateAttributeContract contract)
           
 KrmsAttributeDefinition.Builder getAttributeDefinition()
          Returns a KrmsAttributeDefinitionContract.
 String getAttributeDefinitionId()
          Returns the id of the attribute definition.
 String getId()
          The unique identifier for an object.
 String getNaturalLanguageTemplateId()
          This is the NaturalLanguageTemplateId of the NaturalLanguageTemplateAttribute
 String getValue()
          Returns the value of the attribute
 Long getVersionNumber()
          Returns the version number for this object.
 void setAttributeDefinition(KrmsAttributeDefinition.Builder attributeDefinition)
           
 void setAttributeDefinitionId(String attributeDefinitionId)
          Sets the value of attributeDefinitionId on this builder to the given value.
 void setId(String id)
          Sets the value of id on this builder to the given value.
 void setNaturalLanguageTemplateId(String naturalLanguageTemplateId)
          Sets the value of naturalLanguageTemplateId on this builder to the given value.
 void setValue(String value)
          Sets the value of value 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 NaturalLanguageTemplateAttribute.Builder create()

create

public static NaturalLanguageTemplateAttribute.Builder create(NaturalLanguageTemplateAttributeContract contract)

build

public NaturalLanguageTemplateAttribute build()
Builds an instance of a NaturalLanguageTemplateAttribute based on the current state of the builder.

Specified by:
build in interface ModelBuilder
Returns:
the fully-constructed NaturalLanguageTemplateAttribute.

getAttributeDefinition

public KrmsAttributeDefinition.Builder getAttributeDefinition()
Description copied from interface: BaseAttributeContract
Returns a KrmsAttributeDefinitionContract.

This is the object referred to by the attributeDefinitionId. The full object is also kept here for performance purposes. This is because the name of the attribute is referenced often for resolving name / value attribute pairs.

Specified by:
getAttributeDefinition in interface BaseAttributeContract
Returns:
the attribute definition

getAttributeDefinitionId

public String getAttributeDefinitionId()
Description copied from interface: BaseAttributeContract
Returns the id of the attribute definition.

The attribute definition contains metadata about the attribute. This is a required field and may not be null or blank. Many attribute instances may share the same attribute definition.

Specified by:
getAttributeDefinitionId in interface BaseAttributeContract
Returns:
the attribute definition id

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

getNaturalLanguageTemplateId

public String getNaturalLanguageTemplateId()
Description copied from interface: NaturalLanguageTemplateAttributeContract
This is the NaturalLanguageTemplateId of the NaturalLanguageTemplateAttribute

The NaturalLanguageTemplateId of the NaturalLanguageTemplateAttribute

Specified by:
getNaturalLanguageTemplateId in interface NaturalLanguageTemplateAttributeContract
Returns:
the NaturalLanguageTemplateId of the NaturalLanguageTemplateAttribute

getValue

public String getValue()
Description copied from interface: BaseAttributeContract
Returns the value of the attribute

Specified by:
getValue in interface BaseAttributeContract
Returns:
the value of the attribute

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

setAttributeDefinition

public void setAttributeDefinition(KrmsAttributeDefinition.Builder attributeDefinition)

setAttributeDefinitionId

public void setAttributeDefinitionId(String attributeDefinitionId)
Sets the value of attributeDefinitionId on this builder to the given value.

Parameters:
attributeDefinitionId - the attributeDefinitionId 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

setNaturalLanguageTemplateId

public void setNaturalLanguageTemplateId(String naturalLanguageTemplateId)
Sets the value of naturalLanguageTemplateId on this builder to the given value.

Parameters:
naturalLanguageTemplateId - the naturalLanguageTemplateId value to set.

setValue

public void setValue(String value)
Sets the value of value on this builder to the given value.

Parameters:
value - the value value to set.

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.


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.