oracle.hsgbu.ets.snomed

Interface SNOMEDRelationship

All Superinterfaces:

AttributableETSComponent, ETSComponent, Relationship, RetirableETSComponent

public interface SNOMEDRelationship
extends Relationship

Defines extensions to the generic Relationship object by providing information specific to the SNOMED-CT terminology.

See Also:

Relationship

Field Summary

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

CONCEPT_IS_RELATIONSHIP_ANY, CONCEPT_IS_RELATIONSHIP_RELATION_TYPE, CONCEPT_IS_RELATIONSHIP_SOURCE, CONCEPT_IS_RELATIONSHIP_SOURCE_OR_TARGET, CONCEPT_IS_RELATIONSHIP_TARGET

Method Summary

Modifier and Type	Method and Description
int	getCharacteristicType() Gets the characteristic type of this SNOMEDRelationship.
String	getCTypeId() Gets the Description type identifier (RF2 Attribute) of this SNOMEDRelationship.
Date	getEffectiveTime() Gets the Effective Time (RF2 Attribute) of this SNOMEDRelationship.
String	getModifierId() Gets the Modifier identifier (RF2 Attribute) of this SNOMEDRelationship.
String	getModuleId() Gets the Module identifier (RF2 Attribute) of this SNOMEDRelationship.
int	getRefinability() Gets the refinability flag of this SNOMEDRelationship.
int	getRelationshipGroup() Gets the relationship group of this SNOMEDRelationship.
String	getSNOMEDID() Gets the identifier of this SNOMEDRelationship.

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

getRelationshipType, getRelationshipTypeConceptID, getSourceConcept, getSourceConceptID, getTargetConcept, getTargetConceptID

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

Method Detail

getCharacteristicType

int getCharacteristicType()
                   throws ETSDataException

Gets the characteristic type of this SNOMEDRelationship. The characteristic type is an integer value that ranges between 0 and 2. The characteristic type values are defined in SNOMEDConstants.

Returns:

Characteristic type of this SNOMEDRelationship.

Throws:

ETSDataException - If a data transport error occurs.

getRelationshipGroup

int getRelationshipGroup()
                  throws ETSDataException

Gets the relationship group of this SNOMEDRelationship. The relationship group is an integer value that organizes relationships into logical groups. The default value for a relationship group is 0. SNOMED-CT relationships that are not part of any relationship group have the default relationship group value.

Returns:

Relationship group of this SNOMEDRelationship.

Throws:

ETSDataException - If a data transport error occurs.

getRefinability

int getRefinability()
             throws ETSDataException

Gets the refinability flag of this SNOMEDRelationship. The refinability flag is an integer value that ranges between 0 and 2. The refinability values are defined in SNOMEDConstants.

Returns:

Refinability flag of this SNOMEDRelationship.

Throws:

ETSDataException - If a data transport error occurs.

getSNOMEDID

String getSNOMEDID()
            throws ETSDataException

Gets the identifier of this SNOMEDRelationship.

Returns:

String value that uniquely identifies this SNOMEDRelationship.

Throws:

ETSDataException - If a data transport error occurs.

getEffectiveTime

Date getEffectiveTime()
               throws ETSDataException

Gets the Effective Time (RF2 Attribute) of this SNOMEDRelationship. This method returns null if this SNOMEDRelationship does not have a Effective Time. This method returns null if this SNOMEDRelationship belongs to a version loaded with RF1 file format.

Returns:

Module identifier of this SNOMEDRelationship, or null if there is no effective Time.

Throws:

ETSDataException - If a data transport error occurs.

getModuleId

String getModuleId()
            throws ETSDataException

Gets the Module identifier (RF2 Attribute) of this SNOMEDRelationship. This method returns null if this SNOMEDRelationship does not have a Module identifier. This method returns null if this SNOMEDRelationship belongs to a version loaded with RF1 file format.

Returns:

Module identifier of this SNOMEDRelationship, or null if there is no Module identifier.

Throws:

ETSDataException - If a data transport error occurs.

getModifierId

String getModifierId()
              throws ETSDataException

Gets the Modifier identifier (RF2 Attribute) of this SNOMEDRelationship. This method returns null if this SNOMEDRelationship does not have a Modifier identifier. This method returns null if this SNOMEDRelationship belongs to a version loaded with RF1 file format.

Returns:

Module identifier of this SNOMEDRelationship, or null if there is no Modifier identifier.

Throws:

ETSDataException - If a data transport error occurs.

getCTypeId

String getCTypeId()
           throws ETSDataException

Gets the Description type identifier (RF2 Attribute) of this SNOMEDRelationship. This method returns null if this SNOMEDRelationship does not have a Description type identifier. This method returns null if this SNOMEDRelationship belongs to a version loaded with RF1 file format.

Returns:

Module identifier of this SNOMEDRelationship, or null if there is no Description type identifier.

Throws:

ETSDataException - If a data transport error occurs.