com.luciad.opensearch.model

LuciadLightspeedClass TLcdOpenSearchDescription.Url

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.opensearch.model.TLcdOpenSearchDescription.Url

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

Enclosing class:

TLcdOpenSearchDescription

public static class TLcdOpenSearchDescription.Url
extends TLcdDataObject

Since:

2017.0

Field Summary

Fields

Modifier and Type	Field and Description
static TLcdDataProperty	INDEX_OFFSET_PROPERTY Data property that maps to the indexOffset attribute.
static TLcdDataProperty	PAGE_OFFSET_PROPERTY Data property that maps to the pageOffset attribute.
static TLcdDataProperty	TEMPLATE_PROPERTY Data property that maps to the template attribute.
static TLcdDataProperty	TYPE_PROPERTY Data property that maps to the type attribute.

Constructor Summary

Constructors

Constructor and Description
Url()
Url(TLcdDataType aType)

Method Summary

Modifier and Type	Method and Description
long	getIndexOffset() Returns the value of the property that maps to the indexOffset attribute.
long	getPageOffset() Returns the value of the property that maps to the pageOffset attribute.
String	getTemplate() Returns the value of the property that maps to the template attribute.
String	getType() Returns the value of the property that maps to the type attribute.
void	setIndexOffset(long aValue) Sets the value of the property that maps to the indexOffset attribute.
void	setPageOffset(long aValue) Sets the value of the property that maps to the pageOffset attribute.
void	setTemplate(String aValue) Sets the value of the property that maps to the template attribute.
void	setType(String aValue) Sets the value of the property that maps to the type attribute.

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

INDEX_OFFSET_PROPERTY

public static final TLcdDataProperty INDEX_OFFSET_PROPERTY

Data property that maps to the indexOffset attribute. The possible values for this property are instances of long.

PAGE_OFFSET_PROPERTY

public static final TLcdDataProperty PAGE_OFFSET_PROPERTY

Data property that maps to the pageOffset attribute. The possible values for this property are instances of long.

TEMPLATE_PROPERTY

public static final TLcdDataProperty TEMPLATE_PROPERTY

Data property that maps to the template attribute. The possible values for this property are instances of String.

TYPE_PROPERTY

public static final TLcdDataProperty TYPE_PROPERTY

Data property that maps to the type attribute. The possible values for this property are the public QName constants defined in this class.

Constructor Detail

Url

public Url()

Url

public Url(TLcdDataType aType)

Method Detail

getIndexOffset

public long getIndexOffset()

Returns the value of the property that maps to the indexOffset attribute.

Contains the index number of the first search result.

Returns:

the value of the INDEX_OFFSET_PROPERTY property.

setIndexOffset

public void setIndexOffset(long aValue)

Sets the value of the property that maps to the indexOffset attribute.

Contains the index number of the first search result.

Parameters:

aValue - the value to set for the INDEX_OFFSET_PROPERTY property.

getPageOffset

public long getPageOffset()

Returns the value of the property that maps to the pageOffset attribute.

Contains the page number of the first set of search results.

Returns:

the value of the PAGE_OFFSET_PROPERTY property.

setPageOffset

public void setPageOffset(long aValue)

Sets the value of the property that maps to the pageOffset attribute.

Contains the page number of the first set of search results.

Parameters:

aValue - the value to set for the PAGE_OFFSET_PROPERTY property.

getTemplate

public String getTemplate()

Returns the value of the property that maps to the template attribute.

Contains the search URL template to be processed according to the OpenSearch URL template syntax.

Returns:

the value of the TEMPLATE_PROPERTY property.

setTemplate

public void setTemplate(String aValue)

Sets the value of the property that maps to the template attribute.

Contains the search URL template to be processed according to the OpenSearch URL template syntax.

Parameters:

aValue - the value to set for the TEMPLATE_PROPERTY property.

getType

public String getType()

Returns the value of the property that maps to the type attribute.

The possible values for this property are the public QName constants defined in this class.

Contains the MIME type of the search result format. Restrictions: The value must be a valid MIME type.

Returns:

the value of the TYPE_PROPERTY property.

setType

public void setType(String aValue)

Sets the value of the property that maps to the type attribute.

The possible values for this property are the public QName constants defined in this class.

Contains the MIME type of the search result format. Restrictions: The value must be a valid MIME type.

Parameters:

aValue - the value to set for the TYPE_PROPERTY property.