ORG.oclc.webz
Class ISOILL

java.lang.Object
  |
  +--ORG.oclc.webz.Verb
        |
        +--ORG.oclc.webz.ZVerb
              |
              +--ORG.oclc.webz.ISOILL

Direct Known Subclasses:

ILLEmail, MyISOILL

public class ISOILL

extends ZVerb

The ISOILL class provides the capability to issue an ISOILL request for an Interlibrary Loan. ISOILL uses input parameters contained in a RequestManager object. The pieces of data that are encoded into the api come in from the RequestManager. The ISOILL class initializes the user for ILL activity, parses the necessary parameters from the URL, creates and sends the ISO 10161 request, and sets up the next command or page for execution.

The URL widgets recognized by the ISOILL class are:
BibTitle
BibSubTitle
BibAuthor
BibEdition
BibPubPlace
BibPubDate
BibPublisher
BibSeries
BibDissertation
BibISBN
BibISSN
BibUniformTitle
BibCallNumber
BibSponsBody
BibPubDateofComp
BibArticleAuthor
BibArticleTitle
BibPagination
BibVolume
BibIssue
BibOCLCNum
BibLCCN
BibVerification
BibSource
BibSendToList
IllServiceType
DeliveryName
DeliveryExtendedAddress
DeliveryStreetNum
DeliveryPoBox
DeliveryCity
DeliveryRegion
DeliveryCountry
DeliveryPostalCode
DeliveryService
EDeliveryService
DeliveryFax
DeliveryEmail
BillingName
BillingExtendedAddress
BillingStreetNum
BillingPoBox
BillingCity
BillingRegion
BillingCountry
BillingPostalCode
BillingMonetaryValue
BillingAccountNum
ClientName
ClientStatus
ClientId
ClientDepartment
Id
Name
Title
FirstName
LastName
Initials
Suffix
SSN
HomeExtendedAddress
HomeStreetNum
HomePoBox
HomeCity
HomeRegion
HomeCountry
HomePostalCode
WorkExtendedAddress
WorkStreetNum
WorkPoBox
WorkCity
WorkRegion
WorkCountry
WorkPostalCode
Phone
Email
Fax
Pager
Status
Department
Notes
CopyrightCompliance
NeedBeforeDate
RequesterNote
MonetaryValue
CurrencyCode
PaymentMethod

See Also:

FailurePage, SuccessPage, JavaPage, UserStateObject, ILLUserData, IllSession, Log

Field Summary

protected ILLUserData	iUserData ILLUserData object which contains information and defaults for ILL.
protected IllPatronInfo	patron ILLUserData object which contains default information about the patron.
protected IllTxnInfo	txn IllTxnInfo object which contains information about this particular ILL transaction.

Fields inherited from class ORG.oclc.webz.ZVerb

bytesIn, bytesOut, dbGroupSearch, dbname, fmtClass, format, inputQueryInfo, numrecs, postings, ranked, recno, resultSetName, sorting, tempDb, traceMsgs, z39session, zDb, zQueryTerm, zServer, zUserData

Fields inherited from class ORG.oclc.webz.Verb

user, widgets

Constructor Summary

ISOILL()
Constructs an ISOILL object.

Method Summary

protected void	doILL() Retrieves the ISOILL parameters from the incoming URL found in the ISOILL widgets and creates the parsed term.
protected void	parseParms() Retrieve the ISOILL parameters found in the ISOILL widgets from the incoming URL and collect all parts of the request.
void	runit(RequestManager rMngr) Executes the ISOILL class using parameters in the RequestManager object.
void	runit(RequestManager rMngr, String URLCmd) Run the main ISOILL logic by specifying the URLCommand.
protected void	validateParms() Perform some basic validation.

Methods inherited from class ORG.oclc.webz.ZVerb

doAccessControl, doSort, initZUser, restoreDbState, saveDbState, saveRecs, toString

Methods inherited from class ORG.oclc.webz.Verb

setUpPage

Methods inherited from class java.lang.Object

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

Field Detail

iUserData

protected ILLUserData iUserData

ILLUserData object which contains information and defaults for ILL.

patron

protected IllPatronInfo patron

ILLUserData object which contains default information about the patron.

txn

protected IllTxnInfo txn

IllTxnInfo object which contains information about this particular ILL transaction.

Constructor Detail

ISOILL

public ISOILL()

Constructs an ISOILL object. Initializes default parameters.

Method Detail

runit

public void runit(RequestManager rMngr)

Executes the ISOILL class using parameters in the RequestManager object. Initialize the user, parse the input parameters from the input URL, create the IsoILL request and send it to the IsoILL Server, and set up the next command or page to execute in the caller. Each method called from the runit() method can throw a FailurePage exception. If this occurs, the catch logic for the exceptions invokes setup of the next page or command to execute upon return. Errors result in a failure to create the request or an error returned from the request itself. Successful execution of all steps sets up the next page for execution upon return.

Parameters:

rMngr - the RequestManager object

Overrides:

runit in class Verb

runit

public void runit(RequestManager rMngr,
                  String URLCmd)

Run the main ISOILL logic by specifying the URLCommand. This would be used when creating a isoill object from one of the application classes.

Parameters:

rMngr - the RequestManager object

URLCmd - the command string with the widgets delimiteded by ":"

parseParms

protected void parseParms()

Retrieve the ISOILL parameters found in the ISOILL widgets from the incoming URL and collect all parts of the request.

validateParms

protected void validateParms()
                      throws FailurePage

Perform some basic validation.

Title must be present.

If the needBeforeDate is present, it must be later than today.

Copyright compliance, if present, must be "ccg" or "ccl" "US:CCG" or "US:CCL" (case insensitive). For IPIG profile compliance, we add the "US" if it is not present.

if billingMonetaryValue exists, so must billingCurrencyCode

if monetaryValue exists, so must currencyCode

Throws:

FailurePage - one of the ISOILL widgets is invalid

doILL

protected void doILL()
              throws FailurePage

Retrieves the ISOILL parameters from the incoming URL found in the ISOILL widgets and creates the parsed term.

Throws:

FailurePage - the ISOILL string is invalid or connection fails