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

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

public static final class KimType.Builder
extends Object
implements KimTypeContract, ModelBuilder, Serializable

This builder constructs an KimType enforcing the constraints of the KimTypeContract.

See Also:
Serialized Form

Method Summary
 KimType build()
          Returns an instance of the object being built by this builder based on the current state of the builder.
static KimType.Builder create()
          creates a KimType with the required fields.
static KimType.Builder create(KimTypeContract contract)
          creates a KimType from an existing KimTypeContract.
 List<KimTypeAttribute.Builder> getAttributeDefinitions()
          The list of attribute definitions associated with the kim type.
 String getId()
          The unique identifier for an object.
 String getName()
          The name of the kim type.
 String getNamespaceCode()
          The namespace code that this kim type belongs too.
 String getObjectId()
          Return the globally unique object id of this object.
 String getServiceName()
          The service name used to resolve attribute values.
 Long getVersionNumber()
          Returns the version number for this object.
 boolean isActive()
          The active indicator for an object.
 void setActive(boolean active)
           
 void setAttributeDefinitions(List<KimTypeAttribute.Builder> attributeDefinitions)
           
 void setId(String id)
           
 void setName(String name)
           
 void setNamespaceCode(String namespaceCode)
           
 void setObjectId(String objectId)
           
 void setServiceName(String serviceName)
           
 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 KimType.Builder create()
creates a KimType with the required fields.


create

public static KimType.Builder create(KimTypeContract contract)
creates a KimType from an existing KimTypeContract.


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)

getServiceName

public String getServiceName()
Description copied from interface: KimTypeContract
The service name used to resolve attribute values.

Specified by:
getServiceName in interface KimTypeContract
Returns:
the service name

setServiceName

public void setServiceName(String serviceName)

getNamespaceCode

public String getNamespaceCode()
Description copied from interface: KimTypeContract
The namespace code that this kim type belongs too.

Specified by:
getNamespaceCode in interface KimTypeContract
Returns:
namespace code

setNamespaceCode

public void setNamespaceCode(String namespaceCode)

getName

public String getName()
Description copied from interface: KimTypeContract
The name of the kim type.

Specified by:
getName in interface KimTypeContract
Returns:
the name

setName

public void setName(String name)

getAttributeDefinitions

public List<KimTypeAttribute.Builder> getAttributeDefinitions()
Description copied from interface: KimTypeContract
The list of attribute definitions associated with the kim type. This cannot be null. If no attribute definitions are associated with the kim type then this will return an empty collection.

Specified by:
getAttributeDefinitions in interface KimTypeContract
Returns:
the list of attribute definitions

setAttributeDefinitions

public void setAttributeDefinitions(List<KimTypeAttribute.Builder> attributeDefinitions)

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 KimType 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.