Package com.opentext.livelink.service.searchservices

Class SearchService_JAXWS

  • public class SearchService_JAXWS
extends java.lang.Object
    The SearchService API is deprecated. The Search REST API or the Search API (sometimes known as the XML Search API) should be used instead.
    Version:
    2018-06-20

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String[] getDataCollections()
      Gets a list of data collections (i.e. slices) for this search target which may be used in the Search.
      FieldInfo[] getFieldInfo​(java.lang.String dataCollection, java.lang.String[] fieldhints)
      Gets a list of fields which may be used in the ProjectionSpec of Search.
      java.lang.String getQueryLanguageDescription​(java.lang.String iso639LanguageCode, java.lang.String queryLanguage)
      Gets a description of how to use the query language, including syntax and semantics.
      java.lang.String getResultPageDescription​(java.lang.String iso639LanguageCode, java.lang.String queryLanguage)
      Gets a description of the result page graph structures.
      java.lang.String[] getSupportedQueryLanguages()
      Gets the list of supported query languages.
      SingleSearchResponse search​(SingleSearchRequest queries, java.lang.String partitionName)
      Gets a list of items according to some critera for inclusion and sorting.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SearchService_JAXWS

        public SearchService_JAXWS()

    • Method Detail

      • getDataCollections

        public java.lang.String[] getDataCollections()
        Gets a list of data collections (i.e. slices) for this search target which may be used in the Search.
        Returns:
        a list of slice names.

      • getFieldInfo

        public FieldInfo[] getFieldInfo​(java.lang.String dataCollection,
                                java.lang.String[] fieldhints)
        Gets a list of fields which may be used in the ProjectionSpec of Search.
        Parameters:
        dataCollection - the data collection (i.e. the slice) to be queried
        fieldhints - a list of substrings to be matched in order to return a subset of available fields
        Returns:
        fields present in the

      • getQueryLanguageDescription

        public java.lang.String getQueryLanguageDescription​(java.lang.String iso639LanguageCode,
                                                    java.lang.String queryLanguage)
        Gets a description of how to use the query language, including syntax and semantics.
        Parameters:
        iso639LanguageCode - the three letter language code for the delivery of the description. Currently only 'eng' is supported.
        queryLanguage - the query language which should be described
        Returns:
        A description of how to use the query language.

      • getResultPageDescription

        public java.lang.String getResultPageDescription​(java.lang.String iso639LanguageCode,
                                                 java.lang.String queryLanguage)
        Gets a description of the result page graph structures.
        Parameters:
        iso639LanguageCode - the three letter language code for the delivery of the description
        queryLanguage - the query language which will be used to generate the result page
        Returns:
        A description of the result page graph structures.

      • getSupportedQueryLanguages

        public java.lang.String[] getSupportedQueryLanguages()
        Gets the list of supported query languages.
        Returns:
        The list of supported query languages.

      • search

        public SingleSearchResponse search​(SingleSearchRequest queries,
                                   java.lang.String partitionName)
        Gets a list of items according to some critera for inclusion and sorting.
        Parameters:
        queries - a search query
        partitionName - a string to be prepended to any dataids returned
        Returns:
        The results of the search.