oracle.hsgbu.ets.base

Interface ETSAdministrationService

All Superinterfaces:

ETSService

public interface ETSAdministrationService
extends ETSService

Provides methods to create, retire, modify, and remove objects from the ETS repository.
NOTE: Some of the methods in this interface can severely affect the operation of ETS-dependent applications. Methods in ETSAdministrationService must not be used until they are thoroughly understood, and special attention should be paid to the testing of any module that calls ETSAdministrationService methods.

See Also:

ETSService

Field Summary

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

LOOKUP_GROUP_NAME

Method Summary

Modifier and Type	Method and Description
void	activate(CodingSchemeVersion version) Marks a CodingSchemeVersion as active.
void	activateClassification(Classification classification) Marks a classification as active.
void	activateConceptList(ConceptList conceptList) Activates a retired ConceptList.
void	addAttribute(AttributableETSComponent component, String name, String value) Adds a name/value pair to an AttributableETSComponent.
void	addChildClassification(Classification parent, Classification child, int inclusionOption) Adds a child classification to a parent classification.
void	addClassificationDescription(CandidateConceptDescription description, Classification classification) Adds a description of a classification.
void	addClassificationDescriptions(CandidateConceptDescription[] description, Classification classification) Adds descriptions to a classification.
void	addConceptToConceptList(Concept concept, ConceptList conceptList) Deprecated. Use addConceptToConceptList(Concept,String,ConceptList).
void	addConceptToConceptList(Concept concept, String code, ConceptList conceptList) Adds a concept to a given ConceptList that is activated on the current date.
void	addConceptToConceptList(Concept concept, String code, ConceptList conceptList, ConceptDescription printName, ConceptDescription shortName, ConceptDescription longName) Adds a concept to a given ConceptList that is activated on the current date.
void	addConceptToConceptList(Concept concept, String code, ConceptList conceptList, Date activationDate) Adds a concept to a given ConceptList that will be activated at a specified date in the future.
void	addConceptToConceptList(Concept concept, String code, ConceptList conceptList, Date activationDate, ConceptDescription printName, ConceptDescription shortName, ConceptDescription longName) Adds a concept to a given ConceptList that will be activated at a specified date in the future.
void	addDeclarationsToClassification(Concept[] concepts, Classification classification, int[] inclusionOption) Adds a declaration to a classification.
void	addDeclarationToClassification(Concept concept, Classification classification, int inclusionOption) Adds a declaration to a classification.
void	associateUsageContextWithExternalOwner(UsageContext usageContext, String ownerType, String ownerID) Associates a usage context with an owner identifier.
Classification	createClassification(CandidateClassification candidateClassification) Creates a classification with the given CandidateClassification object.
CodingScheme	createCodingScheme(String name, String description, String termModel) Creates a new CodingScheme with the given name and description.
CodingScheme	createCodingScheme(String name, String description, String termModel, String oid) Creates a new CodingScheme with the given name, description, terminology model, and object identifier (OID).
CodingScheme	createCodingScheme(String name, String description, String termModel, String oid, boolean isEditableFlag) Creates a new CodingScheme with the given name, description, terminology model, and object identifier (OID) and if it is to be defined as editable.
ConceptList	createConceptList(String name, String description) Creates a ConceptList.
ConceptList	createConceptList(String name, String description, ConceptList parentConceptList, String groupName, boolean newGroupFlag, boolean restrictedFlag, boolean inheritAdditionFlag, boolean inheritDeletionFlag, int status, UsageContext usageContext) Creates a user-defined ConceptList with parent-child relationship properties, such as inheritance, restriction, and usage context specialization, in addition to ConceptList properties, such as status and group names.
LocalConceptDescription	createLocalConceptDescription(Concept concept, String term, UsageContext usageContext, boolean isPreferred) Creates a new LocalConceptDescription for a given Concept in the in the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code).
LocalConceptDescription	createLocalConceptDescription(Concept concept, String term, UsageContext usageContext, boolean isPreferred, Locale locale) Creates a new LocalConceptDescription for a given Concept for the specified Locale in the in the given Locale.
UsageContext	createUsageContext(String name, String description) Creates a new UsageContext with a given name and description.
void	deleteMapSet(MapSet mapSet) Deletes a MapSet and all of it associative contents.
CodingSchemeVersion[]	getAllVersionsForScheme(CodingScheme codingScheme) Gets the CodingSchemeVersion objects currently contained in the repository given a valid CodingScheme.
StagedService	getStagedServiceInstance() Gets a handle to the StagedService, which provides services for dealing with the ETS terminology staging area.
void	invalidateETSCache() This is the API to invalidate the caches of ETS.
void	makeDefaultVersion(CodingSchemeVersion version) Makes a CodingSchemeVersion the default version of the CodingScheme.
CandidateLocaleMap	newCandidateLocaleMap() Creates a new instance of the CandidateLocaleMap object.
CandidateLocaleMap	newCandidateLocaleMap(LocaleMap localeMap) Creates a new instance of the CandidateLocaleMap object - uses the values in the LocaleMap to create a CandidateLocalMap.
boolean	removeAttribute(AttributableETSComponent component, String name, String value) Removes a single name/value pair from an AttributableETSComponent.
boolean	removeAttributes(AttributableETSComponent component, String name) Removes all of the attributes with the specified name from an AttributableETSComponent.
void	removeChildClassification(Classification parent, Classification child) Removes a child classification from a parent classification.
void	removeConceptFromConceptList(Concept concept, ConceptList conceptList) Deprecated. Use retireConceptInConceptList(Concept, ConceptList).
void	removeConceptList(ConceptList conceptList) Deprecated. Use retireConceptList(ConceptList).
void	removeDeclarationFromClassification(ClassificationDeclaration declaration, Classification classification) Removes a declaration from a classification.
void	removeDeclarationsFromClassification(ClassificationDeclaration[] declaration, Classification classification) Removes an array of declarations from a classification.
void	removeUsageContext(UsageContext usageContext) Removes a UsageContext from the system.
void	retire(CodingSchemeVersion version, Date retireDate) Retires the component, optionally specifying the retirement date.
void	retire(RetirableETSComponent component, Date retireDate) Retires the RetirableETSComponent, optionally specifying the retirement date.
void	retireClassification(Classification classification) Retires a classification, moving the classification to the Retired state.
void	retireConceptInConceptList(Concept concept, ConceptList conceptList) Retires an active or pending concept from the ConceptList on the current date.
void	retireConceptList(ConceptList conceptList) Retires an active ConceptList on the current date.
void	setCodingSchemeDescription(CodingScheme scheme, String description) Sets the description of an existing CodingScheme.
void	setCodingSchemeOID(CodingScheme scheme, String oid) Sets the OID of an existing CodingScheme.
void	setCodingSchemeVersionDescription(CodingSchemeVersion version, String description) Sets the description of an existing CodingSchemeVersion.
void	setConceptDescriptionUsageContext(LocalConceptDescription description, UsageContext usageContext) Sets the UsageContext of a given LocalConceptDescription.
void	setConceptListAdditionInheritance(ConceptList cl, boolean flag) Sets the ConceptList to either inherit additions of concept members from its parent ConceptList or not.
void	setConceptListDefaultConcept(ConceptList list, Concept concept) Sets an active member as the default Concept for a ConceptList.
void	setConceptListDeletionInheritance(ConceptList cl, boolean flag) Sets the ConceptList to either inherit deletions of concept members from its parent ConceptList or not.
void	setConceptListDescription(ConceptList cl, String description) Sets a description of the ConceptList.
void	setConceptListMemberDescription(int memberDescriptionType, ConceptListMember member, ConceptDescription desc) Sets the member description for this ConceptListMember to an already existing local or terminology-defined description.
void	setConceptListUsageContext(ConceptList cl, UsageContext usageContext) Sets the usage context of a given ConceptList.
void	setCoreMember(ConceptList cl, Concept concept, boolean flag) Sets a flag indicating if the concept belongs to the core set of the ConceptList.
void	setLocaleMaps(CandidateLocaleMap[] candidateLocaleMaps) Writes multiple CandidateLocaleMap objects to the repository.
void	setLocallyPreferred(LocalConceptDescription localDesc) Sets a local description to be the default or locally preferred description for its concept.
void	updateMembershipActivationDate(Concept concept, ConceptList conceptList) Sets the activation date of a pending concept to the current date.
void	updateMembershipActivationDate(Concept concept, ConceptList conceptList, Date date) Sets the activation date of a pending concept to the specified date in the future.
void	updateMembershipRetirementDate(Concept concept, ConceptList conceptList, Date date) Retires an active or pending concept from the ConceptList on the specified date.

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

findClassificationByCode, findCodingScheme, findCodingSchemeVersion, findConcept, findConceptListMembers, findConcepts, findConcepts, findConcepts, findConcepts, findDescription, findDescriptionsForConceptIDs, findLocallyPreferredDescriptionsForConceptIDs, findMatchingClassificationsByDescription, findMatchingConceptsByDescriptionTerm, findMatchingConceptsByDescriptionTerm, findRelationship, findTerminologyPreferredDescriptionsForConceptIDs, getAdministrationServiceInstance, getAllCodingSchemes, getAllConceptLists, getAllConceptLists, getAllUsageContexts, getAuthoringServiceInstance, getCodingScheme, getCodingSchemeByOID, getConceptList, getConceptList, getConceptListByID, getConceptListGroupNames, getConceptListsByGroupName, getEquivalentConceptIDs, getEquivalentConceptIDs, getEquivalentConceptIDs, getMappingServiceInstance, getMatchingCodingSchemes, getMatchingConceptLists, getMatchingConceptListsByDescription, getMatchingUsageContexts, getMaxDate, getSystemDate, getUsageContext, getUsageContextForExternalOwner, getUsageContextOwnerTypes, isEquivalent, isEquivalent, narrowConceptResults, validateConceptListMembership

Method Detail

getAllVersionsForScheme

CodingSchemeVersion[] getAllVersionsForScheme(CodingScheme codingScheme)
                                       throws ETSBadParameterException,
                                              ETSDataException

Gets the CodingSchemeVersion objects currently contained in the repository given a valid CodingScheme.
NOTE: This method returns the quarantined and active versions.

Parameters:

codingScheme - CodingScheme to get all the version.

Returns:

Array of CodingScheme objects, or a zero-length array if no matching CodingScheme object is found.

Throws:

ETSBadParameterException - If an invalid scheme argument is passed.

ETSDataException - If a data transport error occurs.

addAttribute

void addAttribute(AttributableETSComponent component,
                  String name,
                  String value)
           throws ETSDataException,
                  ETSDuplicateException,
                  ETSBadParameterException

Adds a name/value pair to an AttributableETSComponent.

Parameters:

component - Component to which the attribute has to be added.

name - Name of the attribute.

value - Value of the attribute.

Throws:

ETSDuplicateException - If an attribute of this name has already been assigned to the AttributableETSComponent.

ETSBadParameterException - If the name is empty or null.

ETSDataException - If a data transport error occurs.

removeConceptList

void removeConceptList(ConceptList conceptList)
                throws ETSDataException,
                       ETSBadParameterException

Deprecated. Use retireConceptList(ConceptList).

Removes a ConceptList from the system. This method does not affect the concepts that are members of the ConceptList.

Parameters:

conceptList - ConceptList to be removed from the system.

Throws:

ETSBadParameterException - If passed an invalid ConceptList.

ETSDataException - If a data transport error occurs.

createConceptList

ConceptList createConceptList(String name,
                              String description)
                       throws ETSDuplicateException,
                              ETSDataException,
                              ETSBadParameterException

Creates a ConceptList.

Parameters:

name - Name for the ConceptList.

description - Description for the ConceptList.

Returns:

New empty ConceptList.

Throws:

ETSDuplicateException - If a ConceptList with the given name already exists.

ETSBadParameterException - If invalid arguments are passed.

ETSDataException - If a data transport error occurs.

createLocalConceptDescription

LocalConceptDescription createLocalConceptDescription(Concept concept,
                                                      String term,
                                                      UsageContext usageContext,
                                                      boolean isPreferred)
                                               throws ETSBadParameterException,
                                                      ETSDataException

Creates a new LocalConceptDescription for a given Concept in the in the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code).

Parameters:

concept - Concept to which this description will be added.

term - Text of the description.

usageContext - Usage context for the description. This argument is optional. null specifies no usage context. If this Concept object has another local description with the same usage context, the other description is set to have no usage context.

isPreferred - true if this description should be the default local description for this Concept object. If the value is set, this method will clear any other local description from being the default.

Returns:

Constructed LocalConceptDescription

Throws:

ETSBadParameterException - If the description is longer than allowed by the underlying database.

ETSDataException - If a data transport error occurs.

createLocalConceptDescription

LocalConceptDescription createLocalConceptDescription(Concept concept,
                                                      String term,
                                                      UsageContext usageContext,
                                                      boolean isPreferred,
                                                      Locale locale)
                                               throws ETSBadParameterException,
                                                      ETSDataException

Creates a new LocalConceptDescription for a given Concept for the specified Locale in the in the given Locale. The Locale must correspond to a valid language code. See the main package description for more information regarding Locale handling.

Parameters:

concept - Concept to which this description will be added.

term - Text of the description.

usageContext - Usage context for the description. This argument is optional. null specifies no usage context. If this Concept object has another local description with the same usage context, the other description is set to have no usage context.

isPreferred - true if this description should be the default local description for this Concept object. If the value is set, this method will clear any other local description from being the default for the given Locale.

locale - Locale associated with this description. The Locale should only consist of a language and territory. If the Locale object is null, the retrieved description will default to the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code).

Returns:

Constructed LocalConceptDescription

Throws:

ETSBadParameterException -

• If the description is longer than allowed by the underlying database.
• If the passed Locale parameter is not valid or the Locale contains a variant value.

ETSDataException - If a data transport error occurs.

Since:

5.3

createCodingScheme

CodingScheme createCodingScheme(String name,
                                String description,
                                String termModel,
                                String oid,
                                boolean isEditableFlag)
                         throws ETSDuplicateException,
                                ETSBadParameterException,
                                ETSDataException,
                                ETSUnsupportedOperationException

Creates a new CodingScheme with the given name, description, terminology model, and object identifier (OID) and if it is to be defined as editable.

Parameters:

name - Name of the new CodingScheme.

description - Description of the new CodingScheme.

termModel - Terminology model associated with the new CodingScheme. The valid value for this argument is one of the constants defined in the CodingScheme interface.

oid - CodingScheme object identifier (OID). At present, the passed in OID value is not checked to see if it is in the correct ISO format. This validation will be added in the future and the user is advised to verify that the passed in OID paramater is correctly formatted when calling this method. Information for the correct OID format is detailed in the following interface: OID Interface

isEditableFlag - Indicator if this CodingScheme is editable or not. If true, it is editable.

Returns:

Constructed CodingScheme.

Throws:

ETSDuplicateException - If a CodingScheme exists with the specified name or OID.

ETSBadParameterException - If invalid parameters are passed.

ETSDataException - If a data transport error occurs.

ETSUnsupportedOperationException

createCodingScheme

CodingScheme createCodingScheme(String name,
                                String description,
                                String termModel,
                                String oid)
                         throws ETSDuplicateException,
                                ETSBadParameterException,
                                ETSDataException,
                                ETSUnsupportedOperationException

Creates a new CodingScheme with the given name, description, terminology model, and object identifier (OID). This CodingScheme is not editable.

Parameters:

name - Name of the new CodingScheme.

description - Description of the new CodingScheme.

termModel - Terminology model associated with the new CodingScheme. The valid value for this argument is one of the constants defined in the CodingScheme interface. Currently, only the CodingScheme.CODINGSCHEME_MODEL_GENERIC constant is supported.

oid - CodingScheme object identifier (OID). At present, the passed in OID value is not checked to see if it is in the correct ISO format. This validation will be added in the future and the user is advised to verify that the passed in OID paramater is correctly formatted when calling this method. Information for the correct OID format is detailed in the following interface: OID Interface

Returns:

Constructed CodingScheme.

Throws:

ETSDuplicateException - If a CodingScheme exists with the specified name or OID.

ETSBadParameterException - If invalid parameters are passed.

ETSDataException - If a data transport error occurs.

ETSUnsupportedOperationException

createCodingScheme

CodingScheme createCodingScheme(String name,
                                String description,
                                String termModel)
                         throws ETSDuplicateException,
                                ETSBadParameterException,
                                ETSDataException,
                                ETSUnsupportedOperationException

Creates a new CodingScheme with the given name and description.

Parameters:

name - Name of the new CodingScheme.

description - Description of the new CodingScheme.

termModel - Terminology model associated with the new CodingScheme. The valid value for this argument is one of the constants defined in the CodingScheme interface. Currently, only the CodingScheme.CODINGSCHEME_MODEL_GENERIC constant is supported.

Returns:

Constructed CodingScheme.

Throws:

ETSDuplicateException - If a CodingScheme exists with the specified name.

ETSBadParameterException - If invalid parameters are passed.

ETSDataException - If a data transport error occurs.

ETSUnsupportedOperationException

setCodingSchemeOID

void setCodingSchemeOID(CodingScheme scheme,
                        String oid)
                 throws ETSDataException,
                        ETSBadParameterException,
                        ETSDuplicateException

Sets the OID of an existing CodingScheme.

Parameters:

scheme - CodingScheme that has to be updated.

oid - OID text for the new CodingScheme.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If invalid parameters are passed.

ETSDuplicateException - If a CodingScheme exists with the specified OID value.

setCodingSchemeDescription

void setCodingSchemeDescription(CodingScheme scheme,
                                String description)
                         throws ETSDataException,
                                ETSBadParameterException

Sets the description of an existing CodingScheme.

Parameters:

scheme - CodingScheme that has to be updated.

description - Description text for the new CodingScheme.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If invalid parameters are passed.

setCodingSchemeVersionDescription

void setCodingSchemeVersionDescription(CodingSchemeVersion version,
                                       String description)
                                throws ETSDataException,
                                       ETSBadParameterException

Sets the description of an existing CodingSchemeVersion.

Parameters:

version - CodingSchemeVersion that has to be updated.

description - Description text for the new CodingSchemeVersion.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If invalid parameters are passed.

createUsageContext

UsageContext createUsageContext(String name,
                                String description)
                         throws ETSDuplicateException,
                                ETSBadParameterException,
                                ETSDataException

Creates a new UsageContext with a given name and description.

Parameters:

name - Name of the new UsageContext.

description - Description of the new UsageContext.

Returns:

Constructed UsageContext.

Throws:

ETSDuplicateException - If a UsageContext exists with the specified name in the ETS repository.

ETSBadParameterException - If invalid parameters are passed.

ETSDataException - If a data transport error occurs.

removeConceptFromConceptList

void removeConceptFromConceptList(Concept concept,
                                  ConceptList conceptList)
                           throws ETSNotFoundException,
                                  ETSBadParameterException,
                                  ETSDataException

Deprecated. Use retireConceptInConceptList(Concept, ConceptList).

Removes a concept from membership in a ConceptList. If the concept was the default concept in the ConceptList, the ConceptList will no longer have a default concept.

Parameters:

concept - Concept to be removed.

conceptList - ConceptList to remove the Concept.

Throws:

ETSBadParameterException - If invalid arguments are passed .

ETSNotFoundException - If the concept was not a member of the ConceptList.

ETSDataException - If a data transport error occurs.

removeUsageContext

void removeUsageContext(UsageContext usageContext)
                 throws ETSBadParameterException,
                        ETSDataException

Removes a UsageContext from the system. Any ConceptDescription objects that had this UsageContext will no longer be part of a UsageContext.

Parameters:

usageContext - UsageContext that has to be removed from the system.

Throws:

ETSBadParameterException - If an invalid usage context is passed.

ETSDataException - If a data transport error occurs.

addConceptToConceptList

void addConceptToConceptList(Concept concept,
                             ConceptList conceptList)
                      throws ETSDuplicateException,
                             ETSDataException,
                             ETSBadParameterException

Deprecated. Use addConceptToConceptList(Concept,String,ConceptList).

Adds a concept to a given ConceptList.

Parameters:

concept - Concept to be added.

conceptList - ConceptList to add the Concept.

Throws:

ETSDuplicateException - If the Concept is already a member of the ConceptList.

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If invalid parameters, such as null, are passed.

setConceptListDefaultConcept

void setConceptListDefaultConcept(ConceptList list,
                                  Concept concept)
                           throws ETSNotFoundException,
                                  ETSBadParameterException,
                                  ETSDataException

Sets an active member as the default Concept for a ConceptList. If this ConceptList already has a default Concept, this flag is cleared for that Concept, so that the list has only one default Concept.

Parameters:

list - ConceptList being altered.

concept - Concept to become the new default, which must be a member of the ConceptList.

Throws:

ETSNotFoundException - If the specified Concept is not already an active member of the ConceptList.

ETSBadParameterException - If invalid Concept or ConceptList is passed.

ETSDataException - If a data transport error occurs.

setConceptDescriptionUsageContext

void setConceptDescriptionUsageContext(LocalConceptDescription description,
                                       UsageContext usageContext)
                                throws ETSBadParameterException,
                                       ETSNotFoundException,
                                       ETSDataException

Sets the UsageContext of a given LocalConceptDescription. If another local description for the same concept has this usage context, it is set to have no usage context.

Parameters:

description - LocalConceptDescription to be altered.

usageContext - UsageContext to be assigned to the description.

Throws:

ETSBadParameterException - If invalid arguments are passed.

ETSNotFoundException - If local description or usage context could not be found in repository.

ETSDataException - If a data transport error occurs.

removeAttributes

boolean removeAttributes(AttributableETSComponent component,
                         String name)
                  throws ETSDataException,
                         ETSBadParameterException

Removes all of the attributes with the specified name from an AttributableETSComponent.

Parameters:

component - Component to be altered.

name - Name for which all name/value pairs will be deleted.

Returns:

true if any attributes matched and were removed.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If invalid arguments are passed.

removeAttribute

boolean removeAttribute(AttributableETSComponent component,
                        String name,
                        String value)
                 throws ETSDataException,
                        ETSBadParameterException

Removes a single name/value pair from an AttributableETSComponent.

Parameters:

component - Component to be altered.

name - Name from the name/value pair to be deleted.

value - Value from the name/value pair to be deleted.

Returns:

true if any attributes matched and were removed.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If invalid arguments are passed.

makeDefaultVersion

void makeDefaultVersion(CodingSchemeVersion version)
                 throws ETSBadParameterException,
                        ETSDataException

Makes a CodingSchemeVersion the default version of the CodingScheme. This will clear the default flag for any other version of the CodingScheme, to ensure that only one default version exists.

Parameters:

version - CodingSchemeVersion to be made default.

Throws:

ETSBadParameterException - If the CodingSchemeVersion is quarantined or if it is already the default version of this CodingScheme object.

ETSDataException - If a data transport error occurs.

activate

void activate(CodingSchemeVersion version)
       throws ETSDataException,
              ETSBadParameterException

Marks a CodingSchemeVersion as active.

Parameters:

version - CodingSchemeVersion to be made active. The CodingSchemeVersion must be quarantined or retired before this method is called.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the CodingSchemeVersion is already active.

retire

void retire(CodingSchemeVersion version,
            Date retireDate)
     throws ETSBadParameterException,
            ETSDataException

Retires the component, optionally specifying the retirement date.

Parameters:

version - CodingSchemeVersion to be retired. The CodingSchemeVersion must be quarantined or retired before this method is called.

retireDate - Date that will be recorded for the component's retirement. This argument is optional.

Throws:

ETSBadParameterException - If the component is already retired.

ETSDataException - If a data transport error occurs.

retire

void retire(RetirableETSComponent component,
            Date retireDate)
     throws ETSDataException,
            ETSBadParameterException,
            ETSUnsupportedOperationException

Retires the RetirableETSComponent, optionally specifying the retirement date.

Parameters:

component - RetirableETSComponent to be retired. The CodingSchemeVersion must be quarantined or retired before this method is called.

retireDate - Retirement date. This argument is optional.

Throws:

ETSBadParameterException - If the component is invalid or retired.

ETSDataException - If a data transport error occurs.

ETSUnsupportedOperationException - If the component is not reassignable.

setLocallyPreferred

void setLocallyPreferred(LocalConceptDescription localDesc)
                  throws ETSBadParameterException,
                         ETSDataException

Sets a local description to be the default or locally preferred description for its concept. This will clear any other local descriptions from being the preferred one for this Concept.

Parameters:

localDesc - Local description to be made default.

Throws:

ETSBadParameterException - If the description is invalid.
NOTE: If localDesc is retired, the preferred flag cannot be set and this exception is thrown.

ETSDataException - If a data transport error occurs.

getStagedServiceInstance

StagedService getStagedServiceInstance()

Gets a handle to the StagedService, which provides services for dealing with the ETS terminology staging area.

Returns:

StagedService object.

createConceptList

ConceptList createConceptList(String name,
                              String description,
                              ConceptList parentConceptList,
                              String groupName,
                              boolean newGroupFlag,
                              boolean restrictedFlag,
                              boolean inheritAdditionFlag,
                              boolean inheritDeletionFlag,
                              int status,
                              UsageContext usageContext)
                       throws ETSDuplicateException,
                              ETSBadParameterException,
                              ETSDataException

Creates a user-defined ConceptList with parent-child relationship properties, such as inheritance, restriction, and usage context specialization, in addition to ConceptList properties, such as status and group names. If the list created is defined as a parent list, it will initially contain an empty set of concept members. If the list created is a child list, it will initially contain all active and pending concept members of its parent with identical membership codes and core set flags. Membership dates will be identical, except for membership activation dates set before the creation date of the child list. In these cases, the dates will be clipped into the future to the child list's creation date (current date).
NOTE: There is no clipping of retirement dates as retired concept members are not passed down to the child.

Parameters:

name - Name of the ConceptList.

description - Description of the ConceptList.

parentConceptList - Parent of this ConceptList or null if there is no parent.

groupName - Name of the group to which the ConceptList belongs. ETS predefines two groups, LOOKUPS and UNSPECIFIED. The names of these groups are provided as constants on the ConceptList interface.

newGroupFlag - true if new group is to be created and false if using existing group. If null, flag is set to false.

restrictedFlag - true if created ConceptList is to restricted. If null, flag is set to false.

inheritAdditionFlag - true if ConceptList is to inherit additions of Concept objects from its parent list. If null, flag is set to false.

inheritDeletionFlag - true if ConceptList is to inherit deletions of Concept objects from its parent list. If null, flag is set to false.

status - Active status of ConceptList as defined in the ConceptList interface.

usageContext - Usage context linking the created list to its parent. The usage context can be null if not needed.

Returns:

Created ConceptList.

Throws:

ETSDuplicateException -

• If the specified ConceptList already exists.
• If the ConceptList being created is a child list and one of its siblings already has the usageContext as a usage context assignment.

ETSBadParameterException -

• If a group with the name of groupName does not exist and newGroupFlag is false, or if groupName is null or an empty String.
• If the created ConceptList has a parent and its groupname does not match the groupname of its parent.
• If restrictedFlag is true and inheritanceDelFlag is false, as restricted lists must inherit deletions to their parent's members.
• If name is an empty String or null.
• If description is an empty String or null.
• If status constant is not STATUS_ACTIVE or STATUS_RETIRED.

ETSDataException - If a data transport error occurs.

addConceptToConceptList

void addConceptToConceptList(Concept concept,
                             String code,
                             ConceptList conceptList,
                             Date activationDate)
                      throws ETSBadParameterException,
                             ETSDuplicateException,
                             ETSDataException,
                             ETSUnsupportedOperationException

Adds a concept to a given ConceptList that will be activated at a specified date in the future.

Parameters:

concept - Concept being added.

code - Concept membership code.

conceptList - ConceptList that the concept is being added to.

activationDate - Date when this Concept is activated. If current date is the activation date, the activationDate parameter can be ignored.

Throws:

ETSDuplicateException -

• If Concept already exists and is an active or pending member in ConceptList.
• If any children lists that inherit additions contain this Concept.

ETSUnsupportedOperationException -

• If ConceptList is system-defined.
• If ConceptList is restricted, and Concept does not belong to the parent of the ConceptList.

ETSBadParameterException -

• If code is null or an empty String.
• If activationDate is null or is before the current date.
• If any other parameter is null.

ETSDataException - If a data transport error occurs.

addConceptToConceptList

void addConceptToConceptList(Concept concept,
                             String code,
                             ConceptList conceptList)
                      throws ETSBadParameterException,
                             ETSDuplicateException,
                             ETSDataException,
                             ETSUnsupportedOperationException

Adds a concept to a given ConceptList that is activated on the current date.

Parameters:

concept - Concept being added.

code - Concept membership code.

conceptList - ConceptList that the concept is being added to.

Throws:

ETSDuplicateException -

• If Concept already exists and is an active or pending member in ConceptList.
• If any children lists that inherit additions contain this Concept.

ETSBadParameterException - If code is null or an empty String, or if any other parameter is null.

ETSUnsupportedOperationException -

• If ConceptList is system-defined.
• If ConceptList is restricted, and Concept does not belong to the parent of the ConceptList.

ETSDataException - If a data transport error occurs.

addConceptToConceptList

void addConceptToConceptList(Concept concept,
                             String code,
                             ConceptList conceptList,
                             ConceptDescription printName,
                             ConceptDescription shortName,
                             ConceptDescription longName)
                      throws ETSBadParameterException,
                             ETSDuplicateException,
                             ETSDataException,
                             ETSUnsupportedOperationException

Adds a concept to a given ConceptList that is activated on the current date.

Parameters:

concept - Concept being added.

code - Concept membership code.

conceptList - ConceptList that the concept is being added to.

printName - Print name description for this ConceptListMember. A null parameter can be passed if the argument is not required.

shortName - Short name description for this ConceptListMember. A null parameter can be passed if the argument is not required.

longName - Long name description for this ConceptListMember. A null parameter can be passed if the argument is not required.

Throws:

ETSDuplicateException -

• If Concept already exists and is an active or pending member in ConceptList.
• If any children lists that inherit additions contain this Concept.

ETSBadParameterException -

• If code is null or an empty String.
• If concept or conceptList is null.

ETSUnsupportedOperationException -

• If ConceptList is system-defined.
• If ConceptList is restricted, and Concept does not belong to the parent of the ConceptList.

ETSDataException - If a data transport error occurs.

addConceptToConceptList

void addConceptToConceptList(Concept concept,
                             String code,
                             ConceptList conceptList,
                             Date activationDate,
                             ConceptDescription printName,
                             ConceptDescription shortName,
                             ConceptDescription longName)
                      throws ETSBadParameterException,
                             ETSDuplicateException,
                             ETSDataException,
                             ETSUnsupportedOperationException

Adds a concept to a given ConceptList that will be activated at a specified date in the future. ConceptDescription objects can also be tied to this ConceptListMember. This method can be used to set the terminology-preferred and locally preferred descriptions of the ConceptListMember.

Parameters:

concept - Concept being added.

code - Membership code of the concept being added.

conceptList - ConceptList that the concept is being added to.

activationDate - Date when this Concept is activated. If current date is the activation date, the activationDate parameter can be ignored.

printName - Print name description for this ConceptListMember. A null parameter can be passed if the argument is not required.

shortName - Short name description for this ConceptListMember. A null parameter can be passed if the argument is not required.

longName - Long name description for this ConceptListMember. A null parameter can be passed if the argument is not required.

Throws:

ETSDuplicateException -

• If Concept already exists and is an active or pending member in ConceptList.
• If any children lists that inherit additions contain this Concept.

ETSUnsupportedOperationException -

• If ConceptList is system-defined.
• If ConceptList is restricted, and Concept does not belong to the parent of the ConceptList.

ETSBadParameterException -

• If code is null or an empty String.
• If activationDate is before the current date or null.
• If concept or conceptList is null.

ETSDataException - If a data transport error occurs.

activateConceptList

void activateConceptList(ConceptList conceptList)
                  throws ETSBadParameterException,
                         ETSDataException,
                         ETSUnsupportedOperationException

Activates a retired ConceptList.

Parameters:

conceptList - ConceptList being activated.

Throws:

ETSBadParameterException - If ConceptList is null.

ETSUnsupportedOperationException - If ConceptList is system-defined or active.

ETSDataException - If a data transport error occurs.

retireConceptList

void retireConceptList(ConceptList conceptList)
                throws ETSBadParameterException,
                       ETSDataException,
                       ETSUnsupportedOperationException

Retires an active ConceptList on the current date.
NOTE: This method retires all children lists as well.

Parameters:

conceptList - ConceptList being retired.

Throws:

ETSBadParameterException - If ConceptList is null.

ETSUnsupportedOperationException - If ConceptList is system-defined or retired.

ETSDataException - If a data transport error occurs.

retireConceptInConceptList

void retireConceptInConceptList(Concept concept,
                                ConceptList conceptList)
                         throws ETSBadParameterException,
                                ETSNotFoundException,
                                ETSDataException,
                                ETSUnsupportedOperationException

Retires an active or pending concept from the ConceptList on the current date. Changes the status of the membership of the concept from pending or active to retired or active. This method checks and retires the concept in any restricted children lists this ConceptList may have.

Parameters:

concept - Concept being retired.

conceptList - ConceptList containing the concept.

Throws:

ETSBadParameterException - If Concept or ConceptList is null.

ETSNotFoundException - If Concept does not belong to the ConceptList.

ETSUnsupportedOperationException - If membership of the Concept is system-defined, or if Concept is retired.

ETSDataException - If a data transport error occurs.

updateMembershipRetirementDate

void updateMembershipRetirementDate(Concept concept,
                                    ConceptList conceptList,
                                    Date date)
                             throws ETSBadParameterException,
                                    ETSNotFoundException,
                                    ETSDataException,
                                    ETSUnsupportedOperationException

Retires an active or pending concept from the ConceptList on the specified date. Changes the status of the membership of the concept from pending or active to retired or active. This method checks and retires the concept in any restricted children lists this ConceptList may have.

Parameters:

concept - Concept being retired.

conceptList - ConceptList containing the concept.

date - Date when the concept is retired .

Throws:

ETSBadParameterException - If Concept or ConceptList is null, or if date is not before the current date. null date values can be entered for non-restricted lists to represent infinity. If the list is restricted, this exception will be thrown if the date is after the parent's retired date.

ETSNotFoundException - If the concept does not belong to the ConceptList.

ETSUnsupportedOperationException - If membership of the Concept is system-defined, or if Concept is retired.

ETSDataException - If a data transport error occurs.

updateMembershipActivationDate

void updateMembershipActivationDate(Concept concept,
                                    ConceptList conceptList)
                             throws ETSBadParameterException,
                                    ETSNotFoundException,
                                    ETSDataException,
                                    ETSUnsupportedOperationException

Sets the activation date of a pending concept to the current date. This method changes the status of the membership of the concept from pending to active.

Parameters:

concept - Concept being activated.

conceptList - ConceptList containing the concept.

Throws:

ETSBadParameterException - If Concept or ConceptList is null.

ETSUnsupportedOperationException - If membership of the Concept is system-defined, or is active or retired.

ETSNotFoundException - If the Concept does not belong to the ConceptList.

ETSDataException - If a data transport error occurs.

updateMembershipActivationDate

void updateMembershipActivationDate(Concept concept,
                                    ConceptList conceptList,
                                    Date date)
                             throws ETSBadParameterException,
                                    ETSNotFoundException,
                                    ETSDataException,
                                    ETSUnsupportedOperationException

Sets the activation date of a pending concept to the specified date in the future. This method changes the status of the membership of the concept from pending to active or leaves the status as pending.

Parameters:

concept - Concept being activated.

conceptList - ConceptList containing the concept.

date - Date on which the concept has to be activated. If current date is the activation date, this parameter can be ignored.

Throws:

ETSBadParameterException -

• If Concept or ConceptList is null.
• If date is null or not later than the current date, or later than the membership retire date of the Concept.
• If the list is restricted and if the date is before the parent's activation date.

ETSUnsupportedOperationException - If membership of the Concept is system-defined, or is active or retired.

ETSNotFoundException - If the Concept does not belong to the ConceptList.

ETSDataException - If a data transport error occurs.

setConceptListDescription

void setConceptListDescription(ConceptList cl,
                               String description)
                        throws ETSDataException,
                               ETSBadParameterException,
                               ETSUnsupportedOperationException

Sets a description of the ConceptList. The maximum length of this attribute is 240.

Parameters:

cl - ConceptList object.

description - description of the ConceptList.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If argument passed is a null or an empty description, or if ConceptList is null.

ETSUnsupportedOperationException - If extensibility of concept list is "SYSTEM" or "EXTENSIBLE" as modification by users is not allowed.

setConceptListAdditionInheritance

void setConceptListAdditionInheritance(ConceptList cl,
                                       boolean flag)
                                throws ETSDataException,
                                       ETSUnsupportedOperationException,
                                       ETSBadParameterException

Sets the ConceptList to either inherit additions of concept members from its parent ConceptList or not.

Parameters:

cl - ConceptList object.

flag - If true, the ConceptList inherits additions from its parent.

Throws:

ETSDataException - If a data transport error occurs.

ETSUnsupportedOperationException - If extensibility of ConceptList is "SYSTEM" or "EXTENSIBLE" as modification by users is not allowed.

ETSBadParameterException - If ConceptList is null.

setConceptListDeletionInheritance

void setConceptListDeletionInheritance(ConceptList cl,
                                       boolean flag)
                                throws ETSDataException,
                                       ETSUnsupportedOperationException,
                                       ETSBadParameterException

Sets the ConceptList to either inherit deletions of concept members from its parent ConceptList or not.

Parameters:

cl - ConceptList object.

flag - If true, the ConceptList inherits deletions from its parent.

Throws:

ETSDataException - If a data transport error occurs.

ETSUnsupportedOperationException - If extensibility of ConceptList is "SYSTEM" or "EXTENSIBLE" as modification by users is not allowed.

ETSBadParameterException - If flag is false and the ConceptList is restricted as restricted lists must inherit deletions to their parent.

setCoreMember

void setCoreMember(ConceptList cl,
                   Concept concept,
                   boolean flag)
            throws ETSBadParameterException,
                   ETSDataException,
                   ETSNotFoundException

Sets a flag indicating if the concept belongs to the core set of the ConceptList. Concept must be an active or pending member of the ConceptList to belong to the core set.

Parameters:

cl - ConceptList object.

concept - Concept whose flag is being set.

flag - If true, this method sets concept to be a member of core set.

Throws:

ETSBadParameterException - If Concept or ConceptList is null.

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If Concept is not found as an active or pending member of the ConceptList.

setConceptListUsageContext

void setConceptListUsageContext(ConceptList cl,
                                UsageContext usageContext)
                         throws ETSBadParameterException,
                                ETSDataException

Sets the usage context of a given ConceptList. If another sibling ConceptList has this usage context, the sibling list is set to have no usage context.

Parameters:

cl - ConceptList to be altered.

usageContext - Usage context to be assigned to the description.

Throws:

ETSBadParameterException - If invalid arguments are passed.

ETSDataException - If a data transport error occurs.

associateUsageContextWithExternalOwner

void associateUsageContextWithExternalOwner(UsageContext usageContext,
                                            String ownerType,
                                            String ownerID)
                                     throws ETSDataException,
                                            ETSBadParameterException

Associates a usage context with an owner identifier. If the owner is already associated with another usage context, this method clears that association. ETS offers a simple mapping between external identifiers and usage contexts as a convenience. These mappings have no direct effect on the behavior of ETS, but can be useful for applications trying to find the most appropriate usage context for a particular user, organization, or profession.

Parameters:

usageContext - Usage context to associate with the owner. If null, this method clears any existing association for the owner.

ownerType - Type of owner identifier, which defines an identifier space. Examples of owner identifier types are organization identifiers and staff members.

ownerID - Identifier of the external owner.

Throws:

ETSBadParameterException - If the ownerType or ownerID parameters are null, or if they are zero-length strings.

ETSDataException - If a data transport error occurs.

setConceptListMemberDescription

void setConceptListMemberDescription(int memberDescriptionType,
                                     ConceptListMember member,
                                     ConceptDescription desc)
                              throws ETSBadParameterException,
                                     ETSDataException,
                                     ETSUnsupportedOperationException

Sets the member description for this ConceptListMember to an already existing local or terminology-defined description.

Parameters:

memberDescriptionType - Constants representing the type of description being set. These constants are: MEMBER_DESC_PRINT, MEMBER_DESC_SHORT, or MEMBER_DESC_LONG. These constants represent the member's print, short, and long name descriptions respectively.

member - ConceptListMember object.

desc - ConceptDescription to be set as one of the member descriptions. If null, the description is reset.

Throws:

ETSBadParameterException -

• If desc is not a local description or terminology-defined description tied to the associated concept of member.
• If member is null.
• If one of the allowable constants as defined above is not passed in for memberDescriptionType.

ETSUnsupportedOperationException - If member is not active in its associated ConceptList.

ETSDataException - If a data transport error occurs.

deleteMapSet

void deleteMapSet(MapSet mapSet)
           throws ETSBadParameterException,
                  ETSDataException

Deletes a MapSet and all of it associative contents.

Parameters:

mapSet - The MapSet that has to be deleted.

Throws:

ETSBadParameterException - If the MapSet is null.

ETSDataException - If a data transport error occurs.

createClassification

Classification createClassification(CandidateClassification candidateClassification)
                             throws ETSDuplicateException,
                                    ETSDataException,
                                    ETSBadParameterException,
                                    ETSValidationException

Creates a classification with the given CandidateClassification object.

Parameters:

candidateClassification - CandidateClassification object.

Returns:

Classification object.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If candidateClassification is null.

ETSDuplicateException - If another classification with the same candidateClassification concept code exists.

ETSValidationException - If one of the validations carried out against candidateClassification fails, or if classification does not have only one of its CandidateClassificationDescription set as preferred.

addClassificationDescription

void addClassificationDescription(CandidateConceptDescription description,
                                  Classification classification)
                           throws ETSBadParameterException,
                                  ETSDataException,
                                  ETSValidationException

Adds a description of a classification.

Parameters:

description - CandidateConceptDescription object.

classification - Classification object.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If classification or description is null.

ETSValidationException - If one of the validations carried out against description object fails, or if classification does not have only one of its CandidateClassificationDescription set as preferred.

addClassificationDescriptions

void addClassificationDescriptions(CandidateConceptDescription[] description,
                                   Classification classification)
                            throws ETSBadParameterException,
                                   ETSDataException,
                                   ETSValidationException

Adds descriptions to a classification.

Parameters:

description - Array of CandidateConceptDescription objects.

classification - Classification object.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If classification or description is null, or array of description contains null elements.

ETSValidationException - If one of the validations carried out against description object fails, or if classification does not have only one of its CandidateClassificationDescription set as preferred.

activateClassification

void activateClassification(Classification classification)
                     throws ETSBadParameterException,
                            ETSDataException,
                            ETSUnsupportedOperationException

Marks a classification as active. This method will move the classification from the Retired to Pending state. Also, Concept status code will be set to Active. The ETS Classification Builder will process all classifications that are in the Pending or Dirty state. Retired classifications will not be built.

This method will have different behavior depending of the current state of the classification:

• Active: There will be no operation if classification is in the Active state.
• Pending: There will be no operation if classification is already in the Pending state.
• Retired: ETS will transition classification from the Retired to the Pending state, in order for the ETS classification builder to process it.
• Dirty: ETS will throw ETSUnsupportedOperationException. A classification cannot be activated if it is in the Dirty state. The ETS builder should rebuild the classification.

Parameters:

classification - Classification object.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If classification is null.

ETSUnsupportedOperationException - If this method is invoked when classification is in the Dirty state.

See Also:

retireClassification(Classification)

addChildClassification

void addChildClassification(Classification parent,
                            Classification child,
                            int inclusionOption)
                     throws ETSBadParameterException,
                            ETSDataException

Adds a child classification to a parent classification. This method will not throw an exception if the child contains concepts that currently exist in the parent classification, or if the child is already the child of another classification.

Parameters:

parent - Parent classification.

child - Child classification.

inclusionOption - Indicates if the contents of the child are to be added along with the child classification. The valid value is ADD_CHILD_INCLUDE_CONTENTS as defined in the ClassificationDeclaration interface. This constant includes all child contents.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException -

• If parent is null.
• If child is null.
• If child is an ancestor of parent.
• If child is an immediate descendant of parent.
• If child is the same as the parent.
• If inclusionOption is not one of the specified constants.
• If adding child causes a circular reference with the existing classification declarations.

removeChildClassification

void removeChildClassification(Classification parent,
                               Classification child)
                        throws ETSBadParameterException,
                               ETSDataException

Removes a child classification from a parent classification.

Parameters:

parent - Parent classification.

child - Child classification.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException -

• If parent is null.
• If child is null.
• If parent code is the same as the child code.

retireClassification

void retireClassification(Classification classification)
                   throws ETSBadParameterException,
                          ETSDataException

Retires a classification, moving the classification to the Retired state. The builder process and queries on ETS will not be executed on classifications that are in the retired state.

This API will also transition the Concept status code to Retired.

Parameters:

classification - Classification object.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If classification is null.

addDeclarationToClassification

void addDeclarationToClassification(Concept concept,
                                    Classification classification,
                                    int inclusionOption)
                             throws ETSDuplicateException,
                                    ETSDataException,
                                    ETSBadParameterException

Adds a declaration to a classification.

Parameters:

concept - Concept to be added.

classification - Classification object.

inclusionOption - Indicates if the concept itself is to be added to the classification and which of the concept's descendents in its native terminology, if any, are to be added to the classification. The possible values are defined in ClassificationDeclaration interface. These constants are:

• ADD_DECLARATION_CONCEPT: Indicates that only the concept itself will be added to classification.
• ADD_DECLARATION_DIRECT_CHILDREN_ONLY: Indicates that only the direct children of concept within its native terminology will be added to classification, excluding the concept itself.
• ADD_DECLARATION_ALL_DESCENDANT: Indicates that all the descendants of the concept within its native terminology will be added to classification, but not the concept itself.
• ADD_DECLARATION_CONCEPT_AND_DIRECT_CHILDREN_ONLY: Indicates that concept and only its direct children within its native terminology will be added to the classification.
• ADD_DECLARATION_CONCEPT_AND_ALL_DESCENDANT: Indicates that the concept and all its descendants within its native terminology will be added to the classification.

Throws:

ETSDuplicateException - If concept exists in the classification declaration.

ETSDataException - If a data transport error occurs.

ETSBadParameterException -

• If inclusionOption value is other than the specified constants.
• If concept is null.
• If classification is null.
• If inclusionOption is not one of the constants defined in ClassificationDeclaration interface.

addDeclarationsToClassification

void addDeclarationsToClassification(Concept[] concepts,
                                     Classification classification,
                                     int[] inclusionOption)
                              throws ETSDuplicateException,
                                     ETSDataException,
                                     ETSBadParameterException

Adds a declaration to a classification.

Parameters:

concepts - Array of concepts that has to be added.

classification - Classification object.

inclusionOption - Indicates if the concept itself or just its children are to be added to the Classification object. The possible values are the same as defined in addDeclarationToClassification(Concept concept, Classification classification, int inclusionOption) method.

Throws:

ETSDuplicateException - If Concept objects already exists in a declaration of the classification .

ETSDataException - If a data transport error occurs.

ETSBadParameterException -

• If the value of inclusionOption is other than the specified constants.
• If the length of inclusionOption is different from the length of Concept objects.
• If Concept objects contains null elements.
• If Concept objects is null.
• If classification is null.
• If inclusionOption is null.

removeDeclarationsFromClassification

void removeDeclarationsFromClassification(ClassificationDeclaration[] declaration,
                                          Classification classification)
                                   throws ETSDataException,
                                          ETSBadParameterException

Removes an array of declarations from a classification.

Parameters:

declaration - Array of ClassificationDeclaration objects.

classification - Classification object.

Throws:

ETSBadParameterException -

• If classification or declaration is null.
• If declaration contains null elements.
• If classification does not contain this declaration.

ETSDataException - If a data transport error occurs.

removeDeclarationFromClassification

void removeDeclarationFromClassification(ClassificationDeclaration declaration,
                                         Classification classification)
                                  throws ETSDataException,
                                         ETSBadParameterException

Removes a declaration from a classification.

Parameters:

declaration - Array of ClassificationDeclaration objects.

classification - Classification object.

Throws:

ETSBadParameterException -

• If classification or declaration is null.
• if classification does not contain this declaration.

ETSDataException - If a data transport error occurs.

newCandidateLocaleMap

CandidateLocaleMap newCandidateLocaleMap()

Creates a new instance of the CandidateLocaleMap object.

Returns:

CandidateLocaleMap

newCandidateLocaleMap

CandidateLocaleMap newCandidateLocaleMap(LocaleMap localeMap)
                                  throws ETSDataException

Creates a new instance of the CandidateLocaleMap object - uses the values in the LocaleMap to create a CandidateLocalMap. No reference to the LocaleMap object is kept.

Parameters:

localeMap - LocaleMap object whose values are used to create a CandidateLocaleMap object.

Returns:

CandidateLocaleMap

Throws:

ETSDataException - If a data transport error occurs.

setLocaleMaps

void setLocaleMaps(CandidateLocaleMap[] candidateLocaleMaps)
            throws ETSDataException,
                   ETSBadParameterException,
                   ETSDuplicateException

Writes multiple CandidateLocaleMap objects to the repository. If the CodingSchemeVersion object and source Locale exist, the target Locale will be updated with the value stored in the CandidateLocaleMap object. If the CodingSchemeVersion object and source Locale do not exist, a new LocaleMap object will be created.

Parameters:

candidateLocaleMaps - an array of CandidateLocaleMap objects to be created or updated.

Throws:

ETSDataException - If a data transport error has occurred.

ETSBadParameterException -

• If an array element is null.
• If any of the CandidateLocaleMap members contain a null CodingSchemeVersion, source Locale or target Locale object.
• If the target or source Locale has not been installed.
• If the target Locale is not a supported Locale for the CodingSchemeVersion referenced by the CandidateLocaleMap.

ETSDuplicateException - If there exists more than one member of the array with the same CodingSchemeVersion object and SourceLocale.

invalidateETSCache

void invalidateETSCache()
                 throws oracle.hsgbu.ets.exceptions.common.ETSDAOException

This is the API to invalidate the caches of ETS.

Throws:

oracle.hsgbu.ets.exceptions.common.ETSDAOException