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

java.lang.Object
  extended by org.kuali.rice.coreservice.api.parameter.ParameterType.Builder
All Implemented Interfaces:
Serializable, Inactivatable, Coded, GloballyUnique, Versioned, ModelBuilder, ParameterTypeContract
Enclosing class:
ParameterType

public static class ParameterType.Builder
extends Object
implements ParameterTypeContract, ModelBuilder, Serializable

This builder is used to construct instances of ParameterType. It enforces the constraints of the ParameterTypeContract.

See Also:
Serialized Form

Method Summary
 ParameterType build()
          Builds an instance of a ParameterType based on the current state of the builder.
static ParameterType.Builder create(ParameterTypeContract contract)
          Creates a builder by populating it with data from the given ParameterTypeContract.
static ParameterType.Builder create(String code)
          Creates a builder from the given parameter type code.
 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.
 void setActive(boolean active)
           
 void setCode(String code)
          Sets the value of the code on this builder to the given value.
 void setName(String name)
           
 void setObjectId(String objectId)
           
 void setVersionNumber(Long versionNumber)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public static ParameterType.Builder create(String code)
Creates a builder from the given parameter type code.

Parameters:
code - the parameter type code
Returns:
an instance of the builder with the code already populated
Throws:
IllegalArgumentException - if the code is null or blank

create

public static ParameterType.Builder create(ParameterTypeContract contract)
Creates a builder by populating it with data from the given ParameterTypeContract.

Parameters:
contract - the contract from which to populate this builder
Returns:
an instance of the builder populated with data from the contract

setCode

public void setCode(String code)
Sets the value of the code on this builder to the given value.

Parameters:
code - the code value to set, must not be null or blank
Throws:
IllegalArgumentException - if the code is null or blank

setName

public void setName(String name)

setActive

public void setActive(boolean active)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)

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

build

public ParameterType build()
Builds an instance of a ParameterType based on the current state of the builder.

Specified by:
build in interface ModelBuilder
Returns:
the fully-constructed ParameterType


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