oracle.hsgbu.ets.authoring

Interface CandidateConcept

All Superinterfaces:

CandidateETSComponent, Serializable

All Known Subinterfaces:

CandidateClassification

public interface CandidateConcept
extends CandidateETSComponent

Represents a simplified version of a Concept object. A Concept belongs to the CodingSchemeVersion object.

A CandidateConcept must have at least the following attributes correctly defined for it to be created as a Concept

• ConceptCode
• RelationshipType
• CandidateDescriptions
• StatusCode

Field Summary

Fields

Modifier and Type	Field and Description
static String	REL_TYPE_IS_CHILD_OF Constant used to define the relationship type as "IS_CHILD_OF".
static String	REL_TYPE_IS_PARENT_OF Constant used to define the relationship type as "IS_PARENT_OF".
static String	REL_TYPE_NO Constant used to define the relationship type as "N".
static String	REL_TYPE_YES Constant used to define the relationship type as "Y".

Method Summary

Modifier and Type	Method and Description
CandidateConceptDescription[]	getCandidateDescriptions() Gets the CandidateDescription attributes associated with this CandidateConcept object.
String	getConceptCode() Gets the ConceptCode attribute of this CandidateConcept.
String	getExtendedTypeCode() Gets the ExtendedTypeCode attribute of this CandidateConcept object.
String	getReassignedFromCode() Gets the ConceptCode attribute of CandidateConcept being reassigned.
String	getRelationshipType() Gets the RelationshipType of this CandidateConcept.
void	setCandidateDescriptions(CandidateConceptDescription[] descs) Sets the descriptions to be associated with this CandidateConcept object.
void	setConceptCode(String conceptCode) Sets the ConceptCode attribute of this CandidateConcept object.
void	setExtendedTypeCode(String extTypeCode) Sets the ExtendedTypeCode attribute of this CandidateConcept object.
void	setReassignedFromCode(String code) Sets the ConceptCode attribute of the CandidateConcept being reassigned.
void	setRelationshipType(String flag) Sets the RelationshipType of this CandidateConcept.

Methods inherited from interface oracle.hsgbu.ets.authoring.CandidateETSComponent

getCandidateETSAttributes, getRetiredDate, getStatusCode, setCandidateETSAttributes, setRetiredDate, setStatusCode

Field Detail

REL_TYPE_YES

static final String REL_TYPE_YES

Constant used to define the relationship type as "Y".

See Also:

Constant Field Values

REL_TYPE_NO

static final String REL_TYPE_NO

Constant used to define the relationship type as "N".

See Also:

Constant Field Values

REL_TYPE_IS_CHILD_OF

static final String REL_TYPE_IS_CHILD_OF

Constant used to define the relationship type as "IS_CHILD_OF".

See Also:

Constant Field Values

REL_TYPE_IS_PARENT_OF

static final String REL_TYPE_IS_PARENT_OF

Constant used to define the relationship type as "IS_PARENT_OF".

See Also:

Constant Field Values

Method Detail

getConceptCode

String getConceptCode()

Gets the ConceptCode attribute of this CandidateConcept.

Returns:

ConceptCode.

See Also:

setConceptCode(java.lang.String)

getRelationshipType

String getRelationshipType()

Gets the RelationshipType of this CandidateConcept.

Returns:

One of the following constants defined in this interface:

• REL_TYPE_YES
• REL_TYPE_NO
• REL_TYPE_IS_CHILD_OF
• REL_TYPE_IS_PARENT_OF

See Also:

setRelationshipType(java.lang.String)

getReassignedFromCode

String getReassignedFromCode()

Gets the ConceptCode attribute of CandidateConcept being reassigned.

Returns:

ConceptCode of CandidateConcept being reassigned or null if there is no reassignment to this Concept.

See Also:

setReassignedFromCode(java.lang.String)

getExtendedTypeCode

String getExtendedTypeCode()

Gets the ExtendedTypeCode attribute of this CandidateConcept object.

Returns:

ExtendedTypeCode of this CandidateConcept. This value can be null.

See Also:

setExtendedTypeCode(java.lang.String)

getCandidateDescriptions

CandidateConceptDescription[] getCandidateDescriptions()

Gets the CandidateDescription attributes associated with this CandidateConcept object.

Returns:

Array of CandidateDescription attributes associated with this CandidateConcept object or null if no descriptions are set for this CandidateConcept object.

See Also:

setCandidateDescriptions(oracle.hsgbu.ets.authoring.CandidateConceptDescription[])

setConceptCode

void setConceptCode(String conceptCode)

Sets the ConceptCode attribute of this CandidateConcept object. The maximum allowable length for this attribute is 50.

Parameters:

conceptCode - ConceptCode for this CandidateConcept object.

See Also:

getConceptCode()

setRelationshipType

void setRelationshipType(String flag)

Sets the RelationshipType of this CandidateConcept. The maximum length of this attribute is 30.

Parameters:

flag - Relationship type flag value defined in this interface. The valid values are the following defined constants:

• REL_TYPE_YES
• REL_TYPE_NO
• REL_TYPE_IS_CHILD_OF
• REL_TYPE_IS_PARENT_OF

See Also:

getRelationshipType()

setExtendedTypeCode

void setExtendedTypeCode(String extTypeCode)

Sets the ExtendedTypeCode attribute of this CandidateConcept object. The maximum length of this attribute is 6.

Parameters:

extTypeCode - ExtendedTypeCode attribute for this CandidateConcept object.

See Also:

getExtendedTypeCode()

setCandidateDescriptions

void setCandidateDescriptions(CandidateConceptDescription[] descs)

Sets the descriptions to be associated with this CandidateConcept object.

Parameters:

descs - Array of CandidateConceptDescription objects.

See Also:

getCandidateDescriptions()

setReassignedFromCode

void setReassignedFromCode(String code)

Sets the ConceptCode attribute of the CandidateConcept being reassigned. The maximum length of this attribute is 50.

Parameters:

code - ConceptCode for the CandidateConcept being reassigned.

See Also:

getReassignedFromCode()