org.lexevs.cts2.author
Interface ValueSetAuthoringOperation

All Known Implementing Classes:
ValueSetAuthoringOperationImpl

public interface ValueSetAuthoringOperation

LexEVS CTS 2 Value Set Authoring Operation.

Author:
Sridhar Dwarkanath

Method Summary
 boolean addDefinitionEntry(java.net.URI valueSetURI, DefinitionEntry newDefinitionEntry, RevisionInfo revision)
          Add new definition entry (rule set) to a value set definition.
 boolean addValueSetProperty(java.net.URI valueSetURI, Property newProperty, RevisionInfo revision)
          Add new Property to existing value set definition.
 java.net.URI createValueSet(java.net.URI valueSetURI, java.lang.String valueSetName, java.lang.String defaultCodeSystem, java.lang.String conceptDomainId, java.util.List<Source> sourceList, java.util.List<java.lang.String> usageContextList, Properties properties, java.util.List<DefinitionEntry> ruleSetList, Versionable versionable, RevisionInfo revision)
          Creates a new value set definition and loads into repository.
 java.net.URI createValueSet(ValueSetDefinition valueSetDefininition, RevisionInfo revision)
          Creates new value set definition and loads into repository.
 boolean removeDefinitionEntry(java.net.URI valueSetURI, java.lang.Long ruleOrder, RevisionInfo revision)
          Removes definition entry (rule set) of a value set definition.
 boolean removeValueSet(java.net.URI valueSetURI, RevisionInfo revision)
          Removes value set definition from the system.
 boolean removeValueSetProperty(java.net.URI valueSetURI, java.lang.String propertyId, RevisionInfo revision)
          Removes property of a value set definition.
 boolean updateDefinitionEntry(java.net.URI valueSetURI, DefinitionEntry changedDefinitionEntry, RevisionInfo revision)
          Update existing definition entry (rule set) of a value set definition.
 boolean updateValueSetMetaData(java.net.URI valueSetURI, java.lang.String valueSetName, java.lang.String defaultCodeSystem, java.lang.String conceptDomainId, java.util.List<Source> sourceList, java.util.List<java.lang.String> usageContext, RevisionInfo revision)
          Updates value set definition meta data.
 boolean updateValueSetProperty(java.net.URI valueSetURI, Property changedProperty, RevisionInfo revision)
          Updates existing property of a value set definition.
 boolean updateValueSetStatus(java.net.URI valueSetURI, java.lang.String status, RevisionInfo revision)
          Updates value set definition status.
 boolean updateValueSetVersionable(java.net.URI valueSetURI, Versionable changedVersionable, RevisionInfo revision)
          Updates versionable attributes of value set definition.
 

Method Detail

createValueSet

java.net.URI createValueSet(java.net.URI valueSetURI,
                            java.lang.String valueSetName,
                            java.lang.String defaultCodeSystem,
                            java.lang.String conceptDomainId,
                            java.util.List<Source> sourceList,
                            java.util.List<java.lang.String> usageContextList,
                            Properties properties,
                            java.util.List<DefinitionEntry> ruleSetList,
                            Versionable versionable,
                            RevisionInfo revision)
                            throws LBException
Creates a new value set definition and loads into repository.

Parameters:
valueSetURI - URI of value set definition
valueSetName - Name of value set definition
defaultCodeSystem - local name of default code system
conceptDomainId - (Optional)local name of concept domain
sourceList - (Optional)list of source
usageContextList - (Optional)list of usage context
properties - (Optional)collection of properties
ruleSetList - list of definition entries (rule sets)
versionable - versionable entries (status, isActive, effective date etc)
revision - revision information
Returns:
value set definition URI
Throws:
LBException

createValueSet

java.net.URI createValueSet(ValueSetDefinition valueSetDefininition,
                            RevisionInfo revision)
                            throws LBException
Creates new value set definition and loads into repository.

Parameters:
valueSetDefininition - Value Set Definition object to be loaded into repository
revision - revision information
Returns:
value set definition URI
Throws:
LBException

updateValueSetMetaData

boolean updateValueSetMetaData(java.net.URI valueSetURI,
                               java.lang.String valueSetName,
                               java.lang.String defaultCodeSystem,
                               java.lang.String conceptDomainId,
                               java.util.List<Source> sourceList,
                               java.util.List<java.lang.String> usageContext,
                               RevisionInfo revision)
                               throws LBException
Updates value set definition meta data.

Parameters:
valueSetURI - URI of value set definition that will be modified
valueSetName - modified value set definition name
defaultCodeSystem - modified default code system name
conceptDomainId - modified concept domain id
sourceList - modified complete list of source
usageContext - modified complete list of context
revision - revision information
Returns:
True if update was successful
Throws:
LBException

updateValueSetVersionable

boolean updateValueSetVersionable(java.net.URI valueSetURI,
                                  Versionable changedVersionable,
                                  RevisionInfo revision)
                                  throws LBException
Updates versionable attributes of value set definition. Versionable attributes are : Status, isActive, Effective Date, Expiration Date, and owner.

Parameters:
valueSetURI - URI of value set definition that will be modified
changedVersionable - modified versionable object
revision - revision information
Returns:
True if update was successful
Throws:
LBException

addValueSetProperty

boolean addValueSetProperty(java.net.URI valueSetURI,
                            Property newProperty,
                            RevisionInfo revision)
                            throws LBException
Add new Property to existing value set definition.

Parameters:
valueSetURI - URI of value set definition this new property will be added
newProperty - new Property object
revision - revision information
Returns:
True if update was successful
Throws:
LBException

updateValueSetProperty

boolean updateValueSetProperty(java.net.URI valueSetURI,
                               Property changedProperty,
                               RevisionInfo revision)
                               throws LBException
Updates existing property of a value set definition.

Parameters:
valueSetURI - URI of value set definition
changedProperty - modified property object
revision - revision information
Returns:
True if update was successful
Throws:
LBException

addDefinitionEntry

boolean addDefinitionEntry(java.net.URI valueSetURI,
                           DefinitionEntry newDefinitionEntry,
                           RevisionInfo revision)
                           throws LBException
Add new definition entry (rule set) to a value set definition.

Parameters:
valueSetURI - URI of value set definition
newDefinitionEntry - Definition Entry object to be added
revision - revision information
Returns:
True if update was successful
Throws:
LBException

updateDefinitionEntry

boolean updateDefinitionEntry(java.net.URI valueSetURI,
                              DefinitionEntry changedDefinitionEntry,
                              RevisionInfo revision)
                              throws LBException
Update existing definition entry (rule set) of a value set definition.

Parameters:
valueSetURI - URI of value set definition
changedDefinitionEntry - modified definition entry object
revision - revision information
Returns:
True if update was successful
Throws:
LBException

updateValueSetStatus

boolean updateValueSetStatus(java.net.URI valueSetURI,
                             java.lang.String status,
                             RevisionInfo revision)
                             throws LBException
Updates value set definition status.

Parameters:
valueSetURI - URI of value set definition
status - modified status
revision - revision information
Returns:
True if update was successful
Throws:
LBException

removeValueSet

boolean removeValueSet(java.net.URI valueSetURI,
                       RevisionInfo revision)
                       throws LBException
Removes value set definition from the system. This operation is permanent removal of value set definition.

Parameters:
valueSetURI - URI of value set definition to be removed
revision - revision information
Returns:
True if removal was successful
Throws:
LBException

removeDefinitionEntry

boolean removeDefinitionEntry(java.net.URI valueSetURI,
                              java.lang.Long ruleOrder,
                              RevisionInfo revision)
                              throws LBException
Removes definition entry (rule set) of a value set definition.

Parameters:
valueSetURI - URI of a value set definition
ruleOrder - rule set order id to be removed
revision - revision information
Returns:
True if removal was successful
Throws:
LBException

removeValueSetProperty

boolean removeValueSetProperty(java.net.URI valueSetURI,
                               java.lang.String propertyId,
                               RevisionInfo revision)
                               throws LBException
Removes property of a value set definition.

Parameters:
valueSetURI - URI of a value set definition
propertyId - id of a property that needs to be removed
revision - revision information
Returns:
True if removal was successful
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.