org.kuali.rice.kim.api.type
Class KimTypeAttribute.Builder

java.lang.Object
  extended by org.kuali.rice.kim.api.type.KimTypeAttribute.Builder
All Implemented Interfaces:
Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelBuilder, KimTypeAttributeContract
Enclosing class:
KimTypeAttribute

public static final class KimTypeAttribute.Builder
extends Object
implements KimTypeAttributeContract, ModelBuilder, Serializable

This builder constructs an KimTypeAttribute enforcing the constraints of the KimTypeAttributeContract.

See Also:
Serialized Form

Method Summary
 KimTypeAttribute build()
          Returns an instance of the object being built by this builder based on the current state of the builder.
static KimTypeAttribute.Builder create()
          creates a KimTypeAttribute with the required fields.
static KimTypeAttribute.Builder create(KimTypeAttributeContract contract)
          creates a KimTypeAttribute from an existing KimTypeAttributeContract.
 String getId()
          The unique identifier for an object.
 KimAttribute.Builder getKimAttribute()
          The kim attribute associated with the kim type attribute.
 String getKimTypeId()
          The kim type id associated with the kim type attribute.
 String getObjectId()
          Return the globally unique object id of this object.
 String getSortCode()
          The alpha and/or numeric code used to choose an order for displaying KimTypeAttributes.
 Long getVersionNumber()
          Returns the version number for this object.
 boolean isActive()
          The active indicator for an object.
 void setActive(boolean active)
           
 void setId(String id)
           
 void setKimAttribute(KimAttribute.Builder kimAttribute)
           
 void setKimTypeId(String kimTypeId)
           
 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 KimTypeAttribute.Builder create()
creates a KimTypeAttribute with the required fields.


create

public static KimTypeAttribute.Builder create(KimTypeAttributeContract contract)
creates a KimTypeAttribute from an existing KimTypeAttributeContract.


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)

getSortCode

public String getSortCode()
Description copied from interface: KimTypeAttributeContract
The alpha and/or numeric code used to choose an order for displaying KimTypeAttributes. This can be null or blank.

Specified by:
getSortCode in interface KimTypeAttributeContract
Returns:
the sort code.

setSortCode

public void setSortCode(String sortCode)

getKimAttribute

public KimAttribute.Builder getKimAttribute()
Description copied from interface: KimTypeAttributeContract
The kim attribute associated with the kim type attribute. This can be null if no KimAttributes are associated.

Specified by:
getKimAttribute in interface KimTypeAttributeContract
Returns:
the kim attribute

setKimAttribute

public void setKimAttribute(KimAttribute.Builder kimAttribute)

getKimTypeId

public String getKimTypeId()
Description copied from interface: KimTypeAttributeContract
The kim type id associated with the kim type attribute. This can be null if no KimType is associated.

Specified by:
getKimTypeId in interface KimTypeAttributeContract
Returns:
the kim type id

setKimTypeId

public void setKimTypeId(String kimTypeId)

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.

setActive

public void setActive(boolean active)

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 KimTypeAttribute 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


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