Package oracle.hsgbu.ets.authoring

Contains classes related to authoring ETSComponent in a generic editable CodingSchemeVersion.

See: Description

Interface Summary

Interface	Description
CandidateClassification	Represents a simplified version of a Classification object.
CandidateConcept	Represents a simplified version of a Concept object.
CandidateConceptDescription	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).
CandidateETSAttribute	Represents an ETSAttribute object that needs to be created using ETSAuthoringService methods A CandidateETSAttribute must have at least the following attributes correctly defined for it to be created as an ETSAttribute Name
CandidateETSComponent	The parent class of candidate concepts, relationships, and descriptions.
CandidateRelationship	Represents a Relationship object that needs to be created using ETSAuthoringService methods A CandidateRelationship must have at least the following attributes correctly defined for it to be created as a Relationship StatusCode SourceConceptID TargetConceptID RelationshipTypeConceptID
ETSAuthoringService	Provides methods to create, retire, modify, and remove objects from editable versions in the ETS repository.

Package oracle.hsgbu.ets.authoring Description

Contains classes related to authoring ETSComponent in a generic editable CodingSchemeVersion. Candidate classes are implementations of the corresponding ETSComponent. Candidate objects are instantiated and setter methods are called on it to set the necessary attributes. Authoring methods take in Candidate objects that are validated before the underlying ETSComponent is created and persisted to the repository.

The steps below describes the sequence of method calls that a client application can use to create a Concept and add it to an editable CodingScheme version:

1. Get instances of the ETSService, ETSAdminstrationService, and ETSAuthoringService objects.

   ETSService etsService = ServiceLocator.getETSService()
ETSService etsAdminService = etsService.getAdministrationServiceInstance()
ETSAuthoringService etsAuthoringService = etsService.getAuthoringServiceInstance()

   
   
   
2. Create editable CodingScheme using the ETSAdminstrationService.

   CodingScheme cs = etsAdminService.createCodingScheme(name, description, termModel=CodingScheme.CODINGSCHEME_MODEL_GENERIC,oid,isEditableFlag=true)

3. Load version into the repository through the loader and importer jobs of Oracle Enterprise Manager Database scheduler.
   
   
   NOTE: An editable CodingScheme can have only one version.
   
   
   
4. Create CandidateConcept.

   CandidateConcept[] candConcepts = new CandidateConcept[1]
candConcepts[0]= etsAuthoringService.newCandidateConcept()

CandidateConceptDescription[] candDescs = new CandidateConceptDescription[1]

candDescs[0] = etsAuthoringService.newCandidateConceptDescription()

candDescs[0].setStatus('A');

candDescs[0].setTermText(termText);

candDescs[0].setPreferredDescription(true);

...//call any other relevant setter methods on the CandidateConceptDescription if needed

CandidateETSAttribute [] candAttr = new CandidateETSAttribute[1]

candAttr = etsAuthoringService.newCandidateETSAttribute()

candAttr[0].setName(attrNameString);

candAttr[0].setValue(attrValueString)

candConcepts[0].setConceptCode(codeString);

candConcepts[0].setStatusCode(statusCodeChar);

candConcepts[0].setRelationshipType(CandidateConcept.REL_TYPE_NO);

candConcepts.setCandidateConceptDescriptions(candDescs);

candConcepts.setCandidateETSAttributes(candAttr);

...//call any other relevant setter methods on the CandidateConcept if needed
   
   
   

5. Validate CandidateConcept and its attributes if needed.

   etsAuthoringService.addConcepts(editableCodingSchemeVersion, candConcepts, boolean dryRunFlag) dryRunFlag=true
   
   

6. If no validation errors are thrown, create the Concept and add it to the repository.

   etsAuthoringService.addConcepts(editableCodingSchemeVersion, candConcepts, boolean dryRunFlag) dryRunFlag=false
   
   

MLS Support

Editable terminologies (including Classifications) are not MLS enabled. All of the descriptions are stored in 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). Whenever an editable terminology is created, it is marked as supporting the base language only.