de.geeksfactory.opacclient.apis

Class PicaLBS

java.lang.Object

de.geeksfactory.opacclient.apis.BaseApi

de.geeksfactory.opacclient.apis.Pica

de.geeksfactory.opacclient.apis.PicaLBS

All Implemented Interfaces:

OpacApi

public class PicaLBS
extends Pica

API for the PICA OPAC by OCLC combined with LBS account functions Tested with LBS 4 in TU Hamburg-Harburg

Nested Class Summary

Nested classes/interfaces inherited from interface de.geeksfactory.opacclient.apis.OpacApi

OpacApi.CancelResult, OpacApi.MultiStepResult, OpacApi.OpacErrorException, OpacApi.ProlongAllResult, OpacApi.ProlongResult, OpacApi.ReservationResult

Field Summary

Fields inherited from class de.geeksfactory.opacclient.apis.Pica

cookieStore, data, db, defaulttypes, https_url, languageCode, languageCodes, library, lor_reservations, opac_url, pwEncoded, resultcount, reusehtml, searchSet

Fields inherited from class de.geeksfactory.opacclient.apis.BaseApi

http_client, httpLoggingEnabled, initialised, KEY_SEARCH_QUERY_AUDIENCE, KEY_SEARCH_QUERY_AUTHOR, KEY_SEARCH_QUERY_AVAILABLE, KEY_SEARCH_QUERY_BARCODE, KEY_SEARCH_QUERY_BRANCH, KEY_SEARCH_QUERY_CATEGORY, KEY_SEARCH_QUERY_DIGITAL, KEY_SEARCH_QUERY_FREE, KEY_SEARCH_QUERY_HOME_BRANCH, KEY_SEARCH_QUERY_ISBN, KEY_SEARCH_QUERY_KEYWORDA, KEY_SEARCH_QUERY_KEYWORDB, KEY_SEARCH_QUERY_LOCATION, KEY_SEARCH_QUERY_ORDER, KEY_SEARCH_QUERY_PUBLISHER, KEY_SEARCH_QUERY_SYSTEM, KEY_SEARCH_QUERY_TITLE, KEY_SEARCH_QUERY_YEAR, KEY_SEARCH_QUERY_YEAR_RANGE_END, KEY_SEARCH_QUERY_YEAR_RANGE_START, stringProvider, supportedLanguages

Fields inherited from interface de.geeksfactory.opacclient.apis.OpacApi

SUPPORT_FLAG_ACCOUNT_PROLONG_ALL, SUPPORT_FLAG_CHANGE_ACCOUNT, SUPPORT_FLAG_ENDLESS_SCROLLING, SUPPORT_FLAG_QUICKLINKS, SUPPORT_FLAG_WARN_PROLONG_FEES, SUPPORT_FLAG_WARN_RESERVATION_FEES

Constructor Summary

Constructors

Constructor and Description
PicaLBS()

Method Summary

Modifier and Type	Method and Description
AccountData	account(Account account) Load account view (borrowed and reserved items, see AccountData) This function is always called from a background thread, you can use blocking network operations in it.
OpacApi.CancelResult	cancel(java.lang.String media, Account account, int useraction, java.lang.String selection) Cancel a media reservation/order identified by the given String (see AccountData documentation) (see AccountData) This function is always called from a background thread, you can use blocking network operations in it.
void	checkAccountData(Account account) Check the validity of given account data.
void	init(Library lib, HttpClientFactory httpClientFactory) Initializes HTTP client and String Provider
OpacApi.ProlongResult	prolong(java.lang.String media, Account account, int useraction, java.lang.String selection) Extend the lending period of the item identified by the given String (see AccountData) This function is always called from a background thread, you can use blocking network operations in it.
OpacApi.ProlongAllResult	prolongAll(Account account, int useraction, java.lang.String selection) Extend the lending period of all lent items.
OpacApi.ReservationResult	reservation(DetailledItem item, Account account, int useraction, java.lang.String selection) Perform a reservation on the item last fetched with getResultById or getResult for Account acc.

Methods inherited from class de.geeksfactory.opacclient.apis.Pica

addParameters, filterResults, getDefaultEncoding, getLang, getMediaTypeInSingleResult, getResult, getResultById, getShareUrl, getSupportedLanguages, getSupportFlags, parse_result, parse_search, parseSearchFields, search, searchGetPage, setLanguage, updateSearchSetValue, volumeSearch

Methods inherited from class de.geeksfactory.opacclient.apis.BaseApi

buildHttpGetParams, cleanUrl, convertStreamToString, convertStreamToString, downloadCover, getQueryParams, getQueryParamsFirst, getSearchFields, httpGet, httpGet, httpGet, httpGet, httpPost, httpPost, httpPost, httpPost, logHttpError, searchQueryListToMap, setHttpLoggingEnabled, setStringProvider, shouldUseMeaningDetector, start

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.geeksfactory.opacclient.apis.OpacApi

getSearchFields, setStringProvider, start

Constructor Detail

PicaLBS

public PicaLBS()

Method Detail

init

public void init(Library lib,
                 HttpClientFactory httpClientFactory)

Description copied from class: BaseApi

Initializes HTTP client and String Provider

Specified by:

init in interface OpacApi

Overrides:

init in class Pica

Parameters:

lib - The library the Api is initialized for

httpClientFactory - A HttpClientFactory instance that will be used for instantiating HTTP clients. This factory is pluggable because we want to use platform-specific code on Android.

reservation

public OpacApi.ReservationResult reservation(DetailledItem item,
                                             Account account,
                                             int useraction,
                                             java.lang.String selection)
                                      throws java.io.IOException

Description copied from interface: OpacApi

Perform a reservation on the item last fetched with getResultById or getResult for Account acc. (if applicable) This function is always called from a background thread, you can use blocking network operations in it.

Parameters:

item - The item to place a reservation for.

account - Account to be used

useraction - Identifier for the selection made by the user in selection, if a selection was made (see OpacApi.MultiStepResult.getActionIdentifier()) or 0, if no selection was required. If your last method call returned CONFIRMATION_NEEDED, this is set to ACTION_CONFIRMATION if the user positively confirmed the action.

selection - When the method is called for the first time or if useraction is ACTION_CONFIRMATION, this parameter is null. If you return SELECTION in your OpacApi.MultiStepResult.getStatus(), this method will be called again with the user's selection present in selection.

Returns:

A ReservationResult object which has to have the status set.

Throws:

java.io.IOException

prolong

public OpacApi.ProlongResult prolong(java.lang.String media,
                                     Account account,
                                     int useraction,
                                     java.lang.String selection)
                              throws java.io.IOException

Description copied from interface: OpacApi

Extend the lending period of the item identified by the given String (see AccountData) This function is always called from a background thread, you can use blocking network operations in it.

Parameters:

media - Media identification

account - Account to be used

useraction - Identifier for the selection made by the user in selection, if a selection was made (see OpacApi.MultiStepResult.getActionIdentifier()) or 0, if no selection was required. If your last method call returned CONFIRMATION_NEEDED, this is set to ACTION_CONFIRMATION if the user positively confirmed the action.

selection - When the method is called for the first time or if useraction is ACTION_CONFIRMATION, this parameter is null. If you return SELECTION in your OpacApi.MultiStepResult.getStatus(), this method will be called again with the user's selection present in selection.

Returns:

A ProlongResult object which has to have the status set.

Throws:

java.io.IOException

prolongAll

public OpacApi.ProlongAllResult prolongAll(Account account,
                                           int useraction,
                                           java.lang.String selection)
                                    throws java.io.IOException

Description copied from interface: OpacApi

Extend the lending period of all lent items. Will only be called if your OpacApi.getSupportFlags() implementation's return value contains the OpacApi.SUPPORT_FLAG_ACCOUNT_PROLONG_ALL flag. If you don't support the feature, just implement a stub method, like return false; This function is always called from a background thread, you can use blocking network operations in it.

Returns:

A ProlongAllResult object which has to have the status set.

Throws:

java.io.IOException

See Also:

OpacApi.prolong(String, Account, int, String), AccountData

cancel

public OpacApi.CancelResult cancel(java.lang.String media,
                                   Account account,
                                   int useraction,
                                   java.lang.String selection)
                            throws java.io.IOException,
                                   OpacApi.OpacErrorException

Description copied from interface: OpacApi

Cancel a media reservation/order identified by the given String (see AccountData documentation) (see AccountData) This function is always called from a background thread, you can use blocking network operations in it.

Parameters:

media - Media identification

account - Account to be used

useraction - Identifier for the selection made by the user in selection, if a selection was made (see OpacApi.MultiStepResult.getActionIdentifier()) or 0, if no selection was required. If your last method call returned CONFIRMATION_NEEDED, this is set to ACTION_CONFIRMATION if the user positively confirmed the action.

selection - When the method is called for the first time or if useraction is ACTION_CONFIRMATION, this parameter is null. If you return SELECTION in your OpacApi.MultiStepResult.getStatus(), this method will be called again with the user's selection present in selection.

Returns:

A CancelResult object which has to have the status set.

Throws:

java.io.IOException

OpacApi.OpacErrorException

account

public AccountData account(Account account)
                    throws java.io.IOException,
                           org.json.JSONException,
                           OpacApi.OpacErrorException

Description copied from interface: OpacApi

Load account view (borrowed and reserved items, see AccountData) This function is always called from a background thread, you can use blocking network operations in it.

Parameters:

account - The account to display

Returns:

Account details

Throws:

java.io.IOException

org.json.JSONException

OpacApi.OpacErrorException

See Also:

AccountData

checkAccountData

public void checkAccountData(Account account)
                      throws java.io.IOException,
                             org.json.JSONException,
                             OpacApi.OpacErrorException

Description copied from interface: OpacApi

Check the validity of given account data. This is separate from the OpacApi.account(Account) function because just checking the login can be much faster than retrieving all the account data. This function is always called from a background thread, you can use blocking network operations in it.

Parameters:

account - The account to check

Throws:

OpacApi.OpacErrorException - when the login data is invalid or there's another error message from the OPAC system

java.io.IOException

org.json.JSONException