org.kuali.rice.krms.api.repository.term
Class TermResolverDefinition

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.krms.api.repository.term.TermResolverDefinition

All Implemented Interfaces:

Serializable, Inactivatable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, TermResolverDefinitionContract

public final class TermResolverDefinition
extends AbstractDataTransferObject
implements TermResolverDefinitionContract

This is a description of what this class does - gilesp don't forget to fill this in.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Nested Class Summary

static class	TermResolverDefinition.Builder
static class	TermResolverDefinition.Cache

Method Summary

Map<String,String>	getAttributes() Gets any attributes specified on the term resolver definition.
String	getId() The unique identifier for an object.
String	getName() Gets the name for the defined term resolver.
String	getNamespace() Gets the namespace for the defined term resolver.
TermSpecificationDefinition	getOutput() Gets the term specification for the output of the defined term resolver.
Set<String>	getParameterNames() Gets the names of any parameters that the defined term resolver requires.
Set<TermSpecificationDefinition>	getPrerequisites() Gets the term specifications for any prerequisite terms of the defined term resolver.
String	getTypeId() Gets the type id for the defined term resolver.
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, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, 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

getNamespace

public String getNamespace()

Description copied from interface: TermResolverDefinitionContract

Gets the namespace for the defined term resolver. Will not be null or empty.

Specified by:

getNamespace in interface TermResolverDefinitionContract

Returns:

the namespace

getName

public String getName()

Description copied from interface: TermResolverDefinitionContract

Gets the name for the defined term resolver. The namespace and name should uniquely identify a term resolver definition. Will not be null or empty.

Specified by:

getName in interface TermResolverDefinitionContract

Returns:

the name

getTypeId

public String getTypeId()

Description copied from interface: TermResolverDefinitionContract

Gets the type id for the defined term resolver. This id refers to a type which configures how the term resolver may be obtained. May be null, but never empty.

Specified by:

getTypeId in interface TermResolverDefinitionContract

Returns:

the typeId

isActive

public boolean isActive()

Description copied from interface: Inactivatable

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

the active indicator

getOutput

public TermSpecificationDefinition getOutput()

Description copied from interface: TermResolverDefinitionContract

Gets the term specification for the output of the defined term resolver. Will never be null.

Specified by:

getOutput in interface TermResolverDefinitionContract

Returns:

the specification

getPrerequisites

public Set<TermSpecificationDefinition> getPrerequisites()

Description copied from interface: TermResolverDefinitionContract

Gets the term specifications for any prerequisite terms of the defined term resolver. May be empty, but will never be null.

Specified by:

getPrerequisites in interface TermResolverDefinitionContract

Returns:

the prerequisites

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: TermResolverDefinitionContract

Gets any attributes specified on the term resolver definition. May be empty, but never null.

Specified by:

getAttributes in interface TermResolverDefinitionContract

Returns:

the attributes

getParameterNames

public Set<String> getParameterNames()

Description copied from interface: TermResolverDefinitionContract

Gets the names of any parameters that the defined term resolver requires. May be empty, but never null.

Specified by:

getParameterNames in interface TermResolverDefinitionContract

Returns:

the parameterNames

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

See Also:

Versioned.getVersionNumber()