org.kuali.rice.krms.api.repository

Class BaseAttribute.Builder

java.lang.Object

org.kuali.rice.krms.api.repository.BaseAttribute.Builder

All Implemented Interfaces:

Serializable, Identifiable, ModelBuilder, BaseAttributeContract

Enclosing class:

BaseAttribute

public abstract static class BaseAttribute.Builder
extends Object
implements BaseAttributeContract, ModelBuilder, Serializable

This builder is used to construct the fields that BaseAttribute is responsible for. It is abstract, and intended to be subclassed by extenders of BaseAttribute.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(BaseAttributeContract attr)
protected	Builder(String id, String attributeDefinitionId, String value) Private constructor for creating a builder with all of it's required attributes.

Method Summary

Modifier and Type	Method and Description
KrmsAttributeDefinition.Builder	getAttributeDefinition() Returns a KrmsAttributeDefinitionContract.
String	getAttributeDefinitionId() Returns the id of the attribute definition.
String	getId() The unique identifier for an object.
String	getValue() Returns the value of the attribute
void	setAttributeDefinition(KrmsAttributeDefinition.Builder attributeDefinition) Sets the attributeDefinition object related to the attribute.
void	setAttributeDefinitionId(String attributeDefinitionId) Sets the attibuteDefinitionId value.
void	setId(String id) Sets the value of the id on this builder to the given value.
void	setValue(String value) Sets the value of the attribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.core.api.mo.ModelBuilder

build

Constructor Detail

Builder

protected Builder(String id,
                  String attributeDefinitionId,
                  String value)

Private constructor for creating a builder with all of it's required attributes.

Builder

protected Builder(BaseAttributeContract attr)

Method Detail

setId

public void setId(String id)

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

Parameters:

id - the id value to set, may be null if attribute has not yet been stored in the repository

setAttributeDefinitionId

public void setAttributeDefinitionId(String attributeDefinitionId)

Sets the attibuteDefinitionId value.

Parameters:

attributeDefinitionId; - must not be null or blank

Throws:

IllegalArgumentException - if the id is null or blank

setValue

public void setValue(String value)

Sets the value of the attribute

Parameters:

value - a String representing the value of the attribute

setAttributeDefinition

public void setAttributeDefinition(KrmsAttributeDefinition.Builder attributeDefinition)

Sets the attributeDefinition object related to the attribute.

Parameters:

attributeDefinition - the attribute definition

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

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

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

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