org.lexevs.cts2.author
Class UsageContextAuthoringOperationImpl

java.lang.Object
  extended by org.lexevs.cts2.LexEvsBasedService
      extended by org.lexevs.cts2.BaseService
          extended by org.lexevs.cts2.author.AuthoringCore
              extended by org.lexevs.cts2.author.UsageContextAuthoringOperationImpl
All Implemented Interfaces:
UsageContextAuthoringOperation

public class UsageContextAuthoringOperationImpl
extends AuthoringCore
implements UsageContextAuthoringOperation

Implementation of LexEVS CTS2 Usage Context Authoring Operation.

Author:
Sridhar Dwarkanath

Nested Class Summary
 
Nested classes/interfaces inherited from class org.lexevs.cts2.BaseService
BaseService.KnownTags, BaseService.SortableProperties
 
Constructor Summary
UsageContextAuthoringOperationImpl()
           
 
Method Summary
 boolean activateUsageContext(java.lang.String usageContextId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          Activate usage context.
 boolean addUsageContextProperty(java.lang.String usageContextId, java.lang.String namespace, Property newProperty, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revision)
          Add new property for a usage context.
 java.lang.String createUsageContext(java.lang.String usageContextId, java.lang.String usageContextName, 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 usage context.
 CodingScheme createUsageContextCodeSystem(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 usage context entities.
 boolean deactivateUsageContext(java.lang.String usageContextId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          DeActivate usage context.
protected  void doReviseEntity(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, Entity entity, ChangeType changeType, java.lang.String prevRevisionId, java.lang.Long relativeOrder, RevisionInfo revisionInfo)
           
protected  void doReviseEntityProperty(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, java.lang.String entityCode, java.lang.String entityCodeNamespace, Property property, ChangeType changeType, java.lang.String prevRevisionId, java.lang.Long relativeOrder, RevisionInfo revisionInfo)
           
 boolean removeUsageContext(java.lang.String usageContextId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revision)
          Remove existing usage context.
 boolean removeUsageContextProperty(java.lang.String usageContextId, java.lang.String namespace, Property property, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revision)
          Remove existing property of a usage context.
 boolean updateUsageContextProperty(java.lang.String usageContextId, java.lang.String namespace, Property changedProperty, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revision)
          Update existing property of a usage context.
 boolean updateUsageContextStatus(java.lang.String usageContextId, java.lang.String namespace, java.lang.String newStatus, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          Update usage context status.
 boolean updateUsageContextVersionable(java.lang.String usageContextId, java.lang.String namespace, Versionable changedVersionable, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revision)
          Update usage context versionable attributes like effective date, expiration date, owner, status etc.
 
Methods inherited from class org.lexevs.cts2.author.AuthoringCore
addEntryState, createSystemRelease, getCodeSystemShell, getCodeSystemURI, getEntityShell, getLexGridRevisionObject, getSystemReleaseInfoByReleaseId, getSystemReleaseInfoByReleaseURI, populateEntryState, populateRevisionShell, populateRevisionShell, populateRevisionShell, validatedCodingScheme, validateRevisionInfo
 
Methods inherited from class org.lexevs.cts2.BaseService
createUniqueId, getLexEvsCTS2, getServiceInfo
 
Methods inherited from class org.lexevs.cts2.LexEvsBasedService
getDatabaseServiceManager, getIndexServiceManager, getLexBIGService, getLexBIGServiceManager, getLexBIGServiceManagerCredentials, getSystemResourceService
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UsageContextAuthoringOperationImpl

public UsageContextAuthoringOperationImpl()
Method Detail

activateUsageContext

public boolean activateUsageContext(java.lang.String usageContextId,
                                    java.lang.String namespace,
                                    java.lang.String codeSystemNameOrURI,
                                    java.lang.String codeSystemVersion,
                                    RevisionInfo revisionInfo)
                             throws LBException
Description copied from interface: UsageContextAuthoringOperation
Activate usage context.

Specified by:
activateUsageContext in interface UsageContextAuthoringOperation
Parameters:
usageContextId - - usage context id
namespace - - usage context name space
codeSystemNameOrURI - - usage context code system name or URI
codeSystemVersion - - usage context code system version
revisionInfo - - revision information
Returns:
true, if update was success
Throws:
LBException

addUsageContextProperty

public boolean addUsageContextProperty(java.lang.String usageContextId,
                                       java.lang.String namespace,
                                       Property newProperty,
                                       java.lang.String codeSystemNameOrURI,
                                       java.lang.String codeSystemVersion,
                                       RevisionInfo revision)
                                throws LBException
Description copied from interface: UsageContextAuthoringOperation
Add new property for a usage context.

Specified by:
addUsageContextProperty in interface UsageContextAuthoringOperation
Parameters:
usageContextId - - usage context id
namespace - - usage context name space
newProperty - - new usage context property
codeSystemNameOrURI - - usage context code system name or URI
codeSystemVersion - - usage context code system version
Returns:
true, if update was success
Throws:
LBException

createUsageContext

public java.lang.String createUsageContext(java.lang.String usageContextId,
                                           java.lang.String usageContextName,
                                           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
Description copied from interface: UsageContextAuthoringOperation
Create new usage context.

Specified by:
createUsageContext in interface UsageContextAuthoringOperation
Parameters:
usageContextId - - usage context id
usageContextName - - usage context name
namespace - - usage context name space (If not provided, formal name of the code system will be used)
revisionInfo - - revision information
description - - description of usage context
status - - status of usage context
isActive - - is usage context active
properties - - usage context properties
codeSystemNameOrURI - - usage context code system name or uri
codeSystemVersion - - usage context code system version
Returns:
usage context id if created successfully
Throws:
LBException

createUsageContextCodeSystem

public CodingScheme createUsageContextCodeSystem(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
Description copied from interface: UsageContextAuthoringOperation
Create a code system to hold usage context entities.

Specified by:
createUsageContextCodeSystem in interface UsageContextAuthoringOperation
Parameters:
revision - - revision information
codeSystemName - - usage context code system name
codeSystemURI - - usage context code system URI
formalName - - usage context code system formal name
defaultLanguage - - default language
representsVersion - - usage context 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:
usage context code system
Throws:
LBException

deactivateUsageContext

public boolean deactivateUsageContext(java.lang.String usageContextId,
                                      java.lang.String namespace,
                                      java.lang.String codeSystemNameOrURI,
                                      java.lang.String codeSystemVersion,
                                      RevisionInfo revisionInfo)
                               throws LBException
Description copied from interface: UsageContextAuthoringOperation
DeActivate usage context.

Specified by:
deactivateUsageContext in interface UsageContextAuthoringOperation
Parameters:
usageContextId - - usage context id
namespace - - usage context name space
codeSystemNameOrURI - - usage context code system name or URI
codeSystemVersion - - usage context code system version
revisionInfo - - revision information
Returns:
true, if update was success
Throws:
LBException

removeUsageContext

public boolean removeUsageContext(java.lang.String usageContextId,
                                  java.lang.String namespace,
                                  java.lang.String codeSystemNameOrURI,
                                  java.lang.String codeSystemVersion,
                                  RevisionInfo revision)
                           throws LBException
Description copied from interface: UsageContextAuthoringOperation
Remove existing usage context.

Specified by:
removeUsageContext in interface UsageContextAuthoringOperation
Parameters:
usageContextId - - usage context id
namespace - - usage context name space
codeSystemNameOrURI - - usage context code system name or URI
codeSystemVersion - - usage context code system version
Returns:
true, if update was success
Throws:
LBException

removeUsageContextProperty

public boolean removeUsageContextProperty(java.lang.String usageContextId,
                                          java.lang.String namespace,
                                          Property property,
                                          java.lang.String codeSystemNameOrURI,
                                          java.lang.String codeSystemVersion,
                                          RevisionInfo revision)
                                   throws LBException
Description copied from interface: UsageContextAuthoringOperation
Remove existing property of a usage context.

Specified by:
removeUsageContextProperty in interface UsageContextAuthoringOperation
Parameters:
usageContextId - - usage context id
namespace - - usage context name space
property - - usage context property to be removed
codeSystemNameOrURI - - usage context code system name or URI
codeSystemVersion - - usage context code system version
Returns:
true, if update was success
Throws:
LBException

updateUsageContextProperty

public boolean updateUsageContextProperty(java.lang.String usageContextId,
                                          java.lang.String namespace,
                                          Property changedProperty,
                                          java.lang.String codeSystemNameOrURI,
                                          java.lang.String codeSystemVersion,
                                          RevisionInfo revision)
                                   throws LBException
Description copied from interface: UsageContextAuthoringOperation
Update existing property of a usage context.

Specified by:
updateUsageContextProperty in interface UsageContextAuthoringOperation
Parameters:
usageContextId - - usage context id
namespace - - usage context name space
changedProperty - - modified usage context property
codeSystemNameOrURI - - usage context code system name or URI
codeSystemVersion - - usage context code system version
Returns:
true, if update was success
Throws:
LBException

updateUsageContextStatus

public boolean updateUsageContextStatus(java.lang.String usageContextId,
                                        java.lang.String namespace,
                                        java.lang.String newStatus,
                                        java.lang.String codeSystemNameOrURI,
                                        java.lang.String codeSystemVersion,
                                        RevisionInfo revisionInfo)
                                 throws LBException
Description copied from interface: UsageContextAuthoringOperation
Update usage context status.

Specified by:
updateUsageContextStatus in interface UsageContextAuthoringOperation
Parameters:
usageContextId - - usage context id
namespace - - usage context name space
newStatus - - new status for concept domain
codeSystemNameOrURI - - usage context code system name or URI
codeSystemVersion - - usage context code system version
revisionInfo - - revision information
Returns:
true, if update was success
Throws:
LBException

updateUsageContextVersionable

public boolean updateUsageContextVersionable(java.lang.String usageContextId,
                                             java.lang.String namespace,
                                             Versionable changedVersionable,
                                             java.lang.String codeSystemNameOrURI,
                                             java.lang.String codeSystemVersion,
                                             RevisionInfo revision)
                                      throws LBException
Description copied from interface: UsageContextAuthoringOperation
Update usage context versionable attributes like effective date, expiration date, owner, status etc.

Specified by:
updateUsageContextVersionable in interface UsageContextAuthoringOperation
Parameters:
usageContextId - - usage context id
namespace - - usage context name space
changedVersionable - - modified usage context versionable attributes
codeSystemNameOrURI - - usage context code system name or URI
codeSystemVersion - - usage context code system version
Returns:
true, if update was success
Throws:
LBException

doReviseEntity

protected void doReviseEntity(java.lang.String codingSchemeUri,
                              java.lang.String codingSchemeVersion,
                              Entity entity,
                              ChangeType changeType,
                              java.lang.String prevRevisionId,
                              java.lang.Long relativeOrder,
                              RevisionInfo revisionInfo)
                       throws LBException
Throws:
LBException

doReviseEntityProperty

protected void doReviseEntityProperty(java.lang.String codingSchemeUri,
                                      java.lang.String codingSchemeVersion,
                                      java.lang.String entityCode,
                                      java.lang.String entityCodeNamespace,
                                      Property property,
                                      ChangeType changeType,
                                      java.lang.String prevRevisionId,
                                      java.lang.Long relativeOrder,
                                      RevisionInfo revisionInfo)
                               throws LBException
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.