org.LexGrid.LexBIG.History
Interface HistoryService

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
HistoryServiceAdapter, NCIThesaurusHistoryServiceImpl, UMLSHistoryServiceImpl, UriBasedHistoryServiceImpl

public interface HistoryService
extends java.io.Serializable

The history service returns information about the change history of a coding scheme.

Version:
1.0
Author:
solbrigcvs

Field Summary
static java.lang.String metaURN
           
 
Method Summary
 NCIChangeEventList getAncestors(ConceptReference conceptReference)
          Return the list of change events identifying the immediate ancestors of the given concept reference.
 SystemReleaseList getBaselines(java.util.Date releasedAfter, java.util.Date releasedBefore)
          Return a list of baselines supported by this service that were released on or after the first supplied date and were released on or before the second date.
 CodingSchemeVersionList getConceptChangeVersions(ConceptReference conceptReference, java.util.Date beginDate, java.util.Date endDate)
          Return a list of all of the coding scheme versions in which the supplied concept changed between the two supplied times (inclusive).
 CodingSchemeVersion getConceptCreationVersion(ConceptReference conceptReference)
          Return the coding scheme version in which the supplied concept was created.
 NCIChangeEventList getDescendants(ConceptReference conceptReference)
          Return the list of change events identifying the immediate descendants of the given concept reference.
 SystemRelease getEarliestBaseline()
          Return the earliest baseline version in the list.
 NCIChangeEventList getEditActionList(ConceptReference conceptReference, CodingSchemeVersion codingSchemeVersion)
          Return the list of available NCI-defined change events for the given concept and coding scheme version.
 NCIChangeEventList getEditActionList(ConceptReference conceptReference, java.util.Date beginDate, java.util.Date endDate)
          Return the list of available NCI-defined change events for the given concept and date range.
 NCIChangeEventList getEditActionList(ConceptReference conceptReference, java.net.URI releaseURN)
          Return the list of NCI-defined change events for the given concept and release; empty if not applicable.
 SystemRelease getLatestBaseline()
          Get the latest baseline in the list.
 SystemReleaseDetail getSystemRelease(java.net.URI releaseURN)
          Return detailed information about the particular system release.
 

Field Detail

metaURN

static final java.lang.String metaURN
See Also:
Constant Field Values
Method Detail

getAncestors

NCIChangeEventList getAncestors(ConceptReference conceptReference)
                                throws LBParameterException,
                                       LBInvocationException
Return the list of change events identifying the immediate ancestors of the given concept reference.

Parameters:
conceptReference - ConceptReference
Returns:
NCIChangeEventList
Throws:
LBParameterException,LBInvocationException
LBParameterException
LBInvocationException

getBaselines

SystemReleaseList getBaselines(java.util.Date releasedAfter,
                               java.util.Date releasedBefore)
                               throws LBParameterException,
                                      LBInvocationException
Return a list of baselines supported by this service that were released on or after the first supplied date and were released on or before the second date. Returned baselines are arranged in sequential order, from earliest to latest.

Parameters:
releasedAfter - If present, only return baselines released on or after the supplied date.
releasedBefore - If present, only return baselines that were released before the specified date
Throws:
LBParameterException
LBInvocationException

getConceptChangeVersions

CodingSchemeVersionList getConceptChangeVersions(ConceptReference conceptReference,
                                                 java.util.Date beginDate,
                                                 java.util.Date endDate)
                                                 throws LBParameterException,
                                                        LBInvocationException
Return a list of all of the coding scheme versions in which the supplied concept changed between the two supplied times (inclusive).

Parameters:
conceptReference - The concept to pull the versions out of
beginDate - Begin date (inclusive) to check for version changes. If omitted, go to earliest recorded date
endDate - Last date to check for changes in (inclusive). If omitted include all dates past and including beginDate
Throws:
LBParameterException
LBInvocationException

getConceptCreationVersion

CodingSchemeVersion getConceptCreationVersion(ConceptReference conceptReference)
                                              throws LBParameterException,
                                                     LBInvocationException
Return the coding scheme version in which the supplied concept was created.

Parameters:
conceptReference - ConceptReference
Throws:
LBParameterException
LBInvocationException

getDescendants

NCIChangeEventList getDescendants(ConceptReference conceptReference)
                                  throws LBParameterException,
                                         LBInvocationException
Return the list of change events identifying the immediate descendants of the given concept reference.

Parameters:
conceptReference - ConceptReference
Returns:
NCIChangeEventList
Throws:
LBParameterException,LBInvocationException
LBParameterException
LBInvocationException

getEarliestBaseline

SystemRelease getEarliestBaseline()
                                  throws LBInvocationException
Return the earliest baseline version in the list.

Throws:
LBInvocationException

getEditActionList

NCIChangeEventList getEditActionList(ConceptReference conceptReference,
                                     CodingSchemeVersion codingSchemeVersion)
                                     throws LBParameterException,
                                            LBInvocationException
Return the list of available NCI-defined change events for the given concept and coding scheme version.

Parameters:
conceptReference - Optional concept to get the action list for. If omitted, all events for the given change set (represented by a coding scheme version) are returned.
codingSchemeVersion - Version to get the action list for
Throws:
LBParameterException
LBInvocationException

getEditActionList

NCIChangeEventList getEditActionList(ConceptReference conceptReference,
                                     java.util.Date beginDate,
                                     java.util.Date endDate)
                                     throws LBParameterException,
                                            LBInvocationException
Return the list of available NCI-defined change events for the given concept and date range.

Parameters:
conceptReference - Optional concept to get the action list for. If omitted, all events for the given date range are returned.
beginDate - Begin date (inclusive) to check for version changes. If omitted, go to earliest recorded date.
endDate - Last date to check for changes in (inclusive). If omitted include all dates past and including beginDate.
Throws:
LBParameterException
LBInvocationException

getEditActionList

NCIChangeEventList getEditActionList(ConceptReference conceptReference,
                                     java.net.URI releaseURN)
                                     throws LBParameterException,
                                            LBInvocationException
Return the list of NCI-defined change events for the given concept and release; empty if not applicable.

Parameters:
conceptReference - Optional concept to get the action list for. If omitted the actions for all registered concepts for the specified system release are returned.
releaseURN - URN of the system release to retrieve the action list for.
Throws:
LBParameterException
LBInvocationException

getLatestBaseline

SystemRelease getLatestBaseline()
                                throws LBInvocationException
Get the latest baseline in the list.

Throws:
LBInvocationException

getSystemRelease

SystemReleaseDetail getSystemRelease(java.net.URI releaseURN)
                                     throws LBParameterException,
                                            LBInvocationException
Return detailed information about the particular system release.

Parameters:
releaseURN - The URN of the system release to retrieve.
Throws:
LBParameterException
LBInvocationException

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.