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

Interface KimAttributeContract

All Superinterfaces:
org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned
All Known Implementing Classes:
KimAttribute, KimAttribute.Builder
public interface KimAttributeContract extends org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.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 Summary

    Modifier and Type
    Method
    Description
    String
    getAttributeLabel()
    The label for the kim attribute.
    String
    getAttributeName()
    The name of the attribute on the getComponentName().
    String
    getComponentName()
    A fully-qualified class name which contains the getAttributeName().
    String
    getNamespaceCode()
    The namespace code that this kim attribute belongs too.

    Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

    getObjectId

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

    getId

    Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

    isActive

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

    getVersionNumber

  • 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