TermSpecificationDefinition

Name TermSpecificationDefinition
Usage TermRepositoryService TermBoService
getTermSpecificationById createTermSpecification
TermResolverDefinition TermDefinition
Type Complex

Description

Immutable DTO for TermSpecifications. Construction must be done via the {@link Builder} inner class.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
id Id String This value will be non-null for persisted     One No  
name Name String Gets the name for this {@link 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.		 Required   One No  
namespace Namespace String Gets the namespace of this {@link TermSpecificationDefinitionContract}. Will not be null or empty. Required   One No  
type Type String 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 {@link java.math.BigDecimal},
then the term specification's type would be the String "java.math.BigDecimal". Will never return null or
the empty string.		 Required   One No  
description Description String 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.		     One No  
active Active boolean The active indicator for an object.     One No  
versionNumber Version Number Long 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.		     One No  
categories Categories CategoryDefinitionList Gets an ordered list of the categories which this term specification
definition belongs to. This list can be empty but will never be null.		     Many No