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

Class KrmsTypeAttribute

java.lang.Object
org.kuali.rice.core.api.mo.AbstractDataTransferObject
org.kuali.rice.krms.api.repository.type.KrmsTypeAttribute
All Implemented Interfaces:
Serializable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.core.api.mo.ModelObjectComplete, KrmsTypeAttributeContract
public final class KrmsTypeAttribute extends org.kuali.rice.core.api.mo.AbstractDataTransferObject implements KrmsTypeAttributeContract
Concrete model object implementation of KRMS KrmsTypeAttributeContract

immutable. To construct an instance of a KrmsTypeAttribute, use the KrmsTypeAttribute.Builder class. Instances of KrmsTypeAttribute can be (un)marshalled to and from XML.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    KrmsTypeAttribute.Builder
    This builder is used to construct instances of KrmsTypeAttribute.
    static class 
    KrmsTypeAttribute.Elements
    A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAttributeDefinitionId()
    Returns the id of the KrmsAttributeDefinition of the attribute.
    String
    getId()
     
    Integer
    getSequenceNumber()
    Returns the sequence number of the attribute within the KrmsTypeDefinition collection.
    String
    getTypeId()
    Returns the id of the KrmsTypeDefinition to which the attribute applies
    Long
    getVersionNumber()
     
    boolean
    isActive()
     

    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

    • getId

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

    • getTypeId

      public String getTypeId()
      Description copied from interface: KrmsTypeAttributeContract
      Returns the id of the KrmsTypeDefinition to which the attribute applies

      A KRMS type definition has zero or more attributes associated with it. The id field indicates which type definition this attribute is associated with. It is the id of a KrmsTypeDefinition related to the attribute. This required field may not be null or blank.

      Specified by:
      getTypeId in interface KrmsTypeAttributeContract
      Returns:
      id for KrmsTypeDefinition related to the attribute.

    • getAttributeDefinitionId

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

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

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

    • getSequenceNumber

      public Integer getSequenceNumber()
      Description copied from interface: KrmsTypeAttributeContract
      Returns the sequence number of the attribute within the KrmsTypeDefinition collection.

      The list of attributes is an ordered list. This value represents the position in the list and cannot be null.

      Specified by:
      getSequenceNumber in interface KrmsTypeAttributeContract
      Returns:
      the sequence number of the attribute

    • isActive

      public boolean isActive()
      Specified by:
      isActive in interface org.kuali.rice.core.api.mo.common.active.Inactivatable

    • getVersionNumber

      public Long getVersionNumber()
      Specified by:
      getVersionNumber in interface org.kuali.rice.core.api.mo.common.Versioned