de.geeksfactory.opacclient.objects

Class ReservedItem

java.lang.Object

de.geeksfactory.opacclient.objects.AccountItem

de.geeksfactory.opacclient.objects.ReservedItem

public class ReservedItem
extends AccountItem

Constructor Summary

Constructors

Constructor and Description
ReservedItem()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBookingData()
java.lang.String	getBranch()
java.lang.String	getCancelData()
org.joda.time.LocalDate	getExpirationDate()
org.joda.time.LocalDate	getReadyDate()
void	set(java.lang.String key, java.lang.String value) Set property using the following keys: LentItem: barcode, returndate, homebranch, lendingbranch, prolongurl, renewable, download ReservedItem: availability, expirationdate, branch, cancelurl, bookingurl Both: title, author, format, id, status
void	setBookingData(java.lang.String bookingData) Set internal identifier which will be supplied to your .apis.EbookServiceApi#booking(DetailledItem, Account, int, String) implementation when the user wants to book the order.
void	setBranch(java.lang.String branch) Set library branch an item is ordered to.
void	setCancelData(java.lang.String cancelData) Set internal identifier which will be supplied to your .apis.OpacApi#cancel(String, Account, int, String) implementation when the user wants to cancel the order.
void	setExpirationDate(org.joda.time.LocalDate expirationDate) Set date of expiration.
void	setExpirationDate(java.lang.String expirationDate) Set date of expiration in ISO-8601 format (yyyy-MM-dd).
void	setReadyDate(org.joda.time.LocalDate readyDate) Set expected date for an ordered item to arrive.
void	setReadyDate(java.lang.String readyDate) Set expected date for an ordered item to arrive in ISO-8601 format (yyyy-MM-dd).

Methods inherited from class de.geeksfactory.opacclient.objects.AccountItem

getAccount, getAuthor, getDbId, getFormat, getId, getStatus, getTitle, setAccount, setAuthor, setDbId, setFormat, setId, setStatus, setTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

ReservedItem

public ReservedItem()

Method Detail

getReadyDate

public org.joda.time.LocalDate getReadyDate()

Returns:

Expected date for an ordered item to arrive. Optional.

setReadyDate

public void setReadyDate(java.lang.String readyDate)

Set expected date for an ordered item to arrive in ISO-8601 format (yyyy-MM-dd). Optional.

setReadyDate

public void setReadyDate(org.joda.time.LocalDate readyDate)

Set expected date for an ordered item to arrive. Optional.

getExpirationDate

public org.joda.time.LocalDate getExpirationDate()

Returns:

Date of expiration. Optional.

setExpirationDate

public void setExpirationDate(java.lang.String expirationDate)

Set date of expiration in ISO-8601 format (yyyy-MM-dd). Optional.

setExpirationDate

public void setExpirationDate(org.joda.time.LocalDate expirationDate)

Set date of expiration. Optional.

getBranch

public java.lang.String getBranch()

Returns:

Library branch an item is ordered to. Optional, but should be set if your library has multiple branches.

setBranch

public void setBranch(java.lang.String branch)

Set library branch an item is ordered to. Optional, but should be set if your library has multiple branches.

getCancelData

public java.lang.String getCancelData()

Returns:

Internal identifier which will be supplied to your OpacApi.cancel(String, Account, int, String) implementation when the user wants to cancel the order. Cancel button won't be displayed if this is not set.

setCancelData

public void setCancelData(java.lang.String cancelData)

Set internal identifier which will be supplied to your .apis.OpacApi#cancel(String, Account, int, String) implementation when the user wants to cancel the order. Cancel button won't be displayed if this is not set.

getBookingData

public java.lang.String getBookingData()

Returns:

Internal identifier which will be supplied to your EbookServiceApi.booking(DetailledItem, Account, int, String) implementation when the user wants to book the order. Booking button won't be displayed if this is not set.

setBookingData

public void setBookingData(java.lang.String bookingData)

Set internal identifier which will be supplied to your .apis.EbookServiceApi#booking(DetailledItem, Account, int, String) implementation when the user wants to book the order. Booking button won't be displayed if this is not set.

set

public void set(java.lang.String key,
                java.lang.String value)

Description copied from class: AccountItem

Set property using the following keys: LentItem: barcode, returndate, homebranch, lendingbranch, prolongurl, renewable, download ReservedItem: availability, expirationdate, branch, cancelurl, bookingurl Both: title, author, format, id, status

Overrides:

set in class AccountItem

Parameters:

key - one of the keys mentioned above

value - the value to set. Dates must be in ISO-8601 format (yyyy-MM-dd) and booleans as "Y"/"N".