edu.byu.hbll.symwsclient.service.cancelMyHold

Class CancelMyHoldClient

java.lang.Object

edu.byu.hbll.symwsclient.service.cancelMyHold.CancelMyHoldClient

public abstract class CancelMyHoldClient
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	QUERYPARAM_HOLD_KEY
static String	SERVICE_PATH The path from the application webroot to the service endpoint

Constructor Summary

Constructors

Constructor and Description
CancelMyHoldClient()

Method Summary

Modifier and Type	Method and Description
boolean	cancelHold(SymwsClientConfig symwsClientConfig, long holdKey) Cancels the Symphony hold having the provided holdKey

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_PATH

public static final String SERVICE_PATH

The path from the application webroot to the service endpoint

See Also:

Constant Field Values

QUERYPARAM_HOLD_KEY

public static final String QUERYPARAM_HOLD_KEY

See Also:

Constant Field Values

Constructor Detail

CancelMyHoldClient

public CancelMyHoldClient()

Method Detail

cancelHold

public boolean cancelHold(SymwsClientConfig symwsClientConfig,
                          long holdKey)
                   throws SymwsClientException,
                          IllegalArgumentException

Cancels the Symphony hold having the provided holdKey

Parameters:

symwsClientConfig - the SymwsClientConfig to use with this request

holdKey - the holdKey of the hold to cancel

Returns:

true if the hold was successfully cancelled, false otherwise

Throws:

SymwsClientException - if the web service returns an error

IllegalArgumentException - if the holdKey is not a positive whole number