de.geeksfactory.opacclient.objects

Class DetailledItem

java.lang.Object

de.geeksfactory.opacclient.objects.DetailledItem

All Implemented Interfaces:

CoverHolder

public class DetailledItem
extends java.lang.Object
implements CoverHolder

Object representing all details of a media item

Constructor Summary

Constructors

Constructor and Description
DetailledItem()

Method Summary

Modifier and Type	Method and Description
void	addCopy(Copy copy) Add a copy.
void	addDetail(Detail detail) Add a detail
void	addVolume(Volume child) Add a child item.
java.lang.String	getBooking_info()
java.lang.String	getCollectionId() Get the ID of the item which is a collection containing this item as a child item
java.util.List<Copy>	getCopies() List of copies of this item available
java.lang.String	getCover() Get cover image URL
byte[]	getCoverBitmap() Get cover image bitmap
java.util.List<Detail>	getDetails() Set details (like author, summary, …).
java.lang.String	getId() Get unique media identifier
SearchResult.MediaType	getMediaType()
java.lang.String	getReservation_info() Get extra information stored to be returned to your OpacApi.reservation(DetailledItem, Account, int, String) implementation.
java.lang.String	getTitle() Get media title
java.util.List<Volume>	getVolumes() List of child items (e.g. volumes of a series) available
java.util.Map<java.lang.String,java.lang.String>	getVolumesearch() Can return a OpacApi.search(List) query List for a volume search based on this item.
boolean	isBookable()
boolean	isReservable() Returns whether it is possible to order this item through the app
void	setBookable(boolean bookable)
void	setBooking_info(java.lang.String booking_info)
void	setCollectionId(java.lang.String collectionid) Sets the ID of the item which is a collection containing this item as a child item
void	setCopies(java.util.List<Copy> copies) Set list of copies of this item available
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 unique media identifier
void	setMediaType(SearchResult.MediaType mediaType)
void	setReservable(boolean reservable) Specifies whether it is possible to order this item through the app
void	setReservation_info(java.lang.String reservation_info) Set extra information stored to be returned to your OpacApi.reservation(DetailledItem, Account, int, String) implementation.
void	setTitle(java.lang.String title) Set media title
void	setVolumesearch(java.util.Map<java.lang.String,java.lang.String> volumesearch) Sets a search query which is passed back to your OpacApi.search(List) implementation for a volume search based on this item-
java.lang.String	toString() Returns all data stored in this object, serialized as a human-readable string.

Methods inherited from class java.lang.Object

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

Constructor Detail

DetailledItem

public DetailledItem()

Method Detail

getId

public java.lang.String getId()

Get unique media identifier

Returns:

media ID

setId

public void setId(java.lang.String id)

Set unique media identifier

Parameters:

id - media ID

getTitle

public java.lang.String getTitle()

Get media title

setTitle

public void setTitle(java.lang.String title)

Set media title

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

toString

public java.lang.String toString()

Returns all data stored in this object, serialized as a human-readable string.

Overrides:

toString in class java.lang.Object

getDetails

public java.util.List<Detail> getDetails()

Set details (like author, summary, …).

Returns:

List of Details

See Also:

Detail

getCopies

public java.util.List<Copy> getCopies()

List of copies of this item available

Returns:

List of copies

See Also:

addCopy(Copy)

setCopies

public void setCopies(java.util.List<Copy> copies)

Set list of copies of this item available

Parameters:

copies - List of copies

See Also:

addCopy(Copy)

getVolumes

public java.util.List<Volume> getVolumes()

List of child items (e.g. volumes of a series) available

Returns:

List of child items available

See Also:

addVolume(Volume)

addDetail

public void addDetail(Detail detail)

Add a detail

See Also:

Detail

addCopy

public void addCopy(Copy copy)

Add a copy.

Parameters:

copy - An object representing a copy

See Also:

Detail

addVolume

public void addVolume(Volume child)

Add a child item.

getVolumesearch

public java.util.Map<java.lang.String,java.lang.String> getVolumesearch()

Can return a OpacApi.search(List) query List for a volume search based on this item.

Returns:

Search query or null if not applicable

See Also:

Detail

setVolumesearch

public void setVolumesearch(java.util.Map<java.lang.String,java.lang.String> volumesearch)

Sets a search query which is passed back to your OpacApi.search(List) implementation for a volume search based on this item-

Parameters:

volumesearch - Search query

isReservable

public boolean isReservable()

Returns whether it is possible to order this item through the app

Returns:

true if possible, false otherwise.

setReservable

public void setReservable(boolean reservable)

Specifies whether it is possible to order this item through the app

getReservation_info

public java.lang.String getReservation_info()

Get extra information stored to be returned to your OpacApi.reservation(DetailledItem, Account, int, String) implementation.

Returns:

Some custom information.

setReservation_info

public void setReservation_info(java.lang.String reservation_info)

Set extra information stored to be returned to your OpacApi.reservation(DetailledItem, Account, int, String) implementation.

Parameters:

reservation_info - Some custom information.

isBookable

public boolean isBookable()

Returns:

the bookable

setBookable

public void setBookable(boolean bookable)

Parameters:

bookable - Some custom information.

getBooking_info

public java.lang.String getBooking_info()

Returns:

the booking_info

setBooking_info

public void setBooking_info(java.lang.String booking_info)

Parameters:

booking_info - Some custom information.

getCollectionId

public java.lang.String getCollectionId()

Get the ID of the item which is a collection containing this item as a child item

Since:

2.0.17

setCollectionId

public void setCollectionId(java.lang.String collectionid)

Sets the ID of the item which is a collection containing this item as a child item

Parameters:

collectionid - the collectionid to set

Since:

2.0.17

getMediaType

public SearchResult.MediaType getMediaType()

Returns:

this item's media type

setMediaType

public void setMediaType(SearchResult.MediaType mediaType)

Parameters:

mediaType - the media type to set