oracle.hsgbu.ets.base

Interface Relationship

All Superinterfaces:

AttributableETSComponent, ETSComponent, RetirableETSComponent

All Known Subinterfaces:

SNOMEDRelationship

public interface Relationship
extends RetirableETSComponent

Represents a relationship between two concepts in a CodingSchemeVersion. A relationship consists of a source concept, a relationship type, and a target concept. The relationship type is itself a Concept, for which Concept.isRelationshipType() will return true. The source concept, relationship type concept, and target concept must all exist in the same coding scheme version.

See Also:

RetirableETSComponent, Concept, CodingSchemeVersion

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONCEPT_IS_RELATIONSHIP_ANY Constant used by getRelatedConcepts() methods to specify search type, where the Concept in involved in a relationship in any way.
static int	CONCEPT_IS_RELATIONSHIP_RELATION_TYPE Constant used by getRelatedConcepts() methods to specify search type, where the Concept is either the source or target in a relationship and based on a specific relationship type.
static int	CONCEPT_IS_RELATIONSHIP_SOURCE Constant used by getRelatedConcepts() methods to specify search type, based on the source Concept in a relationship.
static int	CONCEPT_IS_RELATIONSHIP_SOURCE_OR_TARGET Constant used by getRelatedConcepts() methods to specify search type, where the Concept is either the source or target in a relationship.
static int	CONCEPT_IS_RELATIONSHIP_TARGET Constant used by getRelatedConcepts() methods to specify search type, based on the target Concept in a relationship.

Method Summary

Modifier and Type	Method and Description
Concept	getRelationshipType() Retrieves the relationship type concept of a relationship.
String	getRelationshipTypeConceptID() Returns the concept identifier of the relationship type concept in this Relationship.
Concept	getSourceConcept() Retrieves the source concept of a relationship.
String	getSourceConceptID() Returns the concept identifier of the source concept in this Relationship.
Concept	getTargetConcept() Retrieves the target concept of a relationship.
String	getTargetConceptID() Returns the concept identifier of the target concept in this Relationship.

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

CONCEPT_IS_RELATIONSHIP_SOURCE

static final int CONCEPT_IS_RELATIONSHIP_SOURCE

Constant used by getRelatedConcepts() methods to specify search type, based on the source Concept in a relationship.

See Also:

Constant Field Values

CONCEPT_IS_RELATIONSHIP_TARGET

static final int CONCEPT_IS_RELATIONSHIP_TARGET

Constant used by getRelatedConcepts() methods to specify search type, based on the target Concept in a relationship.

See Also:

Constant Field Values

CONCEPT_IS_RELATIONSHIP_SOURCE_OR_TARGET

static final int CONCEPT_IS_RELATIONSHIP_SOURCE_OR_TARGET

Constant used by getRelatedConcepts() methods to specify search type, where the Concept is either the source or target in a relationship.

See Also:

Constant Field Values

CONCEPT_IS_RELATIONSHIP_RELATION_TYPE

static final int CONCEPT_IS_RELATIONSHIP_RELATION_TYPE

Constant used by getRelatedConcepts() methods to specify search type, where the Concept is either the source or target in a relationship and based on a specific relationship type.

See Also:

Constant Field Values

CONCEPT_IS_RELATIONSHIP_ANY

static final int CONCEPT_IS_RELATIONSHIP_ANY

Constant used by getRelatedConcepts() methods to specify search type, where the Concept in involved in a relationship in any way.

See Also:

Constant Field Values

Method Detail

getSourceConcept

Concept getSourceConcept()
                  throws ETSDataException

Retrieves the source concept of a relationship.

Returns:

Source concept of a relationship.

Throws:

ETSDataException - If a data transport error occurs.

getRelationshipType

Concept getRelationshipType()
                     throws ETSDataException

Retrieves the relationship type concept of a relationship.

Returns:

Relationship type concept of a relationship.

Throws:

ETSDataException - If a data transport error occurs.

getTargetConcept

Concept getTargetConcept()
                  throws ETSDataException

Retrieves the target concept of a relationship.

Returns:

Target concept of a relationship.

Throws:

ETSDataException - If a data transport error occurs.

getSourceConceptID

String getSourceConceptID()

Returns the concept identifier of the source concept in this Relationship. The maximum length of this attribute is 30.

Returns:

Concept identifier of the source concept in this Relationship.

getRelationshipTypeConceptID

String getRelationshipTypeConceptID()

Returns the concept identifier of the relationship type concept in this Relationship. The maximum length of this attribute is 30.

Returns:

Concept identifier of the relationship type concept in this Relationship.

getTargetConceptID

String getTargetConceptID()

Returns the concept identifier of the target concept in this Relationship. The maximum length of this attribute is 30.

Returns:

Concept identifier of the target concept in this Relationship.