Documents the internal service APIs.
There is a collection of internal APIs that provide the core functionality. Applications could be developed to use a “within JVM” connection to these services and through JPA lazy initialization entire graphs of objects can be read from the database (in either their current state or any desired past state).
Data model access services generally take either internal ids or terminology-specific assigned identifiers (e.g. SCTID) and return individual objects without any eagerly initialized connected data. TBD.. discuss this for each "type" of domain model object
Services that create, modify, or remove data objects ...
Dual independent review of map records is achieved by creating completely separate objects associated with each user and then comparing when both have indicated work on mapping the underlying concept is complete.
In general, methods that find data return search result objects with identifiers (with display labels) that can be used to perform subsequent lookups to retrieve the underlying model objects. These methods typically also take a paging/sorting/filtering parameter to allow for controlled access to the desired amount of data.
All services implement root service which provides the following functionality
beginTransaction
close
closeFactory
commit
getTransactionPerOperation
openFactory
setTransactionPerOperation
The internal security service API supports the following functionality:
authenticate
getApplicationRoleForToken
getMapProjectRoleForToken
getUsernameForToken
The internal metadata service API supports the following functionality:
getAllMetadata
getAttributeValueRefSets
getCaseSignificances
getComplexMapRefSets
getDefinitionStatuses
getDescriptionTypes
getHierarchicalRelationshipTypes
getLanguageRefSets
getLatestVersion
getMapRelations
getModules
getRelationshipCharacteristicTypes
getRelationshipModifiers
getRelationshipTypes
getSimpleMapRefSets
getSimpleRefSets
getTerminologies
getTerminologyLatestVersions
getVersions
The internal content service API supports the following functionality:
clearTreePositions
computeTreePositions
findConceptsForQuery
findDescendantConcepts
getAllConcepts
getAllDescriptionTerminologyIds
getAllLanguageRefSetMemberTerminologyIds
getAllRelationshipTerminologyIds
getComplexMapRefSetMembersForRefSetId
getConcept
getConcept
getConcepts
getConceptsModifiedSinceDate
getDescendantConceptsCount
Returns the count of descendants for a terminologyId/terminology/version
getRootTreePositions
getTreePositionGraphForQuery
getTreePositions
getTreePositionsWithChildren
getTreePositionsWithDescendants
getTreePositionWithDescendants
updateComplexMapRefSetMember
updateConcept
updateDescription
updateLanguageRefSetMember
updateRelationship
The internal mapping service API supports the following functionality:
addMapAdvice(MapAdvice)
addMapAgeRange(MapAgeRange)
addMapPrinciple(MapPrinciple)
addMapProject(MapProject)
addMapRecord(MapRecord)
addMapRelation(MapRelation)
addMapUser(MapUser)
addMapUserPreferences(MapUserPreferences)
checkMapGroupsForMapProject(MapProject, boolean)
createMapRecordsForMapProject(Long, MapUser, List<ComplexMapRefSetMember>, WorkflowStatus)
createMapRecordsForMapProject(Long, MapUser, List<ComplexMapRefSetMember>, WorkflowStatus, float)
createMapRecordsForMapProject(Long, WorkflowStatus)
findConceptsExcludedFromScope(Long, PfsParameter)
findConceptsInScope(Long, PfsParameter)
findMappedConceptsOutOfScopeBounds(Long, PfsParameter)
findMapProjectsForQuery(String, PfsParameter)
findMapRecordsForQuery(String, PfsParameter)
findUnmappedConceptsInScope(Long, PfsParameter)
findUnmappedDescendantsForConcept(String, Long, PfsParameter)
getMapAdvices()
getMapAgeRanges()
getMapPrinciple(Long)
getMapPrinciples()
getMapProject(Long)
getMapProjectForRefSetId(String)
getMapProjectMetadata()
getMapProjects()
getMapProjectsForMapUser(MapUser)
getMapRecord(Long)
getMapRecordRevisions(Long)
getMapRecordRevisionsForConcept(String, Long)
getMapRecords()
getMapRecordsForConcept(String)
getMapRecordsForMapProject(Long)
getMapRecordsForProjectAndConcept(Long, String)
getMapRelations()
getMapUser(Long)
getMapUser(String)
getMapUserRoleForMapProject(String, Long)
getMapUsers()
getOriginMapRecordsForConflict(Long)
getProjectSpecificAlgorithmHandler(MapProject)
getPublishedAndReadyForPublicationMapRecordsForMapProject(Long, PfsParameter)
getPublishedMapRecordsForMapProject(Long, PfsParameter)
getRecentlyEditedMapRecords(Long, String, PfsParameter)
getScopeConceptsForMapProject(MapProject, PfsParameter)
getScopeExcludedConceptsForMapProject(MapProject, PfsParameter)
isConceptExcludedFromScope(String, Long)
isConceptInScope(String, Long)
isConceptOutOfScopeBounds(String, Long)
removeMapAdvice(Long)
removeMapAdviceFromEnvironment(MapAdvice)
removeMapAgeRange(Long)
removeMapPrinciple(Long)
removeMapProject(Long)
removeMapRecord(Long)
removeMapRecordsForMapProject(Long)
removeMapRelation(Long)
setTreePositionTerminologyNotes(List<TreePosition>, Long)
setTreePositionValidCodes(List<TreePosition>, Long)
updateMapAdvice(MapAdvice)
updateMapAgeRange(MapAgeRange)
updateMapPrinciple(MapPrinciple)
Updates a map principle
updateMapProject(MapProject)
updateMapRecord(MapRecord)
updateMapRelation(MapRelation)
updateMapUser(MapUser)
updateMapUserPreferences(MapUserPreferences)
The internal workflow service API supports the following functionality:
addFeedback(Feedback)
addFeedbackConversation(FeedbackConversation)
addTrackingRecord(TrackingRecord)
addWorkflowException(WorkflowException)
clearWorkflowForMapProject(MapProject)
computeUntrackedMapRecords(MapProject)
computeWorkflow(MapProject)
computeWorkflowStatusErrors(MapProject)
createQAWork(Report)
findAssignedConflicts(MapProject, MapUser, String, PfsParameter)
findAssignedQAWork(MapProject, MapUser, String, PfsParameter)
findAssignedReviewWork(MapProject, MapUser, String, PfsParameter)
findAssignedWork(MapProject, MapUser, String, PfsParameter)
findAvailableConflicts(MapProject, MapUser, String, PfsParameter)
Finds paged/filtered/sorted available conflicts for a map user, project, and query
findAvailableQAWork(MapProject, MapUser, String, PfsParameter)
Finds paged/filtered/sorted available QA work for a map user, project, and query
findAvailableReviewWork(MapProject, MapUser, String, PfsParameter)
Finds paged/filtered/sorted available review work for a map user, project, and query
findAvailableWork(MapProject, MapUser, String, PfsParameter)
Finds paged/filtered/sorted available mapping work for a map user, project, and query
findFeedbackConversationsForProject(Long, String, String, PfsParameter)
getFeedbackConversation(Long)
getFeedbackConversationsForConcept(Long, String)
getFeedbackConversationsForRecord(Long)
getFeedbackErrorsForRecord(MapRecord)
getFeedbacks()
getLowestWorkflowStatusForTrackingRecord(TrackingRecord)
getLowestWorkflowStatusFromMapRecords(Set<MapRecord>)
getMapRecordsForTrackingRecord(TrackingRecord)
getMapUsersForTrackingRecord(TrackingRecord)
getMapUsersFromMapRecords(Set<MapRecord>)
getTrackingRecordForMapProjectAndConcept(MapProject, Concept)
getTrackingRecordForMapProjectAndConcept(MapProject, String)
getTrackingRecords()
getTrackingRecordsForMapProject(MapProject)
getWorkflowException(MapProject, String)
getWorkflowStatusForTrackingRecord(TrackingRecord)
getWorkflowStatusFromMapRecords(Set<MapRecord>)
processWorkflowAction(MapProject, Concept, MapUser, MapRecord, WorkflowAction)
removeTrackingRecord(Long)
removeWorkflowException(Long)
synchronizeMapRecords(TrackingRecord, Set<MapRecord>)
updateFeedbackConversation(FeedbackConversation)
updateTrackingRecord(TrackingRecord)
updateWorkflowException(WorkflowException)
The internal report service API supports the following functionality:
addReport(Report)
addReportDefinition(ReportDefinition)
addReportNote(ReportNote)
addReportResult(ReportResult)
addReportResultItem(ReportResultItem)
findReportsForQuery(String, PfsParameter)
generateDailyReports(MapProject, MapUser)
generateReport(MapProject, MapUser, String, ReportDefinition, Date, boolean)
generateReportsForDateRange(MapProject, MapUser, Date, Date)
getQACheckDefinitions()
getQACheckDefinitionsForRole(MapUserRole)
getQALabels()
getReport(Long)
getReportDefinition(Long)
getReportDefinitions()
getReportDefinitionsForRole(MapUserRole)
getReportNote(Long)
getReportResult(Long)
getReportResultItem(Long)
getReportResultItemsForReportResult(Long, PfsParameter)
getReports()
getReportsForMapProject(MapProject, PfsParameter)
getReportsForMapProjectAndReportDefinition(MapProject, ReportDefinition, PfsParameter)
removeReport(Long)
removeReportDefinition(Long)
removeReportNote(Long)
removeReportResult(Long)
removeReportResultItem(Long)
removeReportsForMapProject(MapProject)
updateReport(Report)
updateReportDefinition(ReportDefinition)
updateReportNote(ReportNote)
updateReportResult(ReportResult)
updateReportResultItem(ReportResultItem)