org.kuali.rice.coreservice.api.parameter
Class ParameterType

java.lang.Object
  extended by org.kuali.rice.core.api.mo.AbstractDataTransferObject
      extended by org.kuali.rice.coreservice.api.parameter.ParameterType
All Implemented Interfaces:
Serializable, Inactivatable, Coded, GloballyUnique, Versioned, ModelObjectBasic, ModelObjectComplete, ParameterTypeContract

public final class ParameterType
extends AbstractDataTransferObject
implements ParameterTypeContract

An immutable representation of a ParameterTypeContract.

To construct an instance of a ParameterType, use the ParameterType.Builder class.

See Also:
ParameterTypeContract, Parameter, Serialized Form

Nested Class Summary
static class ParameterType.Builder
          This builder is used to construct instances of ParameterType.
 
Method Summary
 String getCode()
          The code value for this object.
 String getName()
          This the name for the ParameterType.
 String getObjectId()
          Return the globally unique object id of this object.
 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

getCode

public String getCode()
Description copied from interface: Coded
The code value for this object. In general a code value cannot be null or a blank string.

Specified by:
getCode in interface Coded
Returns:
the code value for this object.

getName

public String getName()
Description copied from interface: ParameterTypeContract
This the name for the ParameterType. This can be null or a blank string.

Specified by:
getName in interface ParameterTypeContract
Returns:
the name of the ParameterType

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

getObjectId

public String getObjectId()
Description copied from interface: GloballyUnique
Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.

Specified by:
getObjectId in interface GloballyUnique
Returns:
the objectId of this object, or null if it has not been set yet


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