de.geeksfactory.opacclient.objects

Class AccountItem

java.lang.Object

de.geeksfactory.opacclient.objects.AccountItem

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

LentItem, ReservedItem

public abstract class AccountItem
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	account
protected java.lang.String	author
protected java.lang.String	cover
protected java.lang.Long	dbId
protected java.lang.String	format
protected java.lang.String	id
protected SearchResult.MediaType	mediaType
protected java.lang.String	status
protected java.lang.String	title

Constructor Summary

Constructors

Constructor and Description
AccountItem()

Method Summary

Modifier and Type	Method and Description
long	getAccount()
java.lang.String	getAuthor()
java.lang.String	getCover()
java.lang.Long	getDbId()
java.lang.String	getFormat()
java.lang.String	getId()
SearchResult.MediaType	getMediaType()
java.lang.String	getStatus()
java.lang.String	getTitle()
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	setAccount(long account) Set the ID of the account this item is associated with.
void	setAuthor(java.lang.String author) Set author.
void	setCover(java.lang.String cover) Set a cover URL for this item.
void	setDbId(java.lang.Long dbId) Set ID for this item in the local account database.
void	setFormat(java.lang.String format) Set item format.
void	setId(java.lang.String id) Set media ID to open detail page, if possible.
void	setMediaType(SearchResult.MediaType mediaType) Set the media type of this item.
void	setStatus(java.lang.String status) Set status of an item.
void	setTitle(java.lang.String title) Set title.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

account

protected long account

title

protected java.lang.String title

author

protected java.lang.String author

format

protected java.lang.String format

mediaType

protected SearchResult.MediaType mediaType

id

protected java.lang.String id

status

protected java.lang.String status

dbId

protected java.lang.Long dbId

cover

protected java.lang.String cover

Constructor Detail

AccountItem

public AccountItem()

Method Detail

getAccount

public long getAccount()

Returns:

The ID of the account this item is associated with

setAccount

public void setAccount(long account)

Set the ID of the account this item is associated with. Does not need to be set by the API implementation.

getTitle

public java.lang.String getTitle()

Returns:

The Title of this item

setTitle

public void setTitle(java.lang.String title)

Set title.

getAuthor

public java.lang.String getAuthor()

Returns:

The author of this item. Optional.

setAuthor

public void setAuthor(java.lang.String author)

Set author. Optional.

getFormat

public java.lang.String getFormat()

Returns:

The format of this item. Optional.

setFormat

public void setFormat(java.lang.String format)

Set item format. Optional. Use this if the OPAC shows a string representation of the item format. If you can recognize the media type, use setMediaType(SearchResult.MediaType) instead.

getMediaType

public SearchResult.MediaType getMediaType()

Returns:

The media type of this item. Optional.

setMediaType

public void setMediaType(SearchResult.MediaType mediaType)

Set the media type of this item. Optional.

getId

public java.lang.String getId()

Returns:

media ID to open detail page, if possible.

setId

public void setId(java.lang.String id)

Set media ID to open detail page, if possible.

getStatus

public java.lang.String getStatus()

Returns:

status of an item. Some libraries use codes like "E" for "first lending period", "1" for "lending period extended once", etc. Optional.

setStatus

public void setStatus(java.lang.String status)

Set status of an item. Some libraries use codes like "E" for "first lending period", "1" for "lending period extended once", etc. Optional.

getDbId

public java.lang.Long getDbId()

Returns:

ID for this item in the local account database. Is only available when it was retreived from the database.

setDbId

public void setDbId(java.lang.Long dbId)

Set ID for this item in the local account database. Must not be set by the API implementation.

getCover

public java.lang.String getCover()

Returns:

A cover URL for this item. Optional.

setCover

public void setCover(java.lang.String cover)

Set a cover URL for this item. Optional.

set

public 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

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".

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object