Package org.kuali.rice.kim.api.common.attribute

Interface KimAttributeContract

All Superinterfaces:
GloballyUnique, Identifiable, Inactivatable, Versioned
All Known Implementing Classes:
KimAttribute, KimAttribute.Builder
public interface KimAttributeContract extends Versioned, GloballyUnique, Identifiable, Inactivatable
This is the contract for a KimAttribute. A KimAttribute associates categorizes an attribute and describes how to find the attribute for the purpose of the kns.

  • Method Details

    • getComponentName

      String getComponentName()
      A fully-qualified class name which contains the getAttributeName(). This cannot be null or a blank string.
      Returns:
      the name

    • getAttributeName

      String getAttributeName()
      The name of the attribute on the getComponentName(). This cannot be null or a blank string.
      Returns:
      the name

    • getNamespaceCode

      String getNamespaceCode()
      The namespace code that this kim attribute belongs too. This cannot be null or a blank string.
      Returns:
      namespace code

    • getAttributeLabel

      String getAttributeLabel()
      The label for the kim attribute. This is optional and can be null or blank.
      Returns:
      the label