org.kuali.rice.kim.api.common.attribute

Class KimAttributeData.Builder

java.lang.Object

org.kuali.rice.kim.api.common.attribute.KimAttributeData.Builder

All Implemented Interfaces:

Serializable, GloballyUnique, Identifiable, Versioned, ModelBuilder, KimAttributeDataContract

Enclosing class:

KimAttributeData

public static final class KimAttributeData.Builder
extends Object
implements KimAttributeDataContract, ModelBuilder, Serializable

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
KimAttributeData	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static KimAttributeData.Builder	create(KimAttributeDataContract contract) creates a KimAttributeData from an existing KimAttributeContract
static KimAttributeData.Builder	create(String kimTypeId) creates a Parameter with the required fields.
String	getAssignedToId() The id of the object this AttributeData is associated with.
String	getAttributeValue() The attribute value.
String	getId() The unique identifier for an object.
KimAttribute.Builder	getKimAttribute() The kim attribute associated with the kim attribute data.
KimType.Builder	getKimType() The kim type associated with the kim attribute data.
String	getKimTypeId() The kim type id associated with the kim attribute data.
String	getObjectId() Return the globally unique object id of this object.
Long	getVersionNumber() Returns the version number for this object.
void	setAssignedToId(String assignedToId)
void	setId(String id)
void	setKimAttribute(KimAttribute.Builder kimAttribute)
void	setKimType(KimType.Builder kimType)
void	setKimTypeId(String kimTypeId)
void	setObjectId(String objectId)
void	setValue(String attributeValue)
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 KimAttributeData.Builder create(String kimTypeId)

creates a Parameter with the required fields.

create

public static KimAttributeData.Builder create(KimAttributeDataContract contract)

creates a KimAttributeData from an existing KimAttributeContract

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

setId

public void setId(String id)

getAssignedToId

public String getAssignedToId()

Description copied from interface: KimAttributeDataContract

The id of the object this AttributeData is associated with. For example: this could be a permissionId, roleId, groupId, or responsibilityId.

Specified by:

getAssignedToId in interface KimAttributeDataContract

Returns:

the id

setAssignedToId

public void setAssignedToId(String assignedToId)

getKimTypeId

public String getKimTypeId()

Description copied from interface: KimAttributeDataContract

The kim type id associated with the kim attribute data. This can be null if no kim types are associated.

Specified by:

getKimTypeId in interface KimAttributeDataContract

Returns:

the kim type id

setKimTypeId

public void setKimTypeId(String kimTypeId)

getKimType

public KimType.Builder getKimType()

Description copied from interface: KimAttributeDataContract

The kim type associated with the kim attribute data. This can be null if no kim types are associated.

Specified by:

getKimType in interface KimAttributeDataContract

Returns:

the kim type

setKimType

public void setKimType(KimType.Builder kimType)

getKimAttribute

public KimAttribute.Builder getKimAttribute()

Description copied from interface: KimAttributeDataContract

The kim attribute associated with the kim attribute data. This can be null if no KimAttributes are associated.

Specified by:

getKimAttribute in interface KimAttributeDataContract

Returns:

the kim attribute

setKimAttribute

public void setKimAttribute(KimAttribute.Builder kimAttribute)

getAttributeValue

public String getAttributeValue()

Description copied from interface: KimAttributeDataContract

The attribute value. This can be null or blank.

Specified by:

getAttributeValue in interface KimAttributeDataContract

Returns:

the attribute value.

setValue

public void setValue(String attributeValue)

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

setVersionNumber

public void setVersionNumber(Long versionNumber)

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

setObjectId

public void setObjectId(String objectId)

build

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