public static class TLcdOpenSearchDescription.Url extends TLcdDataObject
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 and Description |
---|
Url() |
Url(TLcdDataType aType) |
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. |
public static final TLcdDataProperty INDEX_OFFSET_PROPERTY
indexOffset
attribute.
The possible values for this property are instances of long
.public static final TLcdDataProperty PAGE_OFFSET_PROPERTY
pageOffset
attribute.
The possible values for this property are instances of long
.public static final TLcdDataProperty TEMPLATE_PROPERTY
template
attribute.
The possible values for this property are instances of String
.public static final TLcdDataProperty TYPE_PROPERTY
type
attribute.
The possible values for this property are the public QName
constants defined in this class.public Url()
public Url(TLcdDataType aType)
public long getIndexOffset()
indexOffset
attribute.
Contains the index number of the first search result.
INDEX_OFFSET_PROPERTY
property.public void setIndexOffset(long aValue)
indexOffset
attribute.
Contains the index number of the first search result.
aValue
- the value to set for the INDEX_OFFSET_PROPERTY
property.public long getPageOffset()
pageOffset
attribute.
Contains the page number of the first set of search results.
PAGE_OFFSET_PROPERTY
property.public void setPageOffset(long aValue)
pageOffset
attribute.
Contains the page number of the first set of search results.
aValue
- the value to set for the PAGE_OFFSET_PROPERTY
property.public String getTemplate()
template
attribute.
Contains the search URL template to be processed according to the OpenSearch URL template syntax.
TEMPLATE_PROPERTY
property.public void setTemplate(String aValue)
template
attribute.
Contains the search URL template to be processed according to the OpenSearch URL template syntax.
aValue
- the value to set for the TEMPLATE_PROPERTY
property.public String getType()
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.
TYPE_PROPERTY
property.public void setType(String aValue)
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.
aValue
- the value to set for the TYPE_PROPERTY
property.