oracle.hsgbu.ets.base

Interface Classification

All Superinterfaces:

AttributableETSComponent, Concept, ETSComponent, ReassignableETSComponent, RetirableETSComponent

public interface Classification
extends Concept

Represents a container of Concept objects. These Concept objects:

• Have unique identifiers.
• May contain concepts from multiple terminologies.
• May be arranged hierarchically offering parent-child relationships.
• May have multiple descriptions associable with usage contexts.

Note: Classifications are not MLS enabled.

See Also:

ConceptContainer, Concept, UsageContext

Field Summary

Fields

Modifier and Type	Field and Description
static char	STATUS_ACTIVE Constant representing the status of a Classification as active.
static char	STATUS_DIRTY Constant that denotes the status of a classification as dirty.
static char	STATUS_PENDING Constant that denotes the status of a classification as pending.
static char	STATUS_RETIRED Constant that denotes the status of a classification as retired.

Fields inherited from interface oracle.hsgbu.ets.base.Concept

DEFAULT_EQUIVALENCE_CONTEXT, EQUIVALENCE_TYPE_EXACT_CONCEPT, EQUIVALENCE_TYPE_MAPPING, EQUIVALENCE_TYPE_SEMANTIC, LOCAL_PREFERRED, MAXLENGTH_EXT_TYPE_CODE, NONE, TERMINOLOGY_PREFERRED, TERMINOLOGY_PREFERRED_AND_LOCAL_PREFERRED, TYPE_DESC, TYPE_PRINT

Method Summary

Modifier and Type	Method and Description
boolean	contains(Concept concept) Indicates if a concept is contained within this Classification object.
boolean[]	contains(String[] etsIDs) Indicates which set of ETS identifiers of a concept is contained within this Classification object.
Classification[]	findAllChildClassifications() Retrieves the child classifications of the Classification object.
Classification[]	findChildClassifications() Retrieves the immediate child classifications of the Classification object.
Concept[]	findConceptsInClassification() Retrieves the concepts in the Classification object.
char	getClassificationState() Gets the constant representing the current state of the Classification object.
ClassificationDeclaration	getDeclarationByConcept(Concept concept) Gets the classification declaration associated with a particular concept within the context of this Classification.
ClassificationDeclaration[]	getDeclarations() Gets all the declarations added to the Classification object.
String	getName() Gets the name of the Classification object.
Classification	getParentClassification()
Classification[]	getTopMostParentClassifications() Gets the top most parent classifications of a concept.
boolean	isAvailable() Returns true if the Classification object is available for query.

Methods inherited from interface oracle.hsgbu.ets.base.Concept

getAllDescriptions, getAllDescriptions, getClassifications, getCodingSchemeVersion, getConceptCode, getConceptListsContainingConcept, getConceptListsContainingConcept, getDescription, getDescription, getDescription, getEquivalentConcepts, getEquivalentConcepts, getEquivalentConcepts, getExtendedTypeCode, getLocallyPreferredDescription, getLocallyPreferredDescription, getLocallySpecifiedDescriptions, getLocallySpecifiedDescriptions, getMappedConcepts, getMappedConcepts, getRelatedConcepts, getRelatedConcepts, getRelatedConcepts, getRelationships, getRelationships, getTerminologyPreferredDescription, getTerminologyPreferredDescription, getTerminologySpecifiedDescriptions, getTerminologySpecifiedDescriptions, isEquivalent, isEquivalent, isRelationType

Methods inherited from interface oracle.hsgbu.ets.base.ReassignableETSComponent

getFinalAssignment, getNextAssignment, getPreviousAssignments, isReassigned

Methods inherited from interface oracle.hsgbu.ets.base.RetirableETSComponent

getRetiredDate, getVersionID, isActive, isInternal, isQuarantined, isRetired

Methods inherited from interface oracle.hsgbu.ets.base.AttributableETSComponent

getAttributeNames, getAttributes, getAttributes

Methods inherited from interface oracle.hsgbu.ets.base.ETSComponent

getCreationDate, getETSID, getImportDate, getLastUpdateDate

Field Detail

STATUS_ACTIVE

static final char STATUS_ACTIVE

Constant representing the status of a Classification as active.

See Also:

Constant Field Values

STATUS_PENDING

static final char STATUS_PENDING

Constant that denotes the status of a classification as pending.

See Also:

Constant Field Values

STATUS_DIRTY

static final char STATUS_DIRTY

Constant that denotes the status of a classification as dirty.

See Also:

Constant Field Values

STATUS_RETIRED

static final char STATUS_RETIRED

Constant that denotes the status of a classification as retired.

See Also:

Constant Field Values

Method Detail

getName

String getName()
        throws ETSDataException

Gets the name of the Classification object. The maximum length of this attribute is 4000.

Returns:

Description of the Classification object.

Throws:

ETSDataException - If a data transport error occurrs.

findChildClassifications

Classification[] findChildClassifications()
                                   throws ETSDataException

Retrieves the immediate child classifications of the Classification object.

Returns:

Array of classifications contained in the Classification object, or a zero-length array if no immediate child classification is found.

Throws:

ETSDataException - If a data transport error occurs.

findAllChildClassifications

Classification[] findAllChildClassifications()
                                      throws ETSDataException

Retrieves the child classifications of the Classification object.

Returns:

Array of classifications contained in the Classification object, or a zero-length array if no immediate child classification is found.

Throws:

ETSDataException - If a data transport error occurs.

findConceptsInClassification

Concept[] findConceptsInClassification()
                                throws ETSDataException

Retrieves the concepts in the Classification object.

Returns:

Array of concepts contained in the Classification object, or a zero-length array if no concept is found.

Throws:

ETSDataException - If a data transport error occurs.

isAvailable

boolean isAvailable()

Returns true if the Classification object is available for query. true indicates that the Classification object is in the active or dirty state.

Returns:

true if the Classification object is in the active or dirty state.

getDeclarations

ClassificationDeclaration[] getDeclarations()
                                     throws ETSDataException

Gets all the declarations added to the Classification object.

Returns:

Array of ClassificationDeclaration objects, or a zero-length array if no declaration is found.

Throws:

ETSDataException - If a data transport error occurs.

getDeclarationByConcept

ClassificationDeclaration getDeclarationByConcept(Concept concept)
                                           throws ETSDataException,
                                                  ETSNotFoundException,
                                                  ETSBadParameterException

Gets the classification declaration associated with a particular concept within the context of this Classification.

Parameters:

concept - Concept object.

Returns:

ClassificationDeclaration object.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the specified Concept is not contained in this Classification object.

ETSBadParameterException - If the specified Concept is null.

getTopMostParentClassifications

Classification[] getTopMostParentClassifications()
                                          throws ETSDataException

Gets the top most parent classifications of a concept.

Returns:

Array of concepts that may include multiple ultimate parents.

Throws:

ETSDataException - If a data transport error occurs.

getParentClassification

Classification getParentClassification()
                                throws ETSDataException

Throws:

ETSDataException

getClassificationState

char getClassificationState()

Gets the constant representing the current state of the Classification object.

Classification states Active,Dirty,and Pending map to Concept state Active. Classification state Retired maps to Concept state Retired.

Returns:

Constant representing the current state of the Classification object. The constants are:

• STATUS_ACTIVE
• STATUS_PENDING
• STATUS_DIRTY
• STATUS_RETIRED

See Also:

ETSAdministrationService.retireClassification(Classification classification), ETSAdministrationService.activateClassification(Classification classification)

contains

boolean[] contains(String[] etsIDs)
            throws ETSDataException,
                   ETSBadParameterException

Indicates which set of ETS identifiers of a concept is contained within this Classification object. The ETS identifiers, in this case, are assumed to be Concept identifiers.

Parameters:

etsIDs - Array of String representing the ETS identifiers of concepts.

Returns:

Array indicating whether each of the ETS identifiers in the passed parameter array, etsIDs, is contained in this Classification object. If etsID[i] is contained in this Classification object, the value at index i in the returned array is true.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the length of etsIDs is zero or null.

contains

boolean contains(Concept concept)
          throws ETSDataException,
                 ETSBadParameterException,
                 ETSNotFoundException

Indicates if a concept is contained within this Classification object.

Parameters:

concept - Concept

Returns:

true if the concept is contained within this Classification object.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If a concept is null.

ETSNotFoundException - If a concept is not found in ETS.