org.lexevs.cts2.author
Interface ConceptDomainAuthoringOperation

All Known Implementing Classes:
ConceptDomainAuthoringOperationImpl

public interface ConceptDomainAuthoringOperation

LexEVS CTS 2 Concept Domain Authoring Operations.

Author:
Sridhar Dwarkanath

Method Summary
 boolean activateConceptDomain(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          Activate concept domain.
 boolean addConceptDomainProperty(java.lang.String conceptDomainId, java.lang.String namespace, Property newProperty, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          Add new property for a concept domain.
 boolean addConceptDomainToValueSetBinding(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, java.net.URI valueSetURI, RevisionInfo revisionInfo)
          Add concept domain to value set binding.
 java.lang.String createConceptDomain(java.lang.String conceptDomainId, java.lang.String conceptDomainName, java.lang.String namespace, RevisionInfo revisionInfo, java.lang.String description, java.lang.String status, boolean isActive, Properties properties, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Create new concept domain.
 CodingScheme createConceptDomainCodeSystem(RevisionInfo revision, java.lang.String codeSystemName, java.lang.String codeSystemURI, java.lang.String formalName, java.lang.String defaultLanguage, long approxNumConcepts, java.lang.String representsVersion, java.util.List<java.lang.String> localNameList, java.util.List<Source> sourceList, Text copyright, Mappings mappings)
          Create a code system to hold concept domain entities.
 boolean deactivateConceptDomain(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          DeActivate concept domain.
 boolean removeConceptDomain(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          Remove concept domain.
 boolean removeConceptDomainProperty(java.lang.String conceptDomainId, java.lang.String namespace, Property property, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          Remove existing property of a concept domain.
 boolean removeConceptDomainToValueSetBinding(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, java.net.URI valueSetURI, RevisionInfo revisionInfo)
          Remove concept domain to value set binding.
 boolean updateConceptDomainProperty(java.lang.String conceptDomainId, java.lang.String namespace, Property changedProperty, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          Update existing property of a concept domain.
 boolean updateConceptDomainStatus(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String newStatus, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          Update concept domain status.
 boolean updateConceptDomainVersionable(java.lang.String conceptDomainId, java.lang.String namespace, Versionable changedVersionable, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          Update concept domain versionable attributes like effective date, expiration date, owner, status etc.
 

Method Detail

createConceptDomainCodeSystem

CodingScheme createConceptDomainCodeSystem(RevisionInfo revision,
                                           java.lang.String codeSystemName,
                                           java.lang.String codeSystemURI,
                                           java.lang.String formalName,
                                           java.lang.String defaultLanguage,
                                           long approxNumConcepts,
                                           java.lang.String representsVersion,
                                           java.util.List<java.lang.String> localNameList,
                                           java.util.List<Source> sourceList,
                                           Text copyright,
                                           Mappings mappings)
                                           throws LBException
Create a code system to hold concept domain entities.

Parameters:
revision - - revision information
codeSystemName - - concept domain code system name
codeSystemURI - - concept domain code system URI
formalName - - concept domain code system formal name
defaultLanguage - - default language
representsVersion - - concept domain code system version
localNameList - - (Optional) list of alternate names used for this code system
sourceList - - source list
copyright - - copy right information
mappings - - list of attributes supported by this code system
Returns:
concept domain code system
Throws:
LBException

createConceptDomain

java.lang.String createConceptDomain(java.lang.String conceptDomainId,
                                     java.lang.String conceptDomainName,
                                     java.lang.String namespace,
                                     RevisionInfo revisionInfo,
                                     java.lang.String description,
                                     java.lang.String status,
                                     boolean isActive,
                                     Properties properties,
                                     java.lang.String codeSystemNameOrURI,
                                     java.lang.String codeSystemVersion)
                                     throws LBException
Create new concept domain.

Parameters:
conceptDomainId - - concept domain id
conceptDomainName - - concept domain name
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
revisionInfo - - revision information
description - - description of concept domain
status - - status of concept domain
isActive - - is concept domain active
properties - - concept domain properties
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
Returns:
concept domain id if created successfully
Throws:
LBException

updateConceptDomainStatus

boolean updateConceptDomainStatus(java.lang.String conceptDomainId,
                                  java.lang.String namespace,
                                  java.lang.String newStatus,
                                  java.lang.String codeSystemNameOrURI,
                                  java.lang.String codeSystemVersion,
                                  RevisionInfo revisionInfo)
                                  throws LBException
Update concept domain status.

Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
newStatus - - new status for concept domain
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revisionInfo - - concept domain code system version
Returns:
true; if update was success
Throws:
LBException

activateConceptDomain

boolean activateConceptDomain(java.lang.String conceptDomainId,
                              java.lang.String namespace,
                              java.lang.String codeSystemNameOrURI,
                              java.lang.String codeSystemVersion,
                              RevisionInfo revisionInfo)
                              throws LBException
Activate concept domain.

Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revisionInfo - - revision information
Returns:
true; if activation was success
Throws:
LBException

deactivateConceptDomain

boolean deactivateConceptDomain(java.lang.String conceptDomainId,
                                java.lang.String namespace,
                                java.lang.String codeSystemNameOrURI,
                                java.lang.String codeSystemVersion,
                                RevisionInfo revisionInfo)
                                throws LBException
DeActivate concept domain.

Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revisionInfo - - revision information
Returns:
true; if deactivation was success
Throws:
LBException

updateConceptDomainVersionable

boolean updateConceptDomainVersionable(java.lang.String conceptDomainId,
                                       java.lang.String namespace,
                                       Versionable changedVersionable,
                                       java.lang.String codeSystemNameOrURI,
                                       java.lang.String codeSystemVersion,
                                       RevisionInfo revisionInfo)
                                       throws LBException
Update concept domain versionable attributes like effective date, expiration date, owner, status etc.

Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
changedVersionable - - versionable (like:owner, effectiveDate, expirationDate, status etc) changes
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revisionInfo - - revision information
Returns:
true; if update was success
Throws:
LBException

addConceptDomainProperty

boolean addConceptDomainProperty(java.lang.String conceptDomainId,
                                 java.lang.String namespace,
                                 Property newProperty,
                                 java.lang.String codeSystemNameOrURI,
                                 java.lang.String codeSystemVersion,
                                 RevisionInfo revisionInfo)
                                 throws LBException
Add new property for a concept domain.

Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
newProperty - - new concept domain property
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revisionInfo - - revision information
Returns:
true; if addition of new property was success
Throws:
LBException

updateConceptDomainProperty

boolean updateConceptDomainProperty(java.lang.String conceptDomainId,
                                    java.lang.String namespace,
                                    Property changedProperty,
                                    java.lang.String codeSystemNameOrURI,
                                    java.lang.String codeSystemVersion,
                                    RevisionInfo revisionInfo)
                                    throws LBException
Update existing property of a concept domain.

Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
changedProperty - - modified concept domain property
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revisionInfo - - revision information
Returns:
true; if update was success
Throws:
LBException

removeConceptDomainProperty

boolean removeConceptDomainProperty(java.lang.String conceptDomainId,
                                    java.lang.String namespace,
                                    Property property,
                                    java.lang.String codeSystemNameOrURI,
                                    java.lang.String codeSystemVersion,
                                    RevisionInfo revisionInfo)
                                    throws LBException
Remove existing property of a concept domain.

Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
property - - property to be removed
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revisionInfo - - revision information
Returns:
true; if remove was success
Throws:
LBException

addConceptDomainToValueSetBinding

boolean addConceptDomainToValueSetBinding(java.lang.String conceptDomainId,
                                          java.lang.String namespace,
                                          java.lang.String codeSystemNameOrURI,
                                          java.lang.String codeSystemVersion,
                                          java.net.URI valueSetURI,
                                          RevisionInfo revisionInfo)
                                          throws LBException
Add concept domain to value set binding.

Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
valueSetURI - - value set definition uri
revisionInfo - - revision information
Returns:
true; if binding update was success
Throws:
LBException

removeConceptDomainToValueSetBinding

boolean removeConceptDomainToValueSetBinding(java.lang.String conceptDomainId,
                                             java.lang.String namespace,
                                             java.lang.String codeSystemNameOrURI,
                                             java.lang.String codeSystemVersion,
                                             java.net.URI valueSetURI,
                                             RevisionInfo revisionInfo)
                                             throws LBException
Remove concept domain to value set binding.

Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
valueSetURI - - value set definition uri
revisionInfo - - revision information
Returns:
true; if binding update was success
Throws:
LBException

removeConceptDomain

boolean removeConceptDomain(java.lang.String conceptDomainId,
                            java.lang.String namespace,
                            java.lang.String codeSystemNameOrURI,
                            java.lang.String codeSystemVersion,
                            RevisionInfo revisionInfo)
                            throws LBException
Remove concept domain.

Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
@param - codeSystemNameOrURI - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revisionInfo - - revision information
Returns:
true; if remove was success
Throws:
LBException

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.