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

java.lang.Object
  extended by org.kuali.rice.core.api.mo.AbstractDataTransferObject
      extended by org.kuali.rice.kim.api.type.KimAttributeField
All Implemented Interfaces:
Serializable, Identifiable, ModelObjectBasic, ModelObjectComplete, KimAttributeFieldContract

public final class KimAttributeField
extends AbstractDataTransferObject
implements KimAttributeFieldContract

See Also:
Serialized Form

Nested Class Summary
static class KimAttributeField.Builder
          A builder which can be used to construct KimAttributeField instances.
 
Method Summary
static KimAttributeField findAttribute(String attributeName, Collection<KimAttributeField> fields)
          Utility method to search a collection of attribute fields and returns a field for a give attribute name.
 RemotableAttributeField 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
 
Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject
afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

getAttributeField

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

findAttribute

public static KimAttributeField findAttribute(String attributeName,
                                              Collection<KimAttributeField> fields)
Utility method to search a collection of attribute fields and returns a field for a give attribute name.

Parameters:
attributeName - the name of the attribute to search for. Cannot be blank or null.
fields - cannot be null.
Returns:
the attribute field or null if not found.


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