org.lexevs.cts2.author
Interface UsageContextAuthoringOperation

All Known Implementing Classes:
UsageContextAuthoringOperationImpl

public interface UsageContextAuthoringOperation

LexEVS CTS 2 Usage Context Authoring Operations.

Author:
Sridhar Dwarkanath

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.
 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.
 

Method Detail

createUsageContextCodeSystem

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
Create a code system to hold usage context entities.

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

createUsageContext

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
Create new usage context.

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

updateUsageContextStatus

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
Update usage context status.

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

activateUsageContext

boolean activateUsageContext(java.lang.String usageContextId,
                             java.lang.String namespace,
                             java.lang.String codeSystemNameOrURI,
                             java.lang.String codeSystemVersion,
                             RevisionInfo revisionInfo)
                             throws LBException
Activate usage context.

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

deactivateUsageContext

boolean deactivateUsageContext(java.lang.String usageContextId,
                               java.lang.String namespace,
                               java.lang.String codeSystemNameOrURI,
                               java.lang.String codeSystemVersion,
                               RevisionInfo revisionInfo)
                               throws LBException
DeActivate usage context.

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

updateUsageContextVersionable

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

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
revisionInfo - - revision information
Returns:
true, if update was success
Throws:
LBException

addUsageContextProperty

boolean addUsageContextProperty(java.lang.String usageContextId,
                                java.lang.String namespace,
                                Property newProperty,
                                java.lang.String codeSystemNameOrURI,
                                java.lang.String codeSystemVersion,
                                RevisionInfo revision)
                                throws LBException
Add new property for a usage context.

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
revisionInfo - - revision information
Returns:
true, if update was success
Throws:
LBException

updateUsageContextProperty

boolean updateUsageContextProperty(java.lang.String usageContextId,
                                   java.lang.String namespace,
                                   Property changedProperty,
                                   java.lang.String codeSystemNameOrURI,
                                   java.lang.String codeSystemVersion,
                                   RevisionInfo revision)
                                   throws LBException
Update existing property of a usage context.

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
revisionInfo - - revision information
Returns:
true, if update was success
Throws:
LBException

removeUsageContextProperty

boolean removeUsageContextProperty(java.lang.String usageContextId,
                                   java.lang.String namespace,
                                   Property property,
                                   java.lang.String codeSystemNameOrURI,
                                   java.lang.String codeSystemVersion,
                                   RevisionInfo revision)
                                   throws LBException
Remove existing property of a usage context.

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
revisionInfo - - revision information
Returns:
true, if update was success
Throws:
LBException

removeUsageContext

boolean removeUsageContext(java.lang.String usageContextId,
                           java.lang.String namespace,
                           java.lang.String codeSystemNameOrURI,
                           java.lang.String codeSystemVersion,
                           RevisionInfo revision)
                           throws LBException
Remove existing usage context.

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

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.