org.kuali.rice.krms.impl.repository

Class TermSpecificationBo

java.lang.Object

org.kuali.rice.krms.impl.repository.TermSpecificationBo

All Implemented Interfaces:

Serializable, Inactivatable, Identifiable, Versioned, TermSpecificationDefinitionContract

@Entity
public class TermSpecificationBo
extends Object
implements TermSpecificationDefinitionContract, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TermSpecificationBo()

Method Summary

Methods

Modifier and Type	Method and Description
static TermSpecificationBo	from(TermSpecificationDefinition im) Converts a immutable object to it's mutable bo counterpart
boolean	getActive()
List<CategoryBo>	getCategories() Gets an ordered list of the categories which this term specification definition belongs to.
List<String>	getContextIds() Gets a list of the IDs for the contexts this TermSpecification can be used in.
List<ContextBo>	getContexts()
List<ContextValidTermBo>	getContextValidTerms()
String	getDescription() Gets the description for this term specification, which will typically be a suitable description for any term having this specification as well.
String	getId() The unique identifier for an object.
String	getName() Gets the name for this TermSpecificationDefinitionContract.
String	getNamespace() Gets the namespace of this TermSpecificationDefinitionContract.
String	getType() Gets the fully qualified class name for the values of any term having this specification.
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.
void	setActive(boolean active)
void	setCategories(List<CategoryBo> categories)
void	setContextIds(List<String> contextIds)
void	setContexts(List<ContextBo> contexts)
void	setContextValidTerms(List<ContextValidTermBo> contextValidTerms)
void	setDescription(String description)
void	setId(String id)
void	setName(String name)
void	setNamespace(String namespace)
void	setType(String type)
void	setVersionNumber(Long versionNumber)
static TermSpecificationDefinition	to(TermSpecificationBo bo) Converts a mutable bo to it's immutable counterpart

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TermSpecificationBo

public TermSpecificationBo()

Method Detail

to

public static TermSpecificationDefinition to(TermSpecificationBo bo)

Converts a mutable bo to it's immutable counterpart

Parameters:

bo - the mutable business object

Returns:

the immutable object

from

public static TermSpecificationBo from(TermSpecificationDefinition im)

Converts a immutable object to it's mutable bo counterpart

Parameters:

im - immutable object

Returns:

the mutable bo

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

setId

public void setId(String id)

getName

public String getName()

Description copied from interface: TermSpecificationDefinitionContract

Gets the name for this TermSpecificationDefinitionContract. This is an important key that must be unique within a namespace, and is used to determine how to resolve any terms having this specification. Will not be null or empty.

Specified by:

getName in interface TermSpecificationDefinitionContract

Returns:

the name

setName

public void setName(String name)

getNamespace

public String getNamespace()

Description copied from interface: TermSpecificationDefinitionContract

Gets the namespace of this TermSpecificationDefinitionContract. Will not be null or empty.

Specified by:

getNamespace in interface TermSpecificationDefinitionContract

Returns:

the namespace of the TermSpecificationDefinitionContract

setNamespace

public void setNamespace(String namespace)

getType

public String getType()

Description copied from interface: TermSpecificationDefinitionContract

Gets the fully qualified class name for the values of any term having this specification. E.g. if the type of the fact values for the "total dollar amount of a grant" term was BigDecimal, then the term specification's type would be the String "java.math.BigDecimal". Will never return null or the empty string.

Specified by:

getType in interface TermSpecificationDefinitionContract

Returns:

the fully qualified name of the java type of values for this term.

setType

public void setType(String type)

getDescription

public String getDescription()

Description copied from interface: TermSpecificationDefinitionContract

Gets the description for this term specification, which will typically be a suitable description for any term having this specification as well. May return null if no description is specified for the term specification.

Specified by:

getDescription in interface TermSpecificationDefinitionContract

Returns:

the description for this term specification.

setDescription

public void setDescription(String description)

getActive

public boolean getActive()

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.

setActive

public void setActive(boolean active)

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

setVersionNumber

public void setVersionNumber(Long versionNumber)

getCategories

public List<CategoryBo> getCategories()

Description copied from interface: TermSpecificationDefinitionContract

Gets an ordered list of the categories which this term specification definition belongs to. This list can be empty but will never be null.

Specified by:

getCategories in interface TermSpecificationDefinitionContract

Returns:

the list of categories for this term specification definition.

setCategories

public void setCategories(List<CategoryBo> categories)

getContextIds

public List<String> getContextIds()

Description copied from interface: TermSpecificationDefinitionContract

Gets a list of the IDs for the contexts this TermSpecification can be used in.

Specified by:

getContextIds in interface TermSpecificationDefinitionContract

Returns:

the list of contexts for this term specification definition

setContextIds

public void setContextIds(List<String> contextIds)

getContexts

public List<ContextBo> getContexts()

setContexts

public void setContexts(List<ContextBo> contexts)

getContextValidTerms

public List<ContextValidTermBo> getContextValidTerms()

setContextValidTerms

public void setContextValidTerms(List<ContextValidTermBo> contextValidTerms)