ORG.oclc.webz
Class ILLUserData

java.lang.Object
  |
  +--ORG.oclc.webz.ILLUserData

public class ILLUserData

extends Object

implements UserApplicationContext

The ILLUserData class maintains information of all the ILL activity for a user. It also provides methods to find any information about a user's ILL activities and ILL server objects the user has access to.

See Also:

UserStateObject, ILLServer

Constructor Summary

ILLUserData()
Constructs an ILLUserData object.

Method Summary

void	countRequests() Counts the number of Iso ILL Transactions performed.
boolean	countsRequests() Returns a boolean indicating whether to limit the number of requests between authorizations.
int	currentCount() Returns an integer containing the current number of ILL Transactions performed.
void	delete(UserStateObject user) Cleans up the ILLUserData object for the input UserStateObject by releasing access to any object the class maintains and writes stats out.
static ILLUserData	get(UserStateObject user) Retrieves an ILLUserData object for the input UserStateObject.
ILLServer	getILLServer() Retrieves the ILLServer object.
IllSession	illSession() Retrieves the IllSession object for this user.
void	init(UserStateObject user) Initializes the ILLUserData Information is defaulted from the ILLServer
boolean	mustReauthorize() Returns a boolean indicating whether the user needs to Re-Authorize before issuing another ILL Request.
int	reauthoLimit() Returns an integer containing the total number of ILL Transactions allowed before reauthorization is required.
void	resetCount() Resets the counter for ILL Access
String	toString() Generates a string representation of the object.
int	totalCount() Returns an integer containing the total number of ILL Transactions performed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ILLUserData

public ILLUserData()

Constructs an ILLUserData object.

Method Detail

toString

public String toString()

Generates a string representation of the object.

Returns:

String

Overrides:

toString in class Object

countsRequests

public boolean countsRequests()

Returns a boolean indicating whether to limit the number of requests between authorizations.

Returns:

true or false

countRequests

public void countRequests()

Counts the number of Iso ILL Transactions performed.

totalCount

public int totalCount()

Returns an integer containing the total number of ILL Transactions performed.

Returns:

int totalCount the total number of ILL transactions for this user.

currentCount

public int currentCount()

Returns an integer containing the current number of ILL Transactions performed.

Returns:

int currentCount the current number of ILL transactions.

reauthoLimit

public int reauthoLimit()

Returns an integer containing the total number of ILL Transactions allowed before reauthorization is required.

Returns:

int reauthoLimit the number of ILL transactions allowed.

mustReauthorize

public boolean mustReauthorize()

Returns a boolean indicating whether the user needs to Re-Authorize before issuing another ILL Request.

Returns:

boolean

resetCount

public void resetCount()

Resets the counter for ILL Access

init

public void init(UserStateObject user)

Initializes the ILLUserData Information is defaulted from the ILLServer

Specified by:

init in interface UserApplicationContext

Parameters:

user - the UserStateObject

See Also:

ILLServer

delete

public void delete(UserStateObject user)

Cleans up the ILLUserData object for the input UserStateObject by releasing access to any object the class maintains and writes stats out.

Specified by:

delete in interface UserApplicationContext

Parameters:

user - the UserStateObject that owns this application context

illSession

public IllSession illSession()

Retrieves the IllSession object for this user.

Returns:

Illsession that can be used to send/receive ILL requests

See Also:

IllSession

getILLServer

public ILLServer getILLServer()

Retrieves the ILLServer object.

Returns:

ILLServer

get

public static ILLUserData get(UserStateObject user)

Retrieves an ILLUserData object for the input UserStateObject. A new ILLUserData object is created if not found and stored in the user state object -

Parameters:

user - the user object

Returns:

ILLUserData