org.kuali.rice.krms.api.repository.type
Class KrmsTypeAttribute

java.lang.Object
  extended by org.kuali.rice.core.api.mo.AbstractDataTransferObject
      extended by org.kuali.rice.krms.api.repository.type.KrmsTypeAttribute
All Implemented Interfaces:
Serializable, Inactivatable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, KrmsTypeAttributeContract

public final class KrmsTypeAttribute
extends AbstractDataTransferObject
implements KrmsTypeAttributeContract

Concrete model object implementation of KRMS

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:
Serialized Form

Nested Class Summary
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
 String getAttributeDefinitionId()
          Returns the id of the KrmsAttributeDefinition of the attribute.
 String getId()
          The unique identifier for an object.
 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()
          Returns the version number for this object.
 boolean isActive()
          The active indicator for an object.
 
Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject
afterUnmarshal, beforeUnmarshal, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

getId

public String getId()
Description copied from interface: Identifiable
The unique identifier for an object. This can be null.

Specified by:
getId in interface Identifiable
Returns:
the id

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()
Description copied from interface: Inactivatable
The active indicator for an object.

Specified by:
isActive in interface Inactivatable
Returns:
true if active false if not.

getVersionNumber

public Long getVersionNumber()
Description copied from interface: Versioned
Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:
getVersionNumber in interface Versioned
Returns:
the version number, or null if one has not been assigned yet


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.