de.geeksfactory.opacclient.objects

Class Copy

java.lang.Object

de.geeksfactory.opacclient.objects.Copy

public class Copy
extends java.lang.Object

Represents a copy of a medium (DetailledItem) available in a library.

Constructor Summary

Constructors

Constructor and Description
Copy()

Method Summary

Modifier and Type	Method and Description
java.lang.String	get(java.lang.String key) Get property using the following keys: barcode, location, department, branch, status, returndate, reservations, signature, resinfo, url Dates will be returned in ISO-8601 format (yyyy-MM-dd).
java.lang.String	getBarcode()
java.lang.String	getBranch()
java.lang.String	getDepartment()
java.lang.String	getLocation()
java.lang.String	getReservations()
java.lang.String	getResInfo()
org.joda.time.LocalDate	getReturnDate()
java.lang.String	getShelfmark()
java.lang.String	getStatus()
java.lang.String	getUrl()
boolean	notEmpty()
void	set(java.lang.String key, java.lang.String value) Set property using the following keys: barcode, location, department, branch, status, returndate, reservations, signature, resinfo, url If you supply an invalid key, an IllegalArgumentException will be thrown.
void	set(java.lang.String key, java.lang.String value, org.joda.time.format.DateTimeFormatter fmt) Set property using the following keys: barcode, location, department, branch, status, returndate, reservations, signature, resinfo, url For "returndate", the given DateTimeFormatter will be used to parse the date.
void	setBarcode(java.lang.String barcode)
void	setBranch(java.lang.String branch)
void	setDepartment(java.lang.String department)
void	setLocation(java.lang.String location)
void	setReservations(java.lang.String reservations)
void	setResInfo(java.lang.String resInfo)
void	setReturnDate(org.joda.time.LocalDate returndate)
void	setShelfmark(java.lang.String shelfmark)
void	setStatus(java.lang.String status)
void	setUrl(java.lang.String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

Copy

public Copy()

Method Detail

getBarcode

public java.lang.String getBarcode()

Returns:

The barcode of a copy. Optional.

setBarcode

public void setBarcode(java.lang.String barcode)

Parameters:

barcode - The barcode of a copy. Optional.

getLocation

public java.lang.String getLocation()

Returns:

The location (like "third floor") of a copy. Optional.

setLocation

public void setLocation(java.lang.String location)

Parameters:

location - The location (like "third floor") of a copy. Optional.

getDepartment

public java.lang.String getDepartment()

Returns:

The department (like "music library") of a copy. Optional.

setDepartment

public void setDepartment(java.lang.String department)

Parameters:

department - The department (like "music library") of a copy. Optional.

getBranch

public java.lang.String getBranch()

Returns:

The branch a copy is in. Should be set, if your library has more than one branch.

setBranch

public void setBranch(java.lang.String branch)

Parameters:

branch - The branch a copy is in. Should be set, if your library has more than one branch.

getStatus

public java.lang.String getStatus()

Returns:

Current status of a copy ("lent", "free", ...). Should be set.

setStatus

public void setStatus(java.lang.String status)

Parameters:

status - Current status of a copy ("lent", "free", ...). Should be set.

getReturnDate

public org.joda.time.LocalDate getReturnDate()

Returns:

Expected date of return if a copy is lent out. Optional.

setReturnDate

public void setReturnDate(org.joda.time.LocalDate returndate)

Parameters:

returndate - Expected date of return if a copy is lent out. Optional.

getReservations

public java.lang.String getReservations()

Returns:

Number of pending reservations if a copy is currently lent out. Optional.

setReservations

public void setReservations(java.lang.String reservations)

Parameters:

reservations - Number of pending reservations if a copy is currently lent out. Optional.

getShelfmark

public java.lang.String getShelfmark()

Returns:

Identification in the libraries' shelf system. Optional.

setShelfmark

public void setShelfmark(java.lang.String shelfmark)

Parameters:

shelfmark - Identification in the libraries' shelf system. Optional.

getResInfo

public java.lang.String getResInfo()

Returns:

Reservation information for copy-based reservations. Intended for use in your OpacApi.reservation(DetailledItem, Account, int, String) implementation.

setResInfo

public void setResInfo(java.lang.String resInfo)

Parameters:

resInfo - Reservation information for copy-based reservations. Intended for use in your (DetailledItem, Account, int, String) implementation.

getUrl

public java.lang.String getUrl()

Returns:

URL to an online copy

setUrl

public void setUrl(java.lang.String url)

Parameters:

url - URL to an online copy

set

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

Set property using the following keys: barcode, location, department, branch, status, returndate, reservations, signature, resinfo, url If you supply an invalid key, an IllegalArgumentException will be thrown. This method is used to simplify refactoring of old APIs from the Map<String, String> data structure to this class. If you are creating a new API, you probably don't need to use it.

Parameters:

key - one of the keys mentioned above

value - the value to set. Dates must be in ISO-8601 format (yyyy-MM-dd).

set

public void set(java.lang.String key,
                java.lang.String value,
                org.joda.time.format.DateTimeFormatter fmt)

Set property using the following keys: barcode, location, department, branch, status, returndate, reservations, signature, resinfo, url For "returndate", the given DateTimeFormatter will be used to parse the date. If you supply an invalid key, an IllegalArgumentException will be thrown. This method is used to simplify refactoring of old APIs from the Map<String, String> data structure to this class. If you are creating a new API, you probably don't need to use it.

Parameters:

key - one of the keys mentioned above

value - the value to set. Dates must be in a format parseable by the given DateTimeFormatter, otherwise an IllegalArgumentException will be thrown.

fmt - the DateTimeFormatter to use for parsing dates

get

public java.lang.String get(java.lang.String key)

Get property using the following keys: barcode, location, department, branch, status, returndate, reservations, signature, resinfo, url Dates will be returned in ISO-8601 format (yyyy-MM-dd). If you supply an invalid key, an IllegalArgumentException will be thrown. This method is used to simplify refactoring of old APIs from the Map<String, String> data structure to this class. If you are creating a new API, you probably don't need to use it.

Parameters:

key - one of the keys mentioned above

notEmpty

public boolean notEmpty()

Returns:

boolean value indicating if this copy contains any data or not.