public interface ETSAdministrationService extends ETSService
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.ETSService
LOOKUP_GROUP_NAME
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.
|
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.
|
void |
removeConceptList(ConceptList conceptList)
Deprecated.
|
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. |
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
CodingSchemeVersion[] getAllVersionsForScheme(CodingScheme codingScheme) throws ETSBadParameterException, ETSDataException
CodingSchemeVersion
objects currently contained in
the repository given a valid CodingScheme
.
codingScheme
- CodingScheme
to get all the version.CodingScheme
objects, or a zero-length array if
no matching CodingScheme
object is found.ETSBadParameterException
- If an invalid scheme argument is passed.ETSDataException
- If a data transport error occurs.void addAttribute(AttributableETSComponent component, String name, String value) throws ETSDataException, ETSDuplicateException, ETSBadParameterException
AttributableETSComponent
.component
- Component to which the attribute has to be added.name
- Name of the attribute.value
- Value of the attribute.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.void removeConceptList(ConceptList conceptList) throws ETSDataException, ETSBadParameterException
retireConceptList(ConceptList)
.ConceptList
from the system. This method does not affect the
concepts that are members of the ConceptList
.conceptList
- ConceptList
to be removed from the system.ETSBadParameterException
- If passed an invalid ConceptList
.ETSDataException
- If a data transport error occurs.ConceptList createConceptList(String name, String description) throws ETSDuplicateException, ETSDataException, ETSBadParameterException
ConceptList
.name
- Name for the ConceptList
.description
- Description for the ConceptList
.ConceptList
.ETSDuplicateException
- If a ConceptList
with the given name
already exists.ETSBadParameterException
- If invalid arguments are passed.ETSDataException
- If a data transport error occurs.LocalConceptDescription createLocalConceptDescription(Concept concept, String term, UsageContext usageContext, boolean isPreferred) throws ETSBadParameterException, ETSDataException
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).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.LocalConceptDescription
ETSBadParameterException
- If the description is longer than allowed
by the underlying database.ETSDataException
- If a data transport error occurs.LocalConceptDescription createLocalConceptDescription(Concept concept, String term, UsageContext usageContext, boolean isPreferred, Locale locale) throws ETSBadParameterException, ETSDataException
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.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).LocalConceptDescription
ETSBadParameterException
- Locale
parameter is not valid
or the Locale
contains a variant value.
ETSDataException
- If a data transport error occurs.CodingScheme createCodingScheme(String name, String description, String termModel, String oid, boolean isEditableFlag) throws ETSDuplicateException, ETSBadParameterException, ETSDataException, ETSUnsupportedOperationException
CodingScheme
with the given name, description,
terminology model, and object identifier (OID) and if it is to be defined
as editable.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.CodingScheme
.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
CodingScheme createCodingScheme(String name, String description, String termModel, String oid) throws ETSDuplicateException, ETSBadParameterException, ETSDataException, ETSUnsupportedOperationException
CodingScheme
with the given name, description,
terminology model, and object identifier (OID). This CodingScheme
is not editable.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
CodingScheme
.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
CodingScheme createCodingScheme(String name, String description, String termModel) throws ETSDuplicateException, ETSBadParameterException, ETSDataException, ETSUnsupportedOperationException
CodingScheme
with the given name and description.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.CodingScheme
.ETSDuplicateException
- If a CodingScheme
exists with the specified name.ETSBadParameterException
- If invalid parameters are passed.ETSDataException
- If a data transport error occurs.ETSUnsupportedOperationException
void setCodingSchemeOID(CodingScheme scheme, String oid) throws ETSDataException, ETSBadParameterException, ETSDuplicateException
CodingScheme
.scheme
- CodingScheme
that has to be updated.oid
- OID text for the new CodingScheme
.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If invalid parameters are passed.ETSDuplicateException
- If a CodingScheme
exists with the specified OID value.void setCodingSchemeDescription(CodingScheme scheme, String description) throws ETSDataException, ETSBadParameterException
CodingScheme
.scheme
- CodingScheme
that has to be updated.description
- Description text for the new CodingScheme
.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If invalid parameters are passed.void setCodingSchemeVersionDescription(CodingSchemeVersion version, String description) throws ETSDataException, ETSBadParameterException
CodingSchemeVersion
.version
- CodingSchemeVersion
that has to be updated.description
- Description text for the new CodingSchemeVersion
.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If invalid parameters are passed.UsageContext createUsageContext(String name, String description) throws ETSDuplicateException, ETSBadParameterException, ETSDataException
UsageContext
with a given name and description.name
- Name of the new UsageContext
.description
- Description of the new UsageContext
.UsageContext
.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.void removeConceptFromConceptList(Concept concept, ConceptList conceptList) throws ETSNotFoundException, ETSBadParameterException, ETSDataException
retireConceptInConceptList(Concept, ConceptList)
.ConceptList
. If the concept was
the default concept in the ConceptList
, the ConceptList
will no longer have a default concept.concept
- Concept to be removed.conceptList
- ConceptList
to remove the Concept.ETSBadParameterException
- If invalid arguments are passed .ETSNotFoundException
- If the concept was not a member of the ConceptList
.ETSDataException
- If a data transport error occurs.void removeUsageContext(UsageContext usageContext) throws ETSBadParameterException, ETSDataException
UsageContext
from the system. Any ConceptDescription
objects
that had this UsageContext
will no longer be part of a
UsageContext
.usageContext
- UsageContext
that has to be removed from the system.ETSBadParameterException
- If an invalid usage context is passed.ETSDataException
- If a data transport error occurs.void addConceptToConceptList(Concept concept, ConceptList conceptList) throws ETSDuplicateException, ETSDataException, ETSBadParameterException
addConceptToConceptList(Concept,String,ConceptList)
.ConceptList
.concept
- Concept to be added.conceptList
- ConceptList to add the Concept.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.void setConceptListDefaultConcept(ConceptList list, Concept concept) throws ETSNotFoundException, ETSBadParameterException, ETSDataException
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
.list
- ConceptList
being altered.concept
- Concept
to become the new default, which must be a
member of the ConceptList
.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.void setConceptDescriptionUsageContext(LocalConceptDescription description, UsageContext usageContext) throws ETSBadParameterException, ETSNotFoundException, ETSDataException
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.description
- LocalConceptDescription
to be altered.usageContext
- UsageContext
to be assigned to the description.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.boolean removeAttributes(AttributableETSComponent component, String name) throws ETSDataException, ETSBadParameterException
AttributableETSComponent
.component
- Component to be altered.name
- Name for which all name/value pairs will be deleted.true
if any attributes matched and were removed.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If invalid arguments are passed.boolean removeAttribute(AttributableETSComponent component, String name, String value) throws ETSDataException, ETSBadParameterException
AttributableETSComponent
.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.true
if any attributes matched and were removed.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If invalid arguments are passed.void makeDefaultVersion(CodingSchemeVersion version) throws ETSBadParameterException, ETSDataException
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.version
- CodingSchemeVersion
to be made default.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.void activate(CodingSchemeVersion version) throws ETSDataException, ETSBadParameterException
CodingSchemeVersion
as active.version
- CodingSchemeVersion
to be made active. The
CodingSchemeVersion
must be quarantined
or retired before this method is called.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If the CodingSchemeVersion
is
already active.void retire(CodingSchemeVersion version, Date retireDate) throws ETSBadParameterException, ETSDataException
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.ETSBadParameterException
- If the component is already retired.ETSDataException
- If a data transport error occurs.void retire(RetirableETSComponent component, Date retireDate) throws ETSDataException, ETSBadParameterException, ETSUnsupportedOperationException
RetirableETSComponent
, optionally specifying the
retirement date.component
- RetirableETSComponent
to be retired. The
CodingSchemeVersion
must be quarantined
or retired before this method is called.retireDate
- Retirement date. This argument is optional.ETSBadParameterException
- If the component is invalid or
retired.ETSDataException
- If a data transport error occurs.ETSUnsupportedOperationException
- If the component is not reassignable.void setLocallyPreferred(LocalConceptDescription localDesc) throws ETSBadParameterException, ETSDataException
Concept
.localDesc
- Local description to be made default.ETSBadParameterException
- If the description is invalid.
localDesc
is retired, the preferred flag cannot be set
and this exception is thrown.ETSDataException
- If a data transport error occurs.StagedService getStagedServiceInstance()
StagedService
, which provides
services for dealing with the ETS terminology staging area.StagedService
object.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
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).
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.ConceptList
.ETSDuplicateException
- ConceptList
already
exists.
ConceptList
being created is a child list and
one of its siblings already has the usageContext
as
a usage context assignment.ETSBadParameterException
- groupName
does not exist and
newGroupFlag
is false
, or if groupName
is null
or an empty String
.
ConceptList
has a parent and its groupname
does not match the groupname of its parent.
restrictedFlag
is true
and
inheritanceDelFlag
is false
, as restricted lists
must inherit deletions to their parent's members.
name
is an empty String
or null
.
description
is an empty String
or null
.
ETSDataException
- If a data transport error occurs.void addConceptToConceptList(Concept concept, String code, ConceptList conceptList, Date activationDate) throws ETSBadParameterException, ETSDuplicateException, ETSDataException, ETSUnsupportedOperationException
ConceptList
that will be activated at a
specified date in the future.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.ETSDuplicateException
- Concept
already
exists and is an active or pending member in ConceptList
.
Concept
.ETSUnsupportedOperationException
- ConceptList
is system-defined.
ConceptList
is restricted, and Concept
does not belong to the parent of the ConceptList
.ETSBadParameterException
- code
is null
or an
empty String
.
activationDate
is null
or is before the current
date.
null
.ETSDataException
- If a data transport error occurs.void addConceptToConceptList(Concept concept, String code, ConceptList conceptList) throws ETSBadParameterException, ETSDuplicateException, ETSDataException, ETSUnsupportedOperationException
ConceptList
that is activated on the
current date.concept
- Concept being added.code
- Concept membership code.conceptList
- ConceptList
that the concept is being
added to.ETSDuplicateException
- Concept
already
exists and is an active or pending member in ConceptList
.
Concept
.ETSBadParameterException
- If code
is null
or an empty String
, or if any other parameter is null
.ETSUnsupportedOperationException
- ConceptList
is system-defined.
ConceptList
is restricted, and Concept
does not belong to the parent of the ConceptList
.ETSDataException
- If a data transport error occurs.void addConceptToConceptList(Concept concept, String code, ConceptList conceptList, ConceptDescription printName, ConceptDescription shortName, ConceptDescription longName) throws ETSBadParameterException, ETSDuplicateException, ETSDataException, ETSUnsupportedOperationException
ConceptList
that is activated on the
current date.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.ETSDuplicateException
- Concept
already
exists and is an active or pending member in ConceptList
.
Concept
.ETSBadParameterException
- code
is null
or an empty String
.
concept
or conceptList
is null
.ETSUnsupportedOperationException
- ConceptList
is system-defined.
ConceptList
is restricted, and Concept
does not belong to the parent of the ConceptList
.ETSDataException
- If a data transport error occurs.void addConceptToConceptList(Concept concept, String code, ConceptList conceptList, Date activationDate, ConceptDescription printName, ConceptDescription shortName, ConceptDescription longName) throws ETSBadParameterException, ETSDuplicateException, ETSDataException, ETSUnsupportedOperationException
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
.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.ETSDuplicateException
- Concept
already
exists and is an active or pending member in ConceptList
.
Concept
.ETSUnsupportedOperationException
- ConceptList
is system-defined.
ConceptList
is restricted, and Concept
does not belong to the parent of the ConceptList
.ETSBadParameterException
- code
is null
or an empty String
.
activationDate
is before the current date or null
.
concept
or conceptList
is null
.
ETSDataException
- If a data transport error occurs.void activateConceptList(ConceptList conceptList) throws ETSBadParameterException, ETSDataException, ETSUnsupportedOperationException
ConceptList
.conceptList
- ConceptList
being activated.ETSBadParameterException
- If ConceptList
is null
.ETSUnsupportedOperationException
- If ConceptList
is system-defined or active.ETSDataException
- If a data transport error occurs.void retireConceptList(ConceptList conceptList) throws ETSBadParameterException, ETSDataException, ETSUnsupportedOperationException
ConceptList
on the current date.
conceptList
- ConceptList
being retired.ETSBadParameterException
- If ConceptList
is null
.ETSUnsupportedOperationException
- If ConceptList
is system-defined or retired.ETSDataException
- If a data transport error occurs.void retireConceptInConceptList(Concept concept, ConceptList conceptList) throws ETSBadParameterException, ETSNotFoundException, ETSDataException, ETSUnsupportedOperationException
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.concept
- Concept being retired.conceptList
- ConceptList
containing the concept.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.void updateMembershipRetirementDate(Concept concept, ConceptList conceptList, Date date) throws ETSBadParameterException, ETSNotFoundException, ETSDataException, ETSUnsupportedOperationException
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.concept
- Concept being retired.conceptList
- ConceptList
containing the concept.date
- Date when the concept is retired .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.void updateMembershipActivationDate(Concept concept, ConceptList conceptList) throws ETSBadParameterException, ETSNotFoundException, ETSDataException, ETSUnsupportedOperationException
concept
- Concept being activated.conceptList
- ConceptList
containing the concept.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.void updateMembershipActivationDate(Concept concept, ConceptList conceptList, Date date) throws ETSBadParameterException, ETSNotFoundException, ETSDataException, ETSUnsupportedOperationException
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.ETSBadParameterException
- Concept
or ConceptList
is null
.
date
is null
or not later than the
current date, or later than the membership retire date of the Concept
.
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.void setConceptListDescription(ConceptList cl, String description) throws ETSDataException, ETSBadParameterException, ETSUnsupportedOperationException
ConceptList
.
The maximum length of this attribute is 240.cl
- ConceptList
object.description
- description of the ConceptList
.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.void setConceptListAdditionInheritance(ConceptList cl, boolean flag) throws ETSDataException, ETSUnsupportedOperationException, ETSBadParameterException
ConceptList
to either inherit additions of concept members
from its parent ConceptList
or not.cl
- ConceptList
object.flag
- If true
, the ConceptList
inherits
additions from its parent.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
.void setConceptListDeletionInheritance(ConceptList cl, boolean flag) throws ETSDataException, ETSUnsupportedOperationException, ETSBadParameterException
ConceptList
to either inherit deletions of concept members
from its parent ConceptList
or not.cl
- ConceptList
object.flag
- If true
, the ConceptList
inherits
deletions from its parent.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.void setCoreMember(ConceptList cl, Concept concept, boolean flag) throws ETSBadParameterException, ETSDataException, ETSNotFoundException
ConceptList
. Concept must be an active or pending member
of the ConceptList
to belong to the core set.cl
- ConceptList
object.concept
- Concept whose flag is being set.flag
- If true
, this method sets concept to be a member of
core set.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
.void setConceptListUsageContext(ConceptList cl, UsageContext usageContext) throws ETSBadParameterException, ETSDataException
ConceptList
. If another
sibling ConceptList
has this usage context, the sibling
list is set to have no usage context.cl
- ConceptList
to be altered.usageContext
- Usage context to be assigned to the description.ETSBadParameterException
- If invalid arguments are passed.ETSDataException
- If a data transport error occurs.void associateUsageContextWithExternalOwner(UsageContext usageContext, String ownerType, String ownerID) throws ETSDataException, ETSBadParameterException
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.ETSBadParameterException
- If the ownerType
or ownerID
parameters are null
, or if they are zero-length strings.ETSDataException
- If a data transport error occurs.void setConceptListMemberDescription(int memberDescriptionType, ConceptListMember member, ConceptDescription desc) throws ETSBadParameterException, ETSDataException, ETSUnsupportedOperationException
ConceptListMember
to an
already existing local or terminology-defined description.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.ETSBadParameterException
- desc
is not a local
description or terminology-defined description tied to the
associated concept of member
.
member
is null
.
memberDescriptionType
.
ETSUnsupportedOperationException
- If member
is not
active in its associated ConceptList
.ETSDataException
- If a data transport error occurs.void deleteMapSet(MapSet mapSet) throws ETSBadParameterException, ETSDataException
MapSet
and all of it associative contents.mapSet
- The MapSet
that has to be deleted.ETSBadParameterException
- If the MapSet
is null
.ETSDataException
- If a data transport error occurs.Classification createClassification(CandidateClassification candidateClassification) throws ETSDuplicateException, ETSDataException, ETSBadParameterException, ETSValidationException
CandidateClassification
object.candidateClassification
- CandidateClassification
object.Classification
object.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.void addClassificationDescription(CandidateConceptDescription description, Classification classification) throws ETSBadParameterException, ETSDataException, ETSValidationException
description
- CandidateConceptDescription
object.classification
- Classification
object.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.void addClassificationDescriptions(CandidateConceptDescription[] description, Classification classification) throws ETSBadParameterException, ETSDataException, ETSValidationException
description
- Array of CandidateConceptDescription
objects.classification
- Classification
object.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.void activateClassification(Classification classification) throws ETSBadParameterException, ETSDataException, ETSUnsupportedOperationException
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:
classification
is
in the Active
state.
classification
is
already in the Pending
state.
classification
from the
Retired
to the Pending
state,
in order for the ETS classification builder to process it.
ETSUnsupportedOperationException
.
A classification cannot be activated if it is in the Dirty
state.
The ETS builder should rebuild the classification.
classification
- Classification
object.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.retireClassification(Classification)
void addChildClassification(Classification parent, Classification child, int inclusionOption) throws ETSBadParameterException, ETSDataException
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.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- parent
is null
.
child
is null
.
child
is an ancestor of parent
.
child
is an immediate descendant of parent
.
child
is the same as the parent
.
inclusionOption
is not one of the specified constants.
child
causes a circular reference with the existing
classification declarations.
void removeChildClassification(Classification parent, Classification child) throws ETSBadParameterException, ETSDataException
parent
- Parent classification.child
- Child classification.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- parent
is null
.
child
is null
.
parent
code is the same as the child
code.
void retireClassification(Classification classification) throws ETSBadParameterException, ETSDataException
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
.
classification
- Classification
object.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If classification
is null
.void addDeclarationToClassification(Concept concept, Classification classification, int inclusionOption) throws ETSDuplicateException, ETSDataException, ETSBadParameterException
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:
concept
itself will be added to classification
.
concept
within its native terminology
will be added to classification
,
excluding the concept
itself.
concept
within its native terminology will be added to
classification
, but not the concept
itself.
concept
and only its direct children within its native terminology will be added to
the classification
.
concept
and all its descendants within its native terminology will be added to the
classification
.
ETSDuplicateException
- If concept
exists in the
classification declaration.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- inclusionOption
value is other than the specified constants.
concept
is null
.
classification
is null
.
inclusionOption
is not one of the constants defined in
ClassificationDeclaration
interface.
void addDeclarationsToClassification(Concept[] concepts, Classification classification, int[] inclusionOption) throws ETSDuplicateException, ETSDataException, ETSBadParameterException
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.ETSDuplicateException
- If Concept
objects already exists
in a declaration of the classification
.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- inclusionOption
is other than the
specified constants.
inclusionOption
is different from the
length of Concept
objects.
Concept
objects contains null
elements.
Concept
objects is null.
classification
is null.
inclusionOption
is null.
void removeDeclarationsFromClassification(ClassificationDeclaration[] declaration, Classification classification) throws ETSDataException, ETSBadParameterException
declaration
- Array of ClassificationDeclaration
objects.classification
- Classification
object.ETSBadParameterException
- classification
or declaration
is null
.
declaration
contains null
elements.
classification
does not contain this declaration
.
ETSDataException
- If a data transport error occurs.void removeDeclarationFromClassification(ClassificationDeclaration declaration, Classification classification) throws ETSDataException, ETSBadParameterException
declaration
- Array of ClassificationDeclaration
objects.classification
- Classification
object.ETSBadParameterException
- classification
or declaration
is null
.
classification
does not contain this declaration
.
ETSDataException
- If a data transport error occurs.CandidateLocaleMap newCandidateLocaleMap()
CandidateLocaleMap
object.CandidateLocaleMap newCandidateLocaleMap(LocaleMap localeMap) throws ETSDataException
CandidateLocaleMap
object
- uses the values in the LocaleMap
to create a
CandidateLocalMap
. No reference to the
LocaleMap
object is kept.localeMap
- LocaleMap
object whose values are used to
create a CandidateLocaleMap
object.ETSDataException
- If a data transport error occurs.void setLocaleMaps(CandidateLocaleMap[] candidateLocaleMaps) throws ETSDataException, ETSBadParameterException, ETSDuplicateException
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.candidateLocaleMaps
- an array of CandidateLocaleMap
objects
to be created or updated.ETSDataException
- If a data transport error has occurred.ETSBadParameterException
- null
.CandidateLocaleMap
members contain a
null
CodingSchemeVersion
,
source Locale
or target Locale
object.Locale
has not been installed.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
.void invalidateETSCache() throws oracle.hsgbu.ets.exceptions.common.ETSDAOException
oracle.hsgbu.ets.exceptions.common.ETSDAOException
HDR Glossary HDR Concept Lists HDR Exceptions HDR Programmer's Guide HDR Implementation Guide HDR Profile Options
Copyright © 2016, 2018, Oracle. All rights reserved