org.kuali.rice.kim.api.identity
Class CodedAttribute.Builder

java.lang.Object
  org.kuali.rice.kim.api.identity.CodedAttribute.Builder

All Implemented Interfaces:

Serializable, Inactivatable, Coded, GloballyUnique, Versioned, ModelBuilder, CodedAttributeContract

Enclosing class:

CodedAttribute

public static final class CodedAttribute.Builder
extends Object
implements Serializable, ModelBuilder, CodedAttributeContract

A builder which can be used to construct CodedAttribute instances. Enforces the constraints of the CodedAttributeContract.

See Also:

Serialized Form

Method Summary

CodedAttribute	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static CodedAttribute.Builder	create(CodedAttributeContract contract)
static CodedAttribute.Builder	create(String code)
String	getCode() The code value for this object.
String	getName() This the name for the AddressType.
String	getObjectId() Return the globally unique object id of this object.
String	getSortCode() This the sort code for the AddressType.
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.
void	setActive(boolean active)
void	setCode(String code)
void	setName(String name)
void	setObjectId(String objectId)
void	setSortCode(String sortCode)
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 CodedAttribute.Builder create(String code)

create

public static CodedAttribute.Builder create(CodedAttributeContract contract)

build

public CodedAttribute 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

getName

public String getName()

Description copied from interface: CodedAttributeContract

This the name for the AddressType. This can be null or a blank string.

Specified by:

getName in interface CodedAttributeContract

Returns:

the name of the AddressType

getCode

public String getCode()

Description copied from interface: Coded

The code value for this object. In general a code value cannot be null or a blank string.

Specified by:

getCode in interface Coded

Returns:

the code value for this object.

getSortCode

public String getSortCode()

Description copied from interface: CodedAttributeContract

This the sort code for the AddressType. This can be null or a blank string.

Specified by:

getSortCode in interface CodedAttributeContract

Returns:

the sort code of the AddressType

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

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

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.

setName

public void setName(String name)

setCode

public void setCode(String code)

setSortCode

public void setSortCode(String sortCode)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)

setActive

public void setActive(boolean active)