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

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

public final class KrmsTypeDefinition
extends AbstractDataTransferObject
implements KrmsTypeDefinitionContract

An immutable, concrete model object implementation of a KrmsTypeDefinitionContract.

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

See Also:
KrmsTypeDefinitionContract, Serialized Form

Nested Class Summary
static class KrmsTypeDefinition.Builder
          This builder is used to construct instances of KrmsTypeDefinition.
static class KrmsTypeDefinition.Cache
           
static class KrmsTypeDefinition.Elements
          A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.
 
Method Summary
 List<KrmsTypeAttribute> getAttributes()
          Returns a list of attributes associated with the KRMS type definition.
 String getId()
          The unique identifier for an object.
 String getName()
          Returns the name of the KrmsTypeDefinition.
 String getNamespace()
          Returns the namespace to which the KrmsTypeDefinition belongs.
 String getServiceName()
          Returns the name of the service used to resolve attribute values.
 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

getName

public String getName()
Description copied from interface: KrmsTypeDefinitionContract
Returns the name of the KrmsTypeDefinition. All KrmsTypeDefinitions have a name, so this value can not be null or blank. The combination of name and namespace must be unique within the entire KRMS system.

Specified by:
getName in interface KrmsTypeDefinitionContract
Returns:
the name of this KrmsTypeDefinition

getNamespace

public String getNamespace()
Description copied from interface: KrmsTypeDefinitionContract
Returns the namespace to which the KrmsTypeDefinition belongs. All type definitions exist within a namespace. This value can not be null or blank. The combination of name and namespace must be unique within the entire KRMS system.

Specified by:
getNamespace in interface KrmsTypeDefinitionContract
Returns:
the namespace of this KrmsTypeDefinition

getServiceName

public String getServiceName()
Description copied from interface: KrmsTypeDefinitionContract
Returns the name of the service used to resolve attribute values. The service name may be null or blank.

Specified by:
getServiceName in interface KrmsTypeDefinitionContract
Returns:
the service name of this KrmsTypeDefinition

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.

getAttributes

public List<KrmsTypeAttribute> getAttributes()
Description copied from interface: KrmsTypeDefinitionContract
Returns a list of attributes associated with the KRMS type definition. This can be empty, but will never be null. If no attribute definitions are associated with the KRMS type then this will return an empty collection.

Specified by:
getAttributes in interface KrmsTypeDefinitionContract
Returns:
the list of KrmsTypeAttributeContract attribute definition contracts

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.