public class TLcdOpenSearchQuery extends TLcdDataObject
Modifier and Type | Class and Description |
---|---|
static class |
TLcdOpenSearchQuery.Role |
Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
COUNT_PROPERTY
Data property that maps to the
count attribute. |
static TLcdDataProperty |
INPUT_ENCODING_PROPERTY
Data property that maps to the
inputEncoding attribute. |
static TLcdDataProperty |
LANGUAGE_PROPERTY
Data property that maps to the
language attribute. |
static TLcdDataProperty |
OUTPUT_ENCODING_PROPERTY
Data property that maps to the
outputEncoding attribute. |
static TLcdDataProperty |
ROLE_PROPERTY
Data property that maps to the
role attribute. |
static TLcdDataProperty |
SEARCH_TERMS_PROPERTY
Data property that maps to the
searchTerms attribute. |
static TLcdDataProperty |
START_INDEX_PROPERTY
Data property that maps to the
startIndex attribute. |
static TLcdDataProperty |
START_PAGE_PROPERTY
Data property that maps to the
startPage attribute. |
static TLcdDataProperty |
TITLE_PROPERTY
Data property that maps to the
title attribute. |
static TLcdDataProperty |
TOTAL_RESULTS_PROPERTY
Data property that maps to the
totalResults attribute. |
Constructor and Description |
---|
TLcdOpenSearchQuery() |
TLcdOpenSearchQuery(TLcdDataType aType) |
Modifier and Type | Method and Description |
---|---|
Long |
getCount()
Returns the value of the property that maps to the
count attribute. |
String |
getInputEncoding()
Returns the value of the property that maps to the
inputEncoding attribute. |
String |
getLanguage()
Returns the value of the property that maps to the
language attribute. |
String |
getOutputEncoding()
Returns the value of the property that maps to the
outputEncoding attribute. |
TLcdOpenSearchQuery.Role |
getRole()
Returns the value of the property that maps to the
role attribute. |
String |
getSearchTerms()
Returns the value of the property that maps to the
searchTerms attribute. |
Long |
getStartIndex()
Returns the value of the property that maps to the
startIndex attribute. |
Long |
getStartPage()
Returns the value of the property that maps to the
startPage attribute. |
String |
getTitle()
Returns the value of the property that maps to the
title attribute. |
Long |
getTotalResults()
Returns the value of the property that maps to the
totalResults attribute. |
void |
setCount(Long aValue)
Sets the value of the property that maps to the
count attribute. |
void |
setInputEncoding(String aValue)
Sets the value of the property that maps to the
inputEncoding attribute. |
void |
setLanguage(String aValue)
Sets the value of the property that maps to the
language attribute. |
void |
setOutputEncoding(String aValue)
Sets the value of the property that maps to the
outputEncoding attribute. |
void |
setRole(TLcdOpenSearchQuery.Role aValue)
Sets the value of the property that maps to the
role attribute. |
void |
setSearchTerms(String aValue)
Sets the value of the property that maps to the
searchTerms attribute. |
void |
setStartIndex(Long aValue)
Sets the value of the property that maps to the
startIndex attribute. |
void |
setStartPage(Long aValue)
Sets the value of the property that maps to the
startPage attribute. |
void |
setTitle(String aValue)
Sets the value of the property that maps to the
title attribute. |
void |
setTotalResults(Long aValue)
Sets the value of the property that maps to the
totalResults attribute. |
public static final TLcdDataProperty COUNT_PROPERTY
count
attribute.
The possible values for this property are instances of Long
.public static final TLcdDataProperty INPUT_ENCODING_PROPERTY
inputEncoding
attribute.
The possible values for this property are instances of String
.public static final TLcdDataProperty LANGUAGE_PROPERTY
language
attribute.
The possible values for this property are instances of String
.public static final TLcdDataProperty OUTPUT_ENCODING_PROPERTY
outputEncoding
attribute.
The possible values for this property are instances of String
.public static final TLcdDataProperty ROLE_PROPERTY
role
attribute.
The possible values for this property are instances of Role
.public static final TLcdDataProperty SEARCH_TERMS_PROPERTY
searchTerms
attribute.
The possible values for this property are instances of String
.public static final TLcdDataProperty START_INDEX_PROPERTY
startIndex
attribute.
The possible values for this property are instances of Long
.public static final TLcdDataProperty START_PAGE_PROPERTY
startPage
attribute.
The possible values for this property are instances of Long
.public static final TLcdDataProperty TITLE_PROPERTY
title
attribute.
The possible values for this property are instances of String
.public static final TLcdDataProperty TOTAL_RESULTS_PROPERTY
totalResults
attribute.
The possible values for this property are instances of Long
.public TLcdOpenSearchQuery()
public TLcdOpenSearchQuery(TLcdDataType aType)
public Long getCount()
count
attribute.
Contains the value representing the "count" as a OpenSearch 1.1 parameter. Search clients should anticipate that the value of the "count" parameter may not be honored by the search engine, and should rely exclusively on the contents of the "itemsPerPage" response element in calculating actual page size.
COUNT_PROPERTY
property.public void setCount(Long aValue)
count
attribute.
Contains the value representing the "count" as a OpenSearch 1.1 parameter. Search clients should anticipate that the value of the "count" parameter may not be honored by the search engine, and should rely exclusively on the contents of the "itemsPerPage" response element in calculating actual page size.
aValue
- the value to set for the COUNT_PROPERTY
property.public String getInputEncoding()
inputEncoding
attribute.
Contains the value representing the "inputEncoding" as an OpenSearch 1.1 parameter. Replaced with a string that indicates that the search client is performing the search request encoded with the specified character encoding. An OpenSearch description document should include one "InputEncoding" element for each character encoding that can be used to encode search requests. The "inputEncoding" template parameter in the OpenSearch URL template can be used to require the search client to identify which encoding is being used to encode the current search request. Restrictions: The value must conform to the XML 1.0 Character Encodings, as specified by the IANA Character Set Assignments.
INPUT_ENCODING_PROPERTY
property.public void setInputEncoding(String aValue)
inputEncoding
attribute.
Contains the value representing the "inputEncoding" as an OpenSearch 1.1 parameter. Replaced with a string that indicates that the search client is performing the search request encoded with the specified character encoding. An OpenSearch description document should include one "InputEncoding" element for each character encoding that can be used to encode search requests. The "inputEncoding" template parameter in the OpenSearch URL template can be used to require the search client to identify which encoding is being used to encode the current search request. Restrictions: The value must conform to the XML 1.0 Character Encodings, as specified by the IANA Character Set Assignments.
aValue
- the value to set for the INPUT_ENCODING_PROPERTY
property.public String getLanguage()
language
attribute.
Contains the value representing the "language" as an OpenSearch 1.1 parameter. Replaced with a string that indicates that the search client desires search results in the specified language. An OpenSearch description document should include one "Language" element for each language that the search engine supports. If the search engine also supports queries for any arbitrary language then the OpenSearch description document should include a Language element with a value of "*". The "language" template parameter in the OpenSearch URL template can be used to allow the search client to choose among the available languages. Restrictions: The value must conform to the XML 1.0 Language Identification, as specified by RFC 3066. In addition, a value of "*" will signify that the search client desires search results in any language.
LANGUAGE_PROPERTY
property.public void setLanguage(String aValue)
language
attribute.
Contains the value representing the "language" as an OpenSearch 1.1 parameter. Replaced with a string that indicates that the search client desires search results in the specified language. An OpenSearch description document should include one "Language" element for each language that the search engine supports. If the search engine also supports queries for any arbitrary language then the OpenSearch description document should include a Language element with a value of "*". The "language" template parameter in the OpenSearch URL template can be used to allow the search client to choose among the available languages. Restrictions: The value must conform to the XML 1.0 Language Identification, as specified by RFC 3066. In addition, a value of "*" will signify that the search client desires search results in any language.
aValue
- the value to set for the LANGUAGE_PROPERTY
property.public String getOutputEncoding()
outputEncoding
attribute.
Replaced with a string that indicates that the search client desires a search response encoding with the specified character encoding. An OpenSearch description document should include one "OutputEncoding" element for each character encoding that can be used to encode search responses. The "outputEncoding" template parameter in the OpenSearch URL template can be used to allow the search client to choose a character encoding in the search response. Restrictions: The value must conform to the XML 1.0 Character Encodings, as specified by the IANA Character Set Assignments.
OUTPUT_ENCODING_PROPERTY
property.public void setOutputEncoding(String aValue)
outputEncoding
attribute.
Replaced with a string that indicates that the search client desires a search response encoding with the specified character encoding. An OpenSearch description document should include one "OutputEncoding" element for each character encoding that can be used to encode search responses. The "outputEncoding" template parameter in the OpenSearch URL template can be used to allow the search client to choose a character encoding in the search response. Restrictions: The value must conform to the XML 1.0 Character Encodings, as specified by the IANA Character Set Assignments.
aValue
- the value to set for the OUTPUT_ENCODING_PROPERTY
property.public TLcdOpenSearchQuery.Role getRole()
role
attribute.
role - Contains a string identifying how the search client should interpret the search request defined by this Query element. Role values: A role value consists of an optional prefix followed by the local role value. If the prefix is present it will be separated from the local role value with the ":" character. All role values are associated with a namespace, either implicitly in the case of local role values, or explicitly via a prefix in the case of fully qualified role values. Role extensibility: The role attribute may take on values beyond those specified in this document provided they are fully qualified with a prefix and associated with a declared namespace. Clients that encounter unrecognized role values should continue to process the document as if the Query element containing the unrecognized role value did not appear. Role prefix: A role prefix associates a local role name with a namespace. All prefixes must be previously declared as an XML namespace prefix on the containing Query element or ancestor elements. Local role values: Local role values are not preceded by a prefix. Local role values are associated with the OpenSearch 1.1 namespace. The following role values are identified with the OpenSearch 1.1 namespace. The list is exhaustive; only the role values listed below may appear in the OpenSearch 1.1 namespace. Role values:
ROLE_PROPERTY
property.public void setRole(TLcdOpenSearchQuery.Role aValue)
role
attribute.
role - Contains a string identifying how the search client should interpret the search request defined by this Query element. Role values: A role value consists of an optional prefix followed by the local role value. If the prefix is present it will be separated from the local role value with the ":" character. All role values are associated with a namespace, either implicitly in the case of local role values, or explicitly via a prefix in the case of fully qualified role values. Role extensibility: The role attribute may take on values beyond those specified in this document provided they are fully qualified with a prefix and associated with a declared namespace. Clients that encounter unrecognized role values should continue to process the document as if the Query element containing the unrecognized role value did not appear. Role prefix: A role prefix associates a local role name with a namespace. All prefixes must be previously declared as an XML namespace prefix on the containing Query element or ancestor elements. Local role values: Local role values are not preceded by a prefix. Local role values are associated with the OpenSearch 1.1 namespace. The following role values are identified with the OpenSearch 1.1 namespace. The list is exhaustive; only the role values listed below may appear in the OpenSearch 1.1 namespace. Role values:
aValue
- the value to set for the ROLE_PROPERTY
property.public String getSearchTerms()
searchTerms
attribute.
Contains the value representing the "searchTerms" as an OpenSearch 1.1 parameter. Restrictions: The value must be URL-encoded.
SEARCH_TERMS_PROPERTY
property.public void setSearchTerms(String aValue)
searchTerms
attribute.
Contains the value representing the "searchTerms" as an OpenSearch 1.1 parameter. Restrictions: The value must be URL-encoded.
aValue
- the value to set for the SEARCH_TERMS_PROPERTY
property.public Long getStartIndex()
startIndex
attribute.
Contains the value representing the "startIndex" as an OpenSearch 1.1 parameter. Replaced with the index of the first search result desired by the search client. Default: The value specified by the "indexOffset" attribute of the containing Url element.
START_INDEX_PROPERTY
property.public void setStartIndex(Long aValue)
startIndex
attribute.
Contains the value representing the "startIndex" as an OpenSearch 1.1 parameter. Replaced with the index of the first search result desired by the search client. Default: The value specified by the "indexOffset" attribute of the containing Url element.
aValue
- the value to set for the START_INDEX_PROPERTY
property.public Long getStartPage()
startPage
attribute.
Contains the value representing the "startPage" as an OpenSearch 1.1 parameter. Replaced with the page number of the set of search results desired by the search client. Default: The value specified by the "pageOffset" attribute of the containing Url element.
START_PAGE_PROPERTY
property.public void setStartPage(Long aValue)
startPage
attribute.
Contains the value representing the "startPage" as an OpenSearch 1.1 parameter. Replaced with the page number of the set of search results desired by the search client. Default: The value specified by the "pageOffset" attribute of the containing Url element.
aValue
- the value to set for the START_PAGE_PROPERTY
property.public String getTitle()
title
attribute.
Contains a human-readable plain text string describing the search request.
TITLE_PROPERTY
property.public void setTitle(String aValue)
title
attribute.
Contains a human-readable plain text string describing the search request.
aValue
- the value to set for the TITLE_PROPERTY
property.public Long getTotalResults()
totalResults
attribute.
Contains the expected number of results to be found if the search request were made.
TOTAL_RESULTS_PROPERTY
property.public void setTotalResults(Long aValue)
totalResults
attribute.
Contains the expected number of results to be found if the search request were made.
aValue
- the value to set for the TOTAL_RESULTS_PROPERTY
property.