public interface Terms
| Modifier and Type | Method and Description |
|---|---|
List<Term> |
getAllTerms(Pagination pagination)
Return all available
Terms in the retina. |
List<Term> |
getAllTerms(Pagination pagination,
Boolean includeFingerprint)
Return all available
Terms in the retina. |
List<Context> |
getContexts(String term)
Retrieve contexts for the input term.
|
List<Context> |
getContexts(String term,
Boolean includeFingerprint)
Retrieve contexts for the input term.
|
List<Context> |
getContexts(String term,
Pagination pagination,
Boolean includeFingerprint)
Retrieve contexts for the input term.
|
List<Term> |
getSimilarTerms(String term)
Retrieve all similar terms for the input.
|
List<Term> |
getSimilarTerms(String term,
Integer contextId,
PosType posType)
Retrieve all similar terms for the input.
|
List<Term> |
getSimilarTerms(String term,
Integer contextId,
PosType posType,
Boolean includeFingerprint)
Retrieve all similar terms for the input.
|
List<Term> |
getSimilarTerms(String term,
Integer contextId,
PosType posType,
Pagination pegination,
Boolean includeFingerprint)
Retrieve all similar terms for the input.
|
List<Term> |
getTerm(String term)
Retrieve a term with meta-data for an exact match, or a list of potential retina terms.
|
List<Term> |
getTerm(String term,
Boolean includeFingerprint)
Retrieve a term with meta-data for an exact match, or a list of potential retina terms.
|
List<Term> |
getTerm(String term,
Pagination pagination,
Boolean includeFingerprint)
Retrieve a term with meta-data for an exact match, or a list of potential retina terms.
|
List<Context> getContexts(String term, Pagination pagination, Boolean includeFingerprint) throws ApiException
term - : the input term.pagination - : the response's items pagination mechanism configuration.includeFingerprint - : true if the fingerprint should be provided in the response.ApiException - : if there are server or connection issues.List<Context> getContexts(String term, Boolean includeFingerprint) throws ApiException
DefaultValues.DEF_VALUE_START_INDEX
DefaultValues.DEF_VALUE_MAX_CONTEXTS_COUNT
term - : the input termincludeFingerprint - : true if the fingerprint should be provided in the response.ApiException - : if there are server or connection issues.List<Context> getContexts(String term) throws ApiException
DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
DefaultValues.DEF_VALUE_START_INDEX
DefaultValues.DEF_VALUE_MAX_CONTEXTS_COUNT
term - : the input term.ApiException - : if there are server or connection issues.List<Term> getSimilarTerms(String term, Integer contextId, PosType posType, Pagination pegination, Boolean includeFingerprint) throws ApiException
term - : the input termcontextId - : the context idposType - : the posType used for filteringpegination - : the response items pagination mechanism configuration.includeFingerprint - : true if the fingerprint should be provided in the response.ApiException - : if there are server or connection issues.List<Term> getSimilarTerms(String term, Integer contextId, PosType posType, Boolean includeFingerprint) throws ApiException
DefaultValues.DEF_VALUE_START_INDEX
DefaultValues.DEF_VALUE_MAX_ITEMS_COUNT
term - : the input termcontextId - : the context idposType - : the posType used for filteringincludeFingerprint - : true if the fingerprint should be provided in the response.ApiException - : if there are server or connection issues.List<Term> getSimilarTerms(String term, Integer contextId, PosType posType) throws ApiException
DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
DefaultValues.DEF_VALUE_START_INDEX
DefaultValues.DEF_VALUE_MAX_ITEMS_COUNT
term - : the input termcontextId - : the context idposType - : the posType used for filteringApiException - : if there are server or connection issues.List<Term> getSimilarTerms(String term) throws ApiException
DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
DefaultValues.DEF_VALUE_START_INDEX
DefaultValues.DEF_VALUE_MAX_ITEMS_COUNT
term - : the input termcontextId - : the context idposType - : the posType used for filteringApiException - : if there are server or connection issues.List<Term> getTerm(String term, Pagination pagination, Boolean includeFingerprint) throws ApiException
term - : the term for which to retrieve a term or a list of potential terms.pagination - : the response's items pagination mechanism configuration.includeFingerprint - : true if the fingerprint should be provided in the response.ApiException - : if there are server or connection issues.List<Term> getTerm(String term, Boolean includeFingerprint) throws ApiException
DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINTterm - : the term for which to retrieve a Term object or a list of potential terms.includeFingerprint - : true if the fingerprint should be provided in the response.ApiException - : if there are server or connection issues.List<Term> getTerm(String term) throws ApiException
DefaultValues.DEF_VALUE_PROVIDE_FINGERPRINT
DefaultValues.DEF_VALUE_START_INDEX
DefaultValues.DEF_VALUE_MAX_ITEMS_COUNT
term - : the term for which to retrieve a Term or a list of potential terms.ApiException - : if there are server or connection issues.List<Term> getAllTerms(Pagination pagination) throws ApiException
Terms in the retina.pagination - : the response items pagination mechanism configuration.Terms with pagination.ApiException - : if there are server or connection issues.List<Term> getAllTerms(Pagination pagination, Boolean includeFingerprint) throws ApiException
Terms in the retina.pagination - : the response's items pagination mechanism configuration.includeFingerprint - : true if the fingerprint should be provided in the response.Term with pagination.ApiException - : if there are server or connection issues.Copyright © 2015. All rights reserved.