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

java.lang.Object
  extended by org.kuali.rice.kim.api.type.KimAttributeField.Builder
All Implemented Interfaces:
Serializable, Identifiable, ModelBuilder, KimAttributeFieldContract
Enclosing class:
KimAttributeField

public static final class KimAttributeField.Builder
extends Object
implements Serializable, ModelBuilder, KimAttributeFieldContract

A builder which can be used to construct KimAttributeField instances. Enforces the constraints of the KimAttributeFieldContract.

See Also:
Serialized Form

Method Summary
 KimAttributeField build()
          Returns an instance of the object being built by this builder based on the current state of the builder.
static KimAttributeField.Builder create(KimAttributeFieldContract contract)
           
static KimAttributeField.Builder create(RemotableAttributeField.Builder attributeField, String id)
           
 RemotableAttributeField.Builder getAttributeField()
          Gets the attribute field definition.
 String getId()
          The unique identifier for an object.
 boolean isUnique()
          Whether the attribute is a "unique" attribute according to KIM
 void setAttributeField(RemotableAttributeField.Builder attributeField)
           
 void setId(String id)
           
 void setUnique(boolean unique)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public static KimAttributeField.Builder create(RemotableAttributeField.Builder attributeField,
                                               String id)

create

public static KimAttributeField.Builder create(KimAttributeFieldContract contract)

build

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

getAttributeField

public RemotableAttributeField.Builder getAttributeField()
Description copied from interface: KimAttributeFieldContract
Gets the attribute field definition. Cannot be null.

Specified by:
getAttributeField in interface KimAttributeFieldContract
Returns:
the field

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

isUnique

public boolean isUnique()
Description copied from interface: KimAttributeFieldContract
Whether the attribute is a "unique" attribute according to KIM

Specified by:
isUnique in interface KimAttributeFieldContract
Returns:
unique status

setAttributeField

public void setAttributeField(RemotableAttributeField.Builder attributeField)

setId

public void setId(String id)

setUnique

public void setUnique(boolean unique)


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