public interface LexBIGServiceMetadata
extends java.io.Serializable
Modifier and Type | Method and Description |
---|---|
AbsoluteCodingSchemeVersionReferenceList |
listCodingSchemes()
List the coding schemes that are represented in the metadata index.
|
MetadataPropertyList |
resolve()
Apply all of the restrictions, and return the result.
|
LexBIGServiceMetadata |
restrictToCodingScheme(AbsoluteCodingSchemeVersionReference acsvr)
Restrict the search to a particular coding scheme.
|
LexBIGServiceMetadata |
restrictToProperties(java.lang.String[] properties)
Restrict the search to a particular property.
|
LexBIGServiceMetadata |
restrictToPropertyParents(java.lang.String[] propertyParents)
Restrict the search by the parents of the metadata elements.
|
LexBIGServiceMetadata |
restrictToValue(java.lang.String matchText,
java.lang.String matchAlgorithm)
Restrict the result to the metadata elements that match the supplied string,
using the supplied matching algorithm
|
AbsoluteCodingSchemeVersionReferenceList listCodingSchemes() throws LBInvocationException
LBInvocationException
LexBIGServiceMetadata restrictToCodingScheme(AbsoluteCodingSchemeVersionReference acsvr) throws LBParameterException
acsvr
- The coding scheme to restrict the search to. You may provide the URN,
the version, or both.LBParameterException
LexBIGServiceMetadata restrictToProperties(java.lang.String[] properties) throws LBParameterException
properties
- The set of properties to restrict the search to. If you provide multiple properties,
it is treated as an OR search.LBParameterException
LexBIGServiceMetadata restrictToPropertyParents(java.lang.String[] propertyParents) throws LBParameterException
propertyParents
- The containers to require as parents. For example, to restrict the search to
"contacts" that are under "about" that is under "authority" - provide "authority"
and "about".
The order of the parents does not matter. Multiple parents are treated as an AND -
so the result is required to be under each of the parents going up the parent tree.LBParameterException
LexBIGServiceMetadata restrictToValue(java.lang.String matchText, java.lang.String matchAlgorithm) throws LBParameterException
matchText
- The match text. Format is determined by the match algorithm.matchAlgorithm
- Local name of the match algorithm - possible algorithms are
returned in LexBigService.getMatchAlgorithms().LBParameterException
MetadataPropertyList resolve() throws LBParameterException, LBInvocationException
LBParameterException
LBInvocationException