de.geeksfactory.opacclient.objects

Class SearchResult

java.lang.Object

de.geeksfactory.opacclient.objects.SearchResult

All Implemented Interfaces:

CoverHolder

public class SearchResult
extends java.lang.Object
implements CoverHolder

Object representing a search result

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchResult.MediaType Supported media types.
static class	SearchResult.Status Media status, simplified like a traffic light, e.g. red for "lent out, no reservation possible", yellow for "reservation needed" or green for "available".

Constructor Summary

Constructors

Constructor and Description
SearchResult() Create an empty object
SearchResult(SearchResult.MediaType type, int nr, java.lang.String innerhtml) Create a new SearchResult object

Method Summary

Modifier and Type	Method and Description
java.util.List<SearchQuery>	getChildQuery() Get the child query (see setChildQuery for details)
java.lang.String	getCover() Get cover image URL
byte[]	getCoverBitmap() Get cover image bitmap
java.lang.String	getId() Get the unique identifier of this object
java.lang.String	getInnerhtml() Get HTML describing the item to the user in a result list.
int	getNr() Get this item's position in result list
int	getPage() Get the page this result was found on
SearchResult.Status	getStatus() Get item status (if known)
SearchResult.MediaType	getType() Get this item's media type.
void	setChildQuery(java.util.List<SearchQuery> childQuery) Set the child query.
void	setCover(java.lang.String cover) Set cover image URL
void	setCoverBitmap(byte[] coverBitmap) Set cover image bitmap
void	setId(java.lang.String id) Set the unique identifier of this object
void	setInnerhtml(java.lang.String innerhtml) Set HTML describing the item to the user in a result list.
void	setNr(int nr) Set this item's position in result list
void	setPage(int page) Set the page this result was found on
void	setStatus(SearchResult.Status status) Set item status (if known)
void	setType(SearchResult.MediaType type) Set this item's media type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchResult

public SearchResult(SearchResult.MediaType type,
                    int nr,
                    java.lang.String innerhtml)

Create a new SearchResult object

Parameters:

type - media type (like "BOOK")

nr - Position in result list

innerhtml - HTML to display

SearchResult

public SearchResult()

Create an empty object

Method Detail

getId

public java.lang.String getId()

Get the unique identifier of this object

Returns:

ID or null if unknown

setId

public void setId(java.lang.String id)

Set the unique identifier of this object

Parameters:

id - unique identifier

getType

public SearchResult.MediaType getType()

Get this item's media type.

Returns:

Media type or null if unknown

setType

public void setType(SearchResult.MediaType type)

Set this item's media type.

Parameters:

type - Media type

getNr

public int getNr()

Get this item's position in result list

Returns:

position

setNr

public void setNr(int nr)

Set this item's position in result list

Parameters:

nr - position

getInnerhtml

public java.lang.String getInnerhtml()

Get HTML describing the item to the user in a result list.

Returns:

position

setInnerhtml

public void setInnerhtml(java.lang.String innerhtml)

Set HTML describing the item to the user in a result list. Only "simple" HTML like <b>, <i>, etc. can be used.

Parameters:

innerhtml - simple HTML code

getStatus

public SearchResult.Status getStatus()

Get item status (if known)

Returns:

Status or null if not set.

Since:

2.0.7

setStatus

public void setStatus(SearchResult.Status status)

Set item status (if known)

Since:

2.0.7

getPage

public int getPage()

Get the page this result was found on

setPage

public void setPage(int page)

Set the page this result was found on

getCoverBitmap

public byte[] getCoverBitmap()

Get cover image bitmap

Specified by:

getCoverBitmap in interface CoverHolder

setCoverBitmap

public void setCoverBitmap(byte[] coverBitmap)

Set cover image bitmap

Specified by:

setCoverBitmap in interface CoverHolder

getCover

public java.lang.String getCover()

Get cover image URL

Specified by:

getCover in interface CoverHolder

setCover

public void setCover(java.lang.String cover)

Set cover image URL

Specified by:

setCover in interface CoverHolder

getChildQuery

public java.util.List<SearchQuery> getChildQuery()

Get the child query (see setChildQuery for details)

setChildQuery

public void setChildQuery(java.util.List<SearchQuery> childQuery)

Set the child query. If this is set, clicking the item in the UI will not open a detail page, but start another search.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object