com.pkrete.jsip2.messages.requests
Class SIP2LoginRequest

java.lang.Object
  com.pkrete.jsip2.messages.SIP2Message
      com.pkrete.jsip2.messages.SIP2MessageRequest
          com.pkrete.jsip2.messages.requests.SIP2LoginRequest

All Implemented Interfaces:

Serializable

public class SIP2LoginRequest
extends SIP2MessageRequest

This class represents the message that is used to login to an ILS SIP server program. The ILS SIP server should respond with the SIP2LoginResponse message. This is the first message sent to the ILS.

Author:

Petteri Kivimäki

See Also:

Serialized Form

Field Summary

Fields inherited from class com.pkrete.jsip2.messages.SIP2MessageRequest

counter, errorDetectionEnabled, feeAcknowledged, patronPassword, terminalPassword, useFeeAcknowledged

Fields inherited from class com.pkrete.jsip2.messages.SIP2Message

bibId, checkSum, code, currencyType, currentLocation, expirationDate, feeAmount, feeType, institutionId, itemIdentifier, itemProperties, patronIdentifier, pickupLocation, sequence, titleIdentifier, transactionDate, transactionId

Constructor Summary

SIP2LoginRequest(String userName, String password)
Constructs and initializes a new SIP2LoginRequest object with the given userName and password.

SIP2LoginRequest(String userName, String password, String circulationLocation)
Constructs and initializes a new SIP2LoginRequest object with the given userName, password, and circulationLocation.

Method Summary

String	getCirculationLocation() Returns the ILS's circulation location to be used.
String	getData() Returns a string presentation of the message.
String	getPassword() Returns the password to login to the ILS.
String	getUserName() Returns the username to login to the ILS.
void	setCirculationLocation(String circulationLocation) Sets the ILS's circulation location to be used.
void	setPassword(String password) Sets the password to login to the ILS.
void	setUserName(String userName) Sets the username to login to the ILS.

Methods inherited from class com.pkrete.jsip2.messages.SIP2MessageRequest

getCheckSum, getPatronPassword, getTerminalPassword, isErrorDetectionEnabled, isFeeAcknowledged, isUseFeeAcknowledged, setErrorDetectionEnabled, setFeeAcknowledged, setPatronPassword, setTerminalPassword, setUseFeeAcknowledged

Methods inherited from class com.pkrete.jsip2.messages.SIP2Message

getBibId, getCode, getCurrencyType, getCurrentLocation, getExpirationDate, getFeeAmount, getFeeType, getInstitutionId, getItemIdentifier, getItemProperties, getPatronIdentifier, getPickupLocation, getSequence, getTitleIdentifier, getTransactionDate, getTransactionId, isChecksum, isSequence, setBibId, setCheckSum, setCode, setCurrencyType, setCurrentLocation, setExpirationDate, setFeeAmount, setFeeType, setInstitutionId, setItemIdentifier, setItemProperties, setPatronIdentifier, setPickupLocation, setSequence, setTitleIdentifier, setTransactionDate, setTransactionId

Methods inherited from class java.lang.Object

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

Constructor Detail

SIP2LoginRequest

public SIP2LoginRequest(String userName,
                        String password)

Constructs and initializes a new SIP2LoginRequest object with the given userName and password.

Parameters:

userName - ILS username

password - ILS password

SIP2LoginRequest

public SIP2LoginRequest(String userName,
                        String password,
                        String circulationLocation)

Constructs and initializes a new SIP2LoginRequest object with the given userName, password, and circulationLocation.

Parameters:

userName - ILS username

password - ILS password

circulationLocation - ILS circulation location

Method Detail

getUserName

public String getUserName()

Returns the username to login to the ILS.

Returns:

username to login to the ILS

setUserName

public void setUserName(String userName)

Sets the username to login to the ILS.

Parameters:

userName - username

getPassword

public String getPassword()

Returns the password to login to the ILS.

Returns:

password to login to the ILS

setPassword

public void setPassword(String password)

Sets the password to login to the ILS.

Parameters:

password - new password

getCirculationLocation

public String getCirculationLocation()

Returns the ILS's circulation location to be used.

Returns:

ILS's circulation location to be used

setCirculationLocation

public void setCirculationLocation(String circulationLocation)

Sets the ILS's circulation location to be used.

Parameters:

circulationLocation - new location

getData

public String getData()

Description copied from class: SIP2Message

Returns a string presentation of the message.

Specified by:

getData in class SIP2Message

Returns:

string presentation of the message