ORG.oclc.isoill
Class IllPatronInfo

java.lang.Object
  |
  +--ORG.oclc.isoill.IllPatronInfo

public class IllPatronInfo

extends Object

The IllPatronInfo class contains all of the patron data needed to send an IllRequestApdu to OCLC ILL. This information is stored in the Ill Session, so it is reused for subsequent ILL transactions.

Field Summary

String	affiliations String containing the library affiliations (OCLC extension).
String	authorization String containing the OCLC ILL authorization.
String	billingAccountNumber String containing the billing account number.
String	billingCity String containing the billing city.
String	billingCountry String containing the billing country.
String	billingCurrencyCode String containing the currency type.
String	billingExtension String containing part of the billing address.
String	billingMonetaryValue String containing maximum cost library is willing to pay.
String	billingName String containing the billing name.
String	billingPoBox String containing the billing post office box.
String	billingPostalCode String containing the billing postal code.
String	billingRegion String containing the billing region (or state).
String	billingStreetNo String containing the billing address.
boolean	changeSendTo Boolean data type indicating whether ILL Direct Request has permission to change the sendToList.
String	clientDepartment String containing the client department.
String	clientIdentifier String containing the client id.
String	clientName String containing the client name.
String	clientStatus String containing the client status.
String	copyrightCompliance String containing indication of copyright complicance.
String	currencyCode String containing patron currency type (client extension).
String	deliveryCity String containing the delivery city.
String	deliveryCountry String containing the delivery country.
String	deliveryEmail String containing the delivery email address.
String	deliveryExtension String containing part of the delivery address.
String	deliveryFax String containing the delivery fax number
String	deliveryName String containing the delivery name
String	deliveryPoBox String containing the delivery post office box.
String	deliveryPostalCode String containing the delivery postal code.
String	deliveryRegion String containing the delivery region (or state).
String	deliveryService String containing the delivery method.
String	deliveryStreetNo String containing the delivery street address.
String	Department String containing the patron department (client extension).
String	electronicDeliveryDescription String containing the type of electronic delivery ("fax" or "email").
String	Email String containing the patron email address (client extension).
String	Fax String containing the patron fax number (client extension).
String	FirstName String containing the patron first name (client extension).
String	FullName String containing the patron full name (client extension).
String	HomeCity String containing the patron home city (client extension).
String	HomeCountry String containing the patron home country (client extension).
String	HomeExtension String containing part of the patron home address (client extension).
String	HomePoBox String containing the patron home post office box (client extension).
String	HomePostalCode String containing the patron home postal code (client extension).
String	HomeRegion String containing the patron home region or state (client extension).
String	HomeStreetNo String containing the patron home street number (client extension).
String	Id String containing the patron id (client extension).
String	ILLemail String containing the ILL Email address (library address).
String	Initials String containing patron initials (client extension).
String	LastName String containing the patron last name (client extension).
String	monetaryValue String containing patron maximum amount willing to pay (client extension).
String	needBeforeDate String containing the date before which the item is needed.
String	Notes String containing patron notes (client extension).
int	oclcIllServiceType Integer containing the OCLC ILL Direct Request Service type 1 = directToProfile 2 = directToLender 3 = directToReview
String	Pager String containing the patron pager number (client extension).
String	password String containing the OCLC ILL password.
String	paymentMethod String containing
String	Phone String containing the patron telephone (client extension).
int	preference Integer data type containing the OCLC ILL Direct request preference.
String	requesterId String containing the OCLC symbol of the borrowing library.
String	requesterNote String containing additional notes or information.
String	responderId String containing the Id of the server to which we are sending.
String	source String containing the source of the request (OCLC extension).
String	Ssn String containing the patron social security number (client extension).
String	Status String containing the patron status (client extension).
String	Suffix String containing patron suffix (client extension).
String	Title String containing patron title (client extension).
String	WorkCity String containing the patron work city (client extension).
String	WorkCountry String containing the patron work country (client extension).
String	WorkExtension String containing part of the patron work address (client extension).
String	WorkPoBox String containing the patron work post office box (client extension).
String	WorkPostalCode String containing the patron work postal code (client extension).
String	WorkRegion String containing the patron work region or state (client extension).
String	WorkStreetNo String containing the patron work street number (client extension).

Constructor Summary

IllPatronInfo()
Constructs an IllPatronInfo object.

Method Summary

boolean	isProfiled() Returns a boolean indicating whether patron has already retrieved profile information
void	setProfiled() Sets the profiled flag to true
String	toString() Generates a String representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

oclcIllServiceType

public int oclcIllServiceType

Integer containing the OCLC ILL Direct Request Service type
1 = directToProfile
2 = directToLender
3 = directToReview

changeSendTo

public boolean changeSendTo

Boolean data type indicating whether ILL Direct Request has permission to change the sendToList.

preference

public int preference

Integer data type containing the OCLC ILL Direct request preference.
ORDERED = 1 - UNORDERED = 2

requesterId

public String requesterId

String containing the OCLC symbol of the borrowing library.

responderId

public String responderId

String containing the Id of the server to which we are sending.

authorization

public String authorization

String containing the OCLC ILL authorization.

password

public String password

String containing the OCLC ILL password.

deliveryName

public String deliveryName

String containing the delivery name

deliveryExtension

public String deliveryExtension

String containing part of the delivery address.

deliveryStreetNo

public String deliveryStreetNo

String containing the delivery street address.

deliveryPoBox

public String deliveryPoBox

String containing the delivery post office box.

deliveryCity

public String deliveryCity

String containing the delivery city.

deliveryRegion

public String deliveryRegion

String containing the delivery region (or state).

deliveryCountry

public String deliveryCountry

String containing the delivery country.

deliveryPostalCode

public String deliveryPostalCode

String containing the delivery postal code.

deliveryService

public String deliveryService

String containing the delivery method.

electronicDeliveryDescription

public String electronicDeliveryDescription

String containing the type of electronic delivery ("fax" or "email").

deliveryFax

public String deliveryFax

String containing the delivery fax number

deliveryEmail

public String deliveryEmail

String containing the delivery email address.

billingName

public String billingName

String containing the billing name.

billingExtension

public String billingExtension

String containing part of the billing address.

billingStreetNo

public String billingStreetNo

String containing the billing address.

billingPoBox

public String billingPoBox

String containing the billing post office box.

billingCity

public String billingCity

String containing the billing city.

billingRegion

public String billingRegion

String containing the billing region (or state).

billingCountry

public String billingCountry

String containing the billing country.

billingPostalCode

public String billingPostalCode

String containing the billing postal code.

billingMonetaryValue

public String billingMonetaryValue

String containing maximum cost library is willing to pay.

billingCurrencyCode

public String billingCurrencyCode

String containing the currency type. Defaults to "usd" (required for ifm).

billingAccountNumber

public String billingAccountNumber

String containing the billing account number.

clientName

public String clientName

String containing the client name.

clientStatus

public String clientStatus

String containing the client status.

clientIdentifier

public String clientIdentifier

String containing the client id.

clientDepartment

public String clientDepartment

String containing the client department.

Id

public String Id

String containing the patron id (client extension).

FullName

public String FullName

String containing the patron full name (client extension).

FirstName

public String FirstName

String containing the patron first name (client extension).

LastName

public String LastName

String containing the patron last name (client extension).

Initials

public String Initials

String containing patron initials (client extension).

Title

public String Title

String containing patron title (client extension).

Suffix

public String Suffix

String containing patron suffix (client extension).

Ssn

public String Ssn

String containing the patron social security number (client extension).

HomeExtension

public String HomeExtension

String containing part of the patron home address (client extension).

HomeStreetNo

public String HomeStreetNo

String containing the patron home street number (client extension).

HomePoBox

public String HomePoBox

String containing the patron home post office box (client extension).

HomeCity

public String HomeCity

String containing the patron home city (client extension).

HomeRegion

public String HomeRegion

String containing the patron home region or state (client extension).

HomeCountry

public String HomeCountry

String containing the patron home country (client extension).

HomePostalCode

public String HomePostalCode

String containing the patron home postal code (client extension).

WorkExtension

public String WorkExtension

String containing part of the patron work address (client extension).

WorkStreetNo

public String WorkStreetNo

String containing the patron work street number (client extension).

WorkPoBox

public String WorkPoBox

String containing the patron work post office box (client extension).

WorkCity

public String WorkCity

String containing the patron work city (client extension).

WorkRegion

public String WorkRegion

String containing the patron work region or state (client extension).

WorkCountry

public String WorkCountry

String containing the patron work country (client extension).

WorkPostalCode

public String WorkPostalCode

String containing the patron work postal code (client extension).

Phone

public String Phone

String containing the patron telephone (client extension).

Email

public String Email

String containing the patron email address (client extension).

Fax

public String Fax

String containing the patron fax number (client extension).

Pager

public String Pager

String containing the patron pager number (client extension).

Status

public String Status

String containing the patron status (client extension).

Department

public String Department

String containing the patron department (client extension).

Notes

public String Notes

String containing patron notes (client extension).

currencyCode

public String currencyCode

String containing patron currency type (client extension). Defaults to "usd" (required for ifm).

monetaryValue

public String monetaryValue

String containing patron maximum amount willing to pay (client extension).

paymentMethod

public String paymentMethod

String containing

source

public String source

String containing the source of the request (OCLC extension).

affiliations

public String affiliations

String containing the library affiliations (OCLC extension).

copyrightCompliance

public String copyrightCompliance

String containing indication of copyright complicance.

requesterNote

public String requesterNote

String containing additional notes or information.

needBeforeDate

public String needBeforeDate

String containing the date before which the item is needed.

ILLemail

public String ILLemail

String containing the ILL Email address (library address).

Constructor Detail

IllPatronInfo

public IllPatronInfo()

Constructs an IllPatronInfo object.

Method Detail

setProfiled

public void setProfiled()

Sets the profiled flag to true

isProfiled

public boolean isProfiled()

Returns a boolean indicating whether patron has already retrieved profile information

Returns:

true or false

toString

public String toString()

Generates a String representation of the object.

Returns:

String

Overrides:

toString in class Object