Package org.kuali.rice.kim.api.type

Class KimAttributeField

java.lang.Object
org.kuali.rice.core.api.mo.AbstractDataTransferObject
org.kuali.rice.kim.api.type.KimAttributeField
All Implemented Interfaces:
Serializable, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.core.api.mo.ModelObjectComplete, KimAttributeFieldContract
public final class KimAttributeField extends org.kuali.rice.core.api.mo.AbstractDataTransferObject implements KimAttributeFieldContract
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    KimAttributeField.Builder
    A builder which can be used to construct KimAttributeField instances.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    org.kuali.rice.core.api.uif.RemotableAttributeField
    getAttributeField()
    Gets the attribute field definition.
    String
    getId()
     
    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 Details

    • getAttributeField

      public org.kuali.rice.core.api.uif.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()
      Specified by:
      getId in interface org.kuali.rice.core.api.mo.common.Identifiable

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