TLcdOpenSearchDescription (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.datamodel.TLcdDataObject
- - com.luciad.opensearch.model.TLcdOpenSearchDescription

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable
```
public class TLcdOpenSearchDescription
extends TLcdDataObject
```
Since:

2017.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TLcdOpenSearchDescription.Image`
`static class`	`TLcdOpenSearchDescription.SyndicationRight`
`static class`	`TLcdOpenSearchDescription.Url`

Field Summary

Fields
Modifier and Type	Field and Description
`static TLcdDataProperty`	`ADULT_CONTENT_PROPERTY` Data property that maps to the `AdultContent` element.
`static TLcdDataProperty`	`ATTRIBUTION_PROPERTY` Data property that maps to the `Attribution` element.
`static TLcdDataProperty`	`CONTACT_PROPERTY` Data property that maps to the `Contact` element.
`static TLcdDataProperty`	`DESCRIPTION_PROPERTY` Data property that maps to the `Description` element.
`static TLcdDataProperty`	`DEVELOPER_PROPERTY` Data property that maps to the `Developer` element.
`static TLcdDataProperty`	`IMAGE_PROPERTY` Data property that maps to the `Image` element.
`static TLcdDataProperty`	`INPUT_ENCODING_PROPERTY` Data property that maps to the `InputEncoding` element.
`static TLcdDataProperty`	`LANGUAGE_PROPERTY` Data property that maps to the `Language` element.
`static TLcdDataProperty`	`LONG_NAME_PROPERTY` Data property that maps to the `LongName` element.
`static TLcdDataProperty`	`OUTPUT_ENCODING_PROPERTY` Data property that maps to the `OutputEncoding` element.
`static TLcdDataProperty`	`QUERY_PROPERTY` Data property that maps to the `Query` element.
`static TLcdDataProperty`	`SHORT_NAME_PROPERTY` Data property that maps to the `ShortName` element.
`static TLcdDataProperty`	`SYNDICATION_RIGHT_PROPERTY` Data property that maps to the `SyndicationRight` element.
`static TLcdDataProperty`	`TAGS_PROPERTY` Data property that maps to the `Tags` element.
`static TLcdDataProperty`	`URLS_PROPERTY` Data property that maps to the `Url` element.

Constructor Summary

Constructors
Constructor and Description

TLcdOpenSearchDescription()

TLcdOpenSearchDescription(TLcdDataType aType)

Constructors
Constructor and Description
`TLcdOpenSearchDescription()`
`TLcdOpenSearchDescription(TLcdDataType aType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`getAdultContent()` Returns the value of the property that maps to the `AdultContent` element.
`String`	`getAttribution()` Returns the value of the property that maps to the `Attribution` element.
`Object`	`getContact()` Returns the value of the property that maps to the `Contact` element.
`String`	`getDescription()` Returns the value of the property that maps to the `Description` element.
`String`	`getDeveloper()` Returns the value of the property that maps to the `Developer` element.
`TLcdOpenSearchDescription.Image`	`getImage()` Returns the value of the property that maps to the `Image` element.
`Object`	`getInputEncoding()` Returns the value of the property that maps to the `InputEncoding` element.
`Object`	`getLanguage()` Returns the value of the property that maps to the `Language` element.
`String`	`getLongName()` Returns the value of the property that maps to the `LongName` element.
`Object`	`getOutputEncoding()` Returns the value of the property that maps to the `OutputEncoding` element.
`TLcdOpenSearchQuery`	`getQuery()` Returns the value of the property that maps to the `Query` element.
`String`	`getShortName()` Returns the value of the property that maps to the `ShortName` element.
`TLcdOpenSearchDescription.SyndicationRight`	`getSyndicationRight()` Returns the value of the property that maps to the `SyndicationRight` element.
`String`	`getTags()` Returns the value of the property that maps to the `Tags` element.
`List<TLcdOpenSearchDescription.Url>`	`getUrls()` Returns the value of the property that maps to the `Url` element.
`void`	`setAdultContent(Object aValue)` Sets the value of the property that maps to the `AdultContent` element.
`void`	`setAttribution(String aValue)` Sets the value of the property that maps to the `Attribution` element.
`void`	`setContact(Object aValue)` Sets the value of the property that maps to the `Contact` element.
`void`	`setDescription(String aValue)` Sets the value of the property that maps to the `Description` element.
`void`	`setDeveloper(String aValue)` Sets the value of the property that maps to the `Developer` element.
`void`	`setImage(TLcdOpenSearchDescription.Image aValue)` Sets the value of the property that maps to the `Image` element.
`void`	`setInputEncoding(Object aValue)` Sets the value of the property that maps to the `InputEncoding` element.
`void`	`setLanguage(Object aValue)` Sets the value of the property that maps to the `Language` element.
`void`	`setLongName(String aValue)` Sets the value of the property that maps to the `LongName` element.
`void`	`setOutputEncoding(Object aValue)` Sets the value of the property that maps to the `OutputEncoding` element.
`void`	`setQuery(TLcdOpenSearchQuery aValue)` Sets the value of the property that maps to the `Query` element.
`void`	`setShortName(String aValue)` Sets the value of the property that maps to the `ShortName` element.
`void`	`setSyndicationRight(TLcdOpenSearchDescription.SyndicationRight aValue)` Sets the value of the property that maps to the `SyndicationRight` element.
`void`	`setTags(String aValue)` Sets the value of the property that maps to the `Tags` element.

Methods inherited from class com.luciad.datamodel.TLcdDataObject
clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SHORT_NAME_PROPERTY
```
public static final TLcdDataProperty SHORT_NAME_PROPERTY
```
    Data property that maps to the ShortName element. The possible values for this property are instances of String.
  - DESCRIPTION_PROPERTY
```
public static final TLcdDataProperty DESCRIPTION_PROPERTY
```
    Data property that maps to the Description element. The possible values for this property are instances of String.
  - URLS_PROPERTY
```
public static final TLcdDataProperty URLS_PROPERTY
```
    Data property that maps to the Url element. The possible values for this property are instances of List<Url>.
  - CONTACT_PROPERTY
```
public static final TLcdDataProperty CONTACT_PROPERTY
```
    Data property that maps to the Contact element. The possible values for this property are instances of Object.
  - TAGS_PROPERTY
```
public static final TLcdDataProperty TAGS_PROPERTY
```
    Data property that maps to the Tags element. The possible values for this property are instances of String.
  - LONG_NAME_PROPERTY
```
public static final TLcdDataProperty LONG_NAME_PROPERTY
```
    Data property that maps to the LongName element. The possible values for this property are instances of String.
  - IMAGE_PROPERTY
```
public static final TLcdDataProperty IMAGE_PROPERTY
```
    Data property that maps to the Image element. The possible values for this property are instances of Image.
  - QUERY_PROPERTY
```
public static final TLcdDataProperty QUERY_PROPERTY
```
    Data property that maps to the Query element. The possible values for this property are instances of TLcdOpenSearchQuery.
  - DEVELOPER_PROPERTY
```
public static final TLcdDataProperty DEVELOPER_PROPERTY
```
    Data property that maps to the Developer element. The possible values for this property are instances of String.
  - ATTRIBUTION_PROPERTY
```
public static final TLcdDataProperty ATTRIBUTION_PROPERTY
```
    Data property that maps to the Attribution element. The possible values for this property are instances of String.
  - SYNDICATION_RIGHT_PROPERTY
```
public static final TLcdDataProperty SYNDICATION_RIGHT_PROPERTY
```
    Data property that maps to the SyndicationRight element. The possible values for this property are instances of SyndicationRight.
  - ADULT_CONTENT_PROPERTY
```
public static final TLcdDataProperty ADULT_CONTENT_PROPERTY
```
    Data property that maps to the AdultContent element. The possible values for this property are instances of Object.
  - LANGUAGE_PROPERTY
```
public static final TLcdDataProperty LANGUAGE_PROPERTY
```
    Data property that maps to the Language element. The possible values for this property are instances of Object.
  - INPUT_ENCODING_PROPERTY
```
public static final TLcdDataProperty INPUT_ENCODING_PROPERTY
```
    Data property that maps to the InputEncoding element. The possible values for this property are instances of Object.
  - OUTPUT_ENCODING_PROPERTY
```
public static final TLcdDataProperty OUTPUT_ENCODING_PROPERTY
```
    Data property that maps to the OutputEncoding element. The possible values for this property are instances of Object.
- Constructor Detail
  - TLcdOpenSearchDescription
```
public TLcdOpenSearchDescription()
```
  - TLcdOpenSearchDescription
```
public TLcdOpenSearchDescription(TLcdDataType aType)
```
- Method Detail
  - getShortName
```
public String getShortName()
```
    Returns the value of the property that maps to the ShortName element.
    
    Returns:
    
    the value of the SHORT_NAME_PROPERTY property.
  - setShortName
```
public void setShortName(String aValue)
```
    Sets the value of the property that maps to the ShortName element.
    
    Parameters:
    
    aValue - the value to set for the SHORT_NAME_PROPERTY property.
  - getDescription
```
public String getDescription()
```
    Returns the value of the property that maps to the Description element.
    Contains a human-readable text description of the search engine.
    
    Returns:
    
    the value of the DESCRIPTION_PROPERTY property.
  - setDescription
```
public void setDescription(String aValue)
```
    Sets the value of the property that maps to the Description element.
    Contains a human-readable text description of the search engine.
    
    Parameters:
    
    aValue - the value to set for the DESCRIPTION_PROPERTY property.
  - getUrls
```
public List<TLcdOpenSearchDescription.Url> getUrls()
```
    Returns the value of the property that maps to the Url element.
    Describes an interface by which a search client can make search requests of the search engine. OpenSearch provides support for both index-based and page-based search engines. By default, both the first search result and the first page of search results are numbered "1". Search engines can use the "indexOffset" and "pageOffset" attributes to inform search clients of different starting values.
    
    Returns:
    
    the value of the URLS_PROPERTY property.
  - getContact
```
public Object getContact()
```
    Returns the value of the property that maps to the Contact element.
    Contains an email address at which the maintainer of the description document can be reached. Restrictions: The value must conform to the requirements of Section 3.4.1 "Addr-spec specification" in RFC 2822.
    
    Returns:
    
    the value of the CONTACT_PROPERTY property.
  - setContact
```
public void setContact(Object aValue)
```
    Sets the value of the property that maps to the Contact element.
    Contains an email address at which the maintainer of the description document can be reached. Restrictions: The value must conform to the requirements of Section 3.4.1 "Addr-spec specification" in RFC 2822.
    
    Parameters:
    
    aValue - the value to set for the CONTACT_PROPERTY property.
  - getTags
```
public String getTags()
```
    Returns the value of the property that maps to the Tags element.
    Contains a set of words that are used as keywords to identify and categorize this search content. Tags must be a single word and are delimited by the space character (' '). Restriction: The value must not contain HTML or other markup.
    
    Returns:
    
    the value of the TAGS_PROPERTY property.
  - setTags
```
public void setTags(String aValue)
```
    Sets the value of the property that maps to the Tags element.
    Contains a set of words that are used as keywords to identify and categorize this search content. Tags must be a single word and are delimited by the space character (' '). Restriction: The value must not contain HTML or other markup.
    
    Parameters:
    
    aValue - the value to set for the TAGS_PROPERTY property.
  - getLongName
```
public String getLongName()
```
    Returns the value of the property that maps to the LongName element.
    Contains an extended human-readable title that identifies this search engine. Search clients should use the value of the ShortName element if this element is not available. Restrictions: The value must not contain HTML or other markup.
    
    Returns:
    
    the value of the LONG_NAME_PROPERTY property.
  - setLongName
```
public void setLongName(String aValue)
```
    Sets the value of the property that maps to the LongName element.
    Contains an extended human-readable title that identifies this search engine. Search clients should use the value of the ShortName element if this element is not available. Restrictions: The value must not contain HTML or other markup.
    
    Parameters:
    
    aValue - the value to set for the LONG_NAME_PROPERTY property.
  - getImage
```
public TLcdOpenSearchDescription.Image getImage()
```
    Returns the value of the property that maps to the Image element.
    Contains a URL that identifies the location of an image that can be used in association with this search content. Image sizes are offered as a hint to the search client. The search client will chose the most appropriate image for the available space and should give preference to those listed first in the OpenSearch description document. Square aspect ratios are recommended. When possible, search engines should offer a 16x16 image of type "image/x-icon" or "image/vnd.microsoft.icon" (the Microsoft ICON format) and a 64x64 image of type "image/jpeg" or "image/png". Restrictions: The value must be a URI.
    
    Returns:
    
    the value of the IMAGE_PROPERTY property.
  - setImage
```
public void setImage(TLcdOpenSearchDescription.Image aValue)
```
    Sets the value of the property that maps to the Image element.
    Contains a URL that identifies the location of an image that can be used in association with this search content. Image sizes are offered as a hint to the search client. The search client will chose the most appropriate image for the available space and should give preference to those listed first in the OpenSearch description document. Square aspect ratios are recommended. When possible, search engines should offer a 16x16 image of type "image/x-icon" or "image/vnd.microsoft.icon" (the Microsoft ICON format) and a 64x64 image of type "image/jpeg" or "image/png". Restrictions: The value must be a URI.
    
    Parameters:
    
    aValue - the value to set for the IMAGE_PROPERTY property.
  - getQuery
```
public TLcdOpenSearchQuery getQuery()
```
    Returns the value of the property that maps to the Query element.
    Defines a search query that can be performed by search clients. Please see the OpenSearch Query element specification for more information. OpenSearch description documents should include at least one Query element of role="example" that is expected to return search results. Search clients may use this example query to validate that the search engine is working properly.
    
    Returns:
    
    the value of the QUERY_PROPERTY property.
  - setQuery
```
public void setQuery(TLcdOpenSearchQuery aValue)
```
    Sets the value of the property that maps to the Query element.
    Defines a search query that can be performed by search clients. Please see the OpenSearch Query element specification for more information. OpenSearch description documents should include at least one Query element of role="example" that is expected to return search results. Search clients may use this example query to validate that the search engine is working properly.
    
    Parameters:
    
    aValue - the value to set for the QUERY_PROPERTY property.
  - getDeveloper
```
public String getDeveloper()
```
    Returns the value of the property that maps to the Developer element.
    Contains the human-readable name or identifier of the creator or maintainer of the description document. The developer is the person or entity that created the description document, and may or may not be the owner, author, or copyright holder of the source of the content itself. Restrictions: The value must not contain HTML or other markup.
    
    Returns:
    
    the value of the DEVELOPER_PROPERTY property.
  - setDeveloper
```
public void setDeveloper(String aValue)
```
    Sets the value of the property that maps to the Developer element.
    Contains the human-readable name or identifier of the creator or maintainer of the description document. The developer is the person or entity that created the description document, and may or may not be the owner, author, or copyright holder of the source of the content itself. Restrictions: The value must not contain HTML or other markup.
    
    Parameters:
    
    aValue - the value to set for the DEVELOPER_PROPERTY property.
  - getAttribution
```
public String getAttribution()
```
    Returns the value of the property that maps to the Attribution element.
    Contains a list of all sources or entities that should be credited for the content contained in the search feed. Restrictions: The value must not contain HTML or other markup.
    
    Returns:
    
    the value of the ATTRIBUTION_PROPERTY property.
  - setAttribution
```
public void setAttribution(String aValue)
```
    Sets the value of the property that maps to the Attribution element.
    Contains a list of all sources or entities that should be credited for the content contained in the search feed. Restrictions: The value must not contain HTML or other markup.
    
    Parameters:
    
    aValue - the value to set for the ATTRIBUTION_PROPERTY property.
  - getSyndicationRight
```
public TLcdOpenSearchDescription.SyndicationRight getSyndicationRight()
```
    Returns the value of the property that maps to the SyndicationRight element.
    Contains a value that indicates the degree to which the search results provided by this search engine can be queried, displayed, and redistributed.
    
    Returns:
    
    the value of the SYNDICATION_RIGHT_PROPERTY property.
  - setSyndicationRight
```
public void setSyndicationRight(TLcdOpenSearchDescription.SyndicationRight aValue)
```
    Sets the value of the property that maps to the SyndicationRight element.
    Contains a value that indicates the degree to which the search results provided by this search engine can be queried, displayed, and redistributed.
    
    Parameters:
    
    aValue - the value to set for the SYNDICATION_RIGHT_PROPERTY property.
  - getAdultContent
```
public Object getAdultContent()
```
    Returns the value of the property that maps to the AdultContent element.
    Contains a boolean value that should be set to true if the search results may contain material intended only for adults. As there are no universally applicable guidelines as to what constitutes "adult" content, the search engine should make a good faith effort to indicate when there is a possibility that search results may contain material inappropriate for all audiences. The values "false", "FALSE", "0", "no", and "NO" will be considered boolean FALSE; all other strings will be considered boolean TRUE.
    
    Returns:
    
    the value of the ADULT_CONTENT_PROPERTY property.
  - setAdultContent
```
public void setAdultContent(Object aValue)
```
    Sets the value of the property that maps to the AdultContent element.
    Contains a boolean value that should be set to true if the search results may contain material intended only for adults. As there are no universally applicable guidelines as to what constitutes "adult" content, the search engine should make a good faith effort to indicate when there is a possibility that search results may contain material inappropriate for all audiences. The values "false", "FALSE", "0", "no", and "NO" will be considered boolean FALSE; all other strings will be considered boolean TRUE.
    
    Parameters:
    
    aValue - the value to set for the ADULT_CONTENT_PROPERTY property.
  - getLanguage
```
public Object getLanguage()
```
    Returns the value of the property that maps to the Language element.
    Contains a string that indicates that the search engine supports 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, the value of "*" will signify that the search engine does not restrict search results to any particular language.
    
    Returns:
    
    the value of the LANGUAGE_PROPERTY property.
  - setLanguage
```
public void setLanguage(Object aValue)
```
    Sets the value of the property that maps to the Language element.
    Contains a string that indicates that the search engine supports 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, the value of "*" will signify that the search engine does not restrict search results to any particular language.
    
    Parameters:
    
    aValue - the value to set for the LANGUAGE_PROPERTY property.
  - getInputEncoding
```
public Object getInputEncoding()
```
    Returns the value of the property that maps to the InputEncoding element.
    Contains a string that indicates that the search engine supports search requests 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.
    
    Returns:
    
    the value of the INPUT_ENCODING_PROPERTY property.
  - setInputEncoding
```
public void setInputEncoding(Object aValue)
```
    Sets the value of the property that maps to the InputEncoding element.
    Contains a string that indicates that the search engine supports search requests 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.
    
    Parameters:
    
    aValue - the value to set for the INPUT_ENCODING_PROPERTY property.
  - getOutputEncoding
```
public Object getOutputEncoding()
```
    Returns the value of the property that maps to the OutputEncoding element.
    Contains a string that indicates that the search engine supports search responses encoded 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.
    
    Returns:
    
    the value of the OUTPUT_ENCODING_PROPERTY property.
  - setOutputEncoding
```
public void setOutputEncoding(Object aValue)
```
    Sets the value of the property that maps to the OutputEncoding element.
    Contains a string that indicates that the search engine supports search responses encoded 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.
    
    Parameters:
    
    aValue - the value to set for the OUTPUT_ENCODING_PROPERTY property.

LuciadLightspeedClass TLcdOpenSearchDescription

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Field Detail

SHORT_NAME_PROPERTY

DESCRIPTION_PROPERTY

URLS_PROPERTY

CONTACT_PROPERTY

TAGS_PROPERTY

LONG_NAME_PROPERTY

IMAGE_PROPERTY

QUERY_PROPERTY

DEVELOPER_PROPERTY

ATTRIBUTION_PROPERTY

SYNDICATION_RIGHT_PROPERTY

ADULT_CONTENT_PROPERTY

LANGUAGE_PROPERTY

INPUT_ENCODING_PROPERTY

OUTPUT_ENCODING_PROPERTY

Constructor Detail

TLcdOpenSearchDescription

TLcdOpenSearchDescription

Method Detail

getShortName

setShortName

getDescription

setDescription

getUrls

getContact

setContact

getTags

setTags

getLongName

setLongName

getImage

setImage

getQuery

setQuery

getDeveloper

setDeveloper

getAttribution

setAttribution

getSyndicationRight

setSyndicationRight

getAdultContent

setAdultContent

getLanguage

setLanguage

getInputEncoding

setInputEncoding

getOutputEncoding

setOutputEncoding