magoffin.matt.ma2.domain
Interface SearchResults

public interface SearchResults

Search results object. Java content class for search-results complex type.

The following schema fragment specifies the expected content contained within this java content object. (defined at file:/Volumes/Renton/Users/matt/ws/ws-home/matte/hyperjaxb2-build/src/main/resources/core.xsd line 215)

 <complexType name="search-results">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="pagination" type="{http://msqr.us/xsd/matte}pagination-criteria"/>
         <element name="index" type="{http://msqr.us/xsd/matte}pagination-index" minOccurs="0"/>
         <element name="album" type="{http://msqr.us/xsd/matte}album-search-result" maxOccurs="unbounded" minOccurs="0"/>
         <element name="item" type="{http://msqr.us/xsd/matte}media-item-search-result" maxOccurs="unbounded" minOccurs="0"/>
         <element name="user" type="{http://msqr.us/xsd/matte}user-search-result" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="is-partial-result" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="returned-results" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger" />
       <attribute name="search-time" type="{http://www.w3.org/2001/XMLSchema}long" />
       <attribute name="total-results" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger" />
     </restriction>
   </complexContent>
 </complexType>
 

Method Summary

java.util.List	getAlbum() Gets the value of the Album property.
PaginationIndex	getIndex() Gets the value of the index property.
java.util.List	getItem() Gets the value of the Item property.
PaginationCriteria	getPagination() Gets the value of the pagination property.
java.lang.Long	getReturnedResults() Gets the value of the returnedResults property.
java.lang.Long	getSearchTime() Gets the value of the searchTime property.
java.lang.Long	getTotalResults() Gets the value of the totalResults property.
java.util.List	getUser() Gets the value of the User property.
boolean	isIsPartialResult() Gets the value of the isPartialResult property.
void	setIndex(PaginationIndex value) Sets the value of the index property.
void	setIsPartialResult(boolean value) Sets the value of the isPartialResult property.
void	setPagination(PaginationCriteria value) Sets the value of the pagination property.
void	setReturnedResults(java.lang.Long value) Sets the value of the returnedResults property.
void	setSearchTime(java.lang.Long value) Sets the value of the searchTime property.
void	setTotalResults(java.lang.Long value) Sets the value of the totalResults property.

Method Detail

getAlbum

java.util.List getAlbum()

Gets the value of the Album property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the Album property.

For example, to add a new item, do as follows:

    getAlbum().add(newItem);
 

Objects of the following type(s) are allowed in the list AlbumSearchResult

getIndex

PaginationIndex getIndex()

Gets the value of the index property.

Returns:

possible object is PaginationIndex

setIndex

void setIndex(PaginationIndex value)

Sets the value of the index property.

Parameters:

value - allowed object is PaginationIndex

getPagination

PaginationCriteria getPagination()

Gets the value of the pagination property.

Returns:

possible object is PaginationCriteria

setPagination

void setPagination(PaginationCriteria value)

Sets the value of the pagination property.

Parameters:

value - allowed object is PaginationCriteria

getTotalResults

java.lang.Long getTotalResults()

Gets the value of the totalResults property.

Returns:

possible object is Long

setTotalResults

void setTotalResults(java.lang.Long value)

Sets the value of the totalResults property.

Parameters:

value - allowed object is Long

isIsPartialResult

boolean isIsPartialResult()

Gets the value of the isPartialResult property.

setIsPartialResult

void setIsPartialResult(boolean value)

Sets the value of the isPartialResult property.

getItem

java.util.List getItem()

Gets the value of the Item property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the Item property.

For example, to add a new item, do as follows:

    getItem().add(newItem);
 

Objects of the following type(s) are allowed in the list MediaItemSearchResult

getUser

java.util.List getUser()

Gets the value of the User property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the User property.

For example, to add a new item, do as follows:

    getUser().add(newItem);
 

Objects of the following type(s) are allowed in the list UserSearchResult

getReturnedResults

java.lang.Long getReturnedResults()

Gets the value of the returnedResults property.

Returns:

possible object is Long

setReturnedResults

void setReturnedResults(java.lang.Long value)

Sets the value of the returnedResults property.

Parameters:

value - allowed object is Long

getSearchTime

java.lang.Long getSearchTime()

Gets the value of the searchTime property.

Returns:

possible object is Long

setSearchTime

void setSearchTime(java.lang.Long value)

Sets the value of the searchTime property.

Parameters:

value - allowed object is Long