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

Class BaseAttribute

java.lang.Object
org.kuali.rice.core.api.mo.AbstractDataTransferObject
org.kuali.rice.krms.api.repository.BaseAttribute
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, BaseAttributeContract
public abstract class BaseAttribute extends org.kuali.rice.core.api.mo.AbstractDataTransferObject implements BaseAttributeContract
abstract base model object for KRMS Attribute immutables.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    BaseAttribute.Builder
    This builder is used to construct the fields that BaseAttribute is responsible for.
    static class 
    BaseAttribute.Elements
    A protected class which exposes constants which define the XML element names to use when this object is marshalled to XML.

    Nested classes/interfaces inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

    org.kuali.rice.core.api.mo.AbstractDataTransferObject.Constants

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    BaseAttribute()
    This constructor should only be called by the private default constructor of subclasses, which should only be used by JAXB and never invoked directly.
    protected
    BaseAttribute(BaseAttribute.Builder builder)
    Constructs a BaseAttribute from the given builder.

  • Method Summary

    Modifier and Type
    Method
    Description
    KrmsAttributeDefinition
    getAttributeDefinition()
    Returns a KrmsAttributeDefinitionContract.
    String
    getAttributeDefinitionId()
    Returns the id of the attribute definition.
    String
    getId()
     
    String
    getValue()
    Returns the value of the attribute

    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

  • Constructor Details

    • BaseAttribute

      protected BaseAttribute()
      This constructor should only be called by the private default constructor of subclasses, which should only be used by JAXB and never invoked directly.

    • BaseAttribute

      protected BaseAttribute(BaseAttribute.Builder builder)
      Constructs a BaseAttribute from the given builder. This constructor is protected and should only ever be invoked from the builder.
      Parameters:
      builder - the Builder from which to construct the BaseAttribute

  • Method Details

    • getId

      public String getId()
      Specified by:
      getId in interface org.kuali.rice.core.api.mo.common.Identifiable

    • getAttributeDefinitionId

      public String getAttributeDefinitionId()
      Description copied from interface: BaseAttributeContract
      Returns the id of the attribute definition.

      The attribute definition contains metadata about the attribute. This is a required field and may not be null or blank. Many attribute instances may share the same attribute definition.

      Specified by:
      getAttributeDefinitionId in interface BaseAttributeContract
      Returns:
      the attribute definition id

    • getValue

      public String getValue()
      Description copied from interface: BaseAttributeContract
      Returns the value of the attribute
      Specified by:
      getValue in interface BaseAttributeContract
      Returns:
      the value of the attribute

    • getAttributeDefinition

      public KrmsAttributeDefinition getAttributeDefinition()
      Description copied from interface: BaseAttributeContract
      Returns a KrmsAttributeDefinitionContract.

      This is the object referred to by the attributeDefinitionId. The full object is also kept here for performance purposes. This is because the name of the attribute is referenced often for resolving name / value attribute pairs.

      Specified by:
      getAttributeDefinition in interface BaseAttributeContract
      Returns:
      the attribute definition