Class TLcdOpenSearchDescription.Url
- All Implemented Interfaces:
ILcdDataObject
,ILcdCloneable
,ILcdDeepCloneable
,Cloneable
- Enclosing class:
TLcdOpenSearchDescription
- Since:
- 2017.0
-
Field Summary
Modifier and TypeFieldDescriptionstatic final TLcdDataProperty
Data property that maps to theindexOffset
attribute.static final TLcdDataProperty
Data property that maps to thepageOffset
attribute.static final TLcdDataProperty
Data property that maps to thetemplate
attribute.static final TLcdDataProperty
Data property that maps to thetype
attribute. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionlong
Returns the value of the property that maps to theindexOffset
attribute.long
Returns the value of the property that maps to thepageOffset
attribute.Returns the value of the property that maps to thetemplate
attribute.getType()
Returns the value of the property that maps to thetype
attribute.void
setIndexOffset
(long aValue) Sets the value of the property that maps to theindexOffset
attribute.void
setPageOffset
(long aValue) Sets the value of the property that maps to thepageOffset
attribute.void
setTemplate
(String aValue) Sets the value of the property that maps to thetemplate
attribute.void
Sets the value of the property that maps to thetype
attribute.
-
Field Details
-
INDEX_OFFSET_PROPERTY
Data property that maps to theindexOffset
attribute. The possible values for this property are instances oflong
. -
PAGE_OFFSET_PROPERTY
Data property that maps to thepageOffset
attribute. The possible values for this property are instances oflong
. -
TEMPLATE_PROPERTY
Data property that maps to thetemplate
attribute. The possible values for this property are instances ofString
. -
TYPE_PROPERTY
Data property that maps to thetype
attribute. The possible values for this property are the publicQName
constants defined in this class.
-
-
Constructor Details
-
Url
public Url() -
Url
-
-
Method Details
-
getIndexOffset
public long getIndexOffset()Returns the value of the property that maps to theindexOffset
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 theindexOffset
attribute.Contains the index number of the first search result.
- Parameters:
aValue
- the value to set for theINDEX_OFFSET_PROPERTY
property.
-
getPageOffset
public long getPageOffset()Returns the value of the property that maps to thepageOffset
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 thepageOffset
attribute.Contains the page number of the first set of search results.
- Parameters:
aValue
- the value to set for thePAGE_OFFSET_PROPERTY
property.
-
getTemplate
Returns the value of the property that maps to thetemplate
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
Sets the value of the property that maps to thetemplate
attribute.Contains the search URL template to be processed according to the OpenSearch URL template syntax.
- Parameters:
aValue
- the value to set for theTEMPLATE_PROPERTY
property.
-
getType
Returns the value of the property that maps to thetype
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
Sets the value of the property that maps to thetype
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 theTYPE_PROPERTY
property.
-