Package org.kuali.rice.krms.api.repository.type

Interface KrmsAttributeDefinitionContract

All Superinterfaces:
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:
KrmsAttributeDefinition, KrmsAttributeDefinition.Builder
public interface KrmsAttributeDefinitionContract extends 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
Defines the contract for a KRMS Attribute Definition. An attribute definition contract describes an attribute and how to find the attribute for krad purposes. It has a name, namespace, label, description and associated ui component.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getComponentName()
    Returns the name of the component used to display the attribute.
    String
    getDescription()
    Returns the description of the attribute.
    String
    getLabel()
    Returns the label of this attribute definition.
    String
    getName()
    Returns the name of this attribute definition.
    String
    getNamespace()
    Returns the namespace of this attribute definition.

    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

    • getName

      String getName()
      Returns the name of this attribute definition.

      All attribute definitions have a name and namespace, so this value can not be null or blank. The combination of name and namespace must be unique within the entire KRMS system.

      Returns:
      name for this attribute definition

    • getNamespace

      String getNamespace()
      Returns the namespace of this attribute definition.

      The namespace provides scope of the the attribute definition. All attribute definition have a name and namespace, so this field may not be null or blank. The combination of name and namespace must be unique within the entire KRMS system.

      Returns:
      the namespace of this attribute definition

    • getLabel

      String getLabel()
      Returns the label of this attribute definition.

      This is an optional field and may be null or blank.

      Returns:
      the label to be used when displaying the attribute

    • getDescription

      String getDescription()
      Returns the description of the attribute.

      This is an option field and may be null or blank.

      Returns:
      a text description of the attribute

    • getComponentName

      String getComponentName()
      Returns the name of the component used to display the attribute.
      Returns:
      the component name of the of the attribute