public interface LexEVSPickListDefinitionServices
extends java.io.Serializable
Modifier and Type | Method and Description |
---|---|
void |
exportPickListDefinition(java.lang.String pickListId,
java.lang.String xmlFolderLocation,
boolean overwrite,
boolean failOnAllErrors)
Exports the pick list definition in LexGrid XML format.
|
LogEntry[] |
getLogEntries() |
PickListDefinition |
getPickListDefinitionById(java.lang.String pickListId)
Returns pickList definition for supplied pickListId.
|
java.util.List<java.lang.String> |
getPickListDefinitionIdForValueSetDefinitionUri(java.net.URI valueSetDefURI)
Returns all the pickList definition id's that represents supplied value set definition URI.
|
java.util.List<java.lang.String> |
getPickListIdsForSupportedTagAndValue(java.lang.String supportedTag,
java.lang.String value)
Returns all the pickListIds that contain supplied supported tag and value.
|
java.net.URI |
getPickListValueSetDefinition(java.lang.String pickListId)
Returns an URI of the represented value set definition of the pickList.
|
java.util.Map<java.lang.String,java.lang.String> |
getReferencedPLDefinitions(java.lang.String valueSet,
java.lang.Boolean extractPickListName)
Return the map set of pick list id and pick list name that references value set definition URI
|
java.util.Map<java.lang.String,java.lang.String> |
getReferencedPLDefinitions(java.lang.String entityCode,
java.lang.String entityCodeNameSpace,
java.lang.String propertyId,
java.lang.Boolean extractPickListName)
Return the map set of pick list id and pick list name that references given entityCode, namespace and optionally propertyId
|
java.util.List<java.lang.String> |
listPickListIds()
Returns list of pickListIds that are available in the system.
|
void |
loadPickList(PickListDefinition pldef,
java.lang.String systemReleaseURI,
Mappings mappings)
Loads supplied PickListDefinition object
|
void |
loadPickList(java.lang.String xmlFileLocation,
boolean failOnAllErrors)
Loads pick list by reading XML file location supplied
|
void |
removePickList(java.lang.String pickListId)
Removes pick list definition from the system that matches supplied pickListId.
|
ResolvedPickListEntryList |
resolvePickList(PickListDefinition pickList,
boolean sortByText,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Resolves pick list definition object supplied against supplied coding scheme version list.
|
ResolvedPickListEntryList |
resolvePickList(java.lang.String pickListId,
boolean sortByText,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Resolves pickList definition for supplied pickListId.
|
ResolvedPickListEntryList |
resolvePickList(java.lang.String pickListId,
java.lang.Integer sortType,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Resolves pickList definition for supplied pickListId.
|
PickListDefinition |
resolvePickListByRevision(java.lang.String pickListId,
java.lang.String revisionId,
java.lang.Integer sortOrder) |
ResolvedPickListEntryList |
resolvePickListForTerm(java.lang.String pickListId,
java.lang.String term,
java.lang.String matchAlgorithm,
java.lang.String language,
java.lang.String[] context,
boolean sortByText,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Resolves pickList definition for supplied arguments.
|
void |
validate(java.net.URI uri,
int valicationLevel) |
PickListDefinition getPickListDefinitionById(java.lang.String pickListId) throws LBException
pickListId
- pickListId of a pickListDefinitionLBException
java.util.List<java.lang.String> getPickListDefinitionIdForValueSetDefinitionUri(java.net.URI valueSetDefURI) throws LBException
valueSetDefURI
- URI of an value set definitionLBException
java.net.URI getPickListValueSetDefinition(java.lang.String pickListId) throws LBException
pickListId
- LBException
java.util.List<java.lang.String> listPickListIds() throws LBException
LBException
void loadPickList(PickListDefinition pldef, java.lang.String systemReleaseURI, Mappings mappings) throws LBException
pldef
- pick list to loadsystemReleaseURI
- mappings
- LBException
void loadPickList(java.lang.String xmlFileLocation, boolean failOnAllErrors) throws LBException
xmlFileLocation
- XML file containing pick list definitionsfailOnAllErrors
- LBException
void removePickList(java.lang.String pickListId) throws LBException
pickListId
- id of pickList to removeLBException
ResolvedPickListEntryList resolvePickList(java.lang.String pickListId, boolean sortByText, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
pickListId
- pickListId of a pickListDefinition.sortByText
- If True; the resolved pickListEntries will be sorted by text in ascending order.csVersionList
- - a list of coding scheme URI's and versions to be used. These will be used only if they are present in
the service. If absent, the most recent version will be used instead.versionTag
- - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present.
Note that non-tagged versions will be used if the tagged version is missing.LBException
ResolvedPickListEntryList resolvePickList(java.lang.String pickListId, java.lang.Integer sortType, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
pickListId
- pickListId of a pickListDefinition.sortByText
- If 1-Ascending, 2-Descending, and 3-Custom;csVersionList
- - a list of coding scheme URI's and versions to be used. These will be used only if they are present in
the service. If absent, the most recent version will be used instead.versionTag
- - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present.
Note that non-tagged versions will be used if the tagged version is missing.LBException
ResolvedPickListEntryList resolvePickList(PickListDefinition pickList, boolean sortByText, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
pickList
- pickListDefinition object.sortByText
- If True; the resolved pickListEntries will be sorted by text in ascending order.csVersionList
- - a list of coding scheme URI's and versions to be used. These will be used only if they are present in
the service. If absent, the most recent version will be used instead.versionTag
- - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present.
Note that non-tagged versions will be used if the tagged version is missing.LBException
ResolvedPickListEntryList resolvePickListForTerm(java.lang.String pickListId, java.lang.String term, java.lang.String matchAlgorithm, java.lang.String language, java.lang.String[] context, boolean sortByText, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
pickListId
- pickListId of a pickListDefinition. This is required argument.term
- Term to restrict. This is required argument.matchAlgorithm
- Optional, match algorithm to use.language
- Optional, language to restrict.context
- Optional, list of context to restrict.sortByText
- If True; the resolved pickListEntries will be sorted by text in ascending order.csVersionList
- - a list of coding scheme URI's and versions to be used. These will be used only if they are present in
the service. If absent, the most recent version will be used instead.versionTag
- - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present.
Note that non-tagged versions will be used if the tagged version is missing.LBException
void validate(java.net.URI uri, int valicationLevel) throws LBException
uri
- XML file containing pickList definitionsvalicationLevel
- validate <int> Perform validation of the candidate
resource without loading data.
Supported levels of validation include:
0 = Verify document is well-formed
1 = Verify document is validLBException
java.util.Map<java.lang.String,java.lang.String> getReferencedPLDefinitions(java.lang.String entityCode, java.lang.String entityCodeNameSpace, java.lang.String propertyId, java.lang.Boolean extractPickListName) throws LBException
entityCode
- referenced entityCodeentityCodeNameSpace
- referenced entityCodeNamespacepropertyId
- Optional propertyIdextractPickListName
- true means pick list name will be extracted in the map set.LBException
java.util.Map<java.lang.String,java.lang.String> getReferencedPLDefinitions(java.lang.String valueSet, java.lang.Boolean extractPickListName) throws LBException
valueSet
- URI of value set definitionextractPickListName
- true means pick list name will be extracted in the map setLBException
java.util.List<java.lang.String> getPickListIdsForSupportedTagAndValue(java.lang.String supportedTag, java.lang.String value)
supportedTag
- like SupportedCodingScheme, SupportedAssociation etc.value
- value to look forvoid exportPickListDefinition(java.lang.String pickListId, java.lang.String xmlFolderLocation, boolean overwrite, boolean failOnAllErrors) throws LBException
pickListId
- id of pick list definition to exportxmlFolderLocation
- destination locationoverwrite
- failOnAllErrors
- LBException
LogEntry[] getLogEntries()
PickListDefinition resolvePickListByRevision(java.lang.String pickListId, java.lang.String revisionId, java.lang.Integer sortOrder) throws LBRevisionException
LBRevisionException