oracle.hsgbu.ets.authoring

Interface CandidateConceptDescription

All Superinterfaces:

CandidateETSComponent, Serializable

public interface CandidateConceptDescription
extends CandidateETSComponent

Represents a ConceptDescription object that needs to be created using ETSAuthoringService methods A CandidateConceptDescription must have at least the following attributes correctly defined for it to be created as a ConceptDescription

• TermText
• StatusCode

Note: Editable terminologies are not MLS enabled and will only work with the base language (Base language is the constructed by concatenating the profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code). TheCandidateConceptDescription object will always use the base language.

Method Summary

Modifier and Type	Method and Description
String	getExtendedTypeCode() Gets ExtendedTypeCode of this CandidateDescription object.
String	getTermText() Gets TermText of this CandidateDescription object.
boolean	isPreferredDescription() Indicates if this CandidateDescription object is preferred.
void	setExtendedTypeCode(String code) Sets the ExtendedTypeCode of this CandidateDescription object.
void	setPreferredDescription(boolean flag) Sets the flag that indicates if this CandidateDescription object is preferred.
void	setTermText(String str) Sets TermText of this CandidateDescription object.

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

getCandidateETSAttributes, getRetiredDate, getStatusCode, setCandidateETSAttributes, setRetiredDate, setStatusCode

Method Detail

getTermText

String getTermText()

Gets TermText of this CandidateDescription object.

Returns:

TermText of this CandidateDescription object.

See Also:

setTermText(java.lang.String)

isPreferredDescription

boolean isPreferredDescription()

Indicates if this CandidateDescription object is preferred.

Returns:

true if the CandidateDescription object is preferred, or false if the ConceptDescription object is not preferred.

See Also:

setPreferredDescription(boolean)

getExtendedTypeCode

String getExtendedTypeCode()

Gets ExtendedTypeCode of this CandidateDescription object.

Returns:

ExtendedTypeCode of this CandidateDescription object.

See Also:

setExtendedTypeCode(java.lang.String)

setTermText

void setTermText(String str)

Sets TermText of this CandidateDescription object. The maximum length of this attribute is 4000.

Parameters:

str - TermText for this CandidateDescription object.

See Also:

getTermText()

setPreferredDescription

void setPreferredDescription(boolean flag)

Sets the flag that indicates if this CandidateDescription object is preferred.

Parameters:

flag - true if this CandidateDescription is preferred, or false if this CandidateDescription is not preferred.

See Also:

isPreferredDescription()

setExtendedTypeCode

void setExtendedTypeCode(String code)

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

Parameters:

code - ExtendedTypeCode for this CandidateDescription object.

See Also:

getExtendedTypeCode()