ORG.oclc.z39
Class oclcUserInformation7

java.lang.Object
  |
  +--ORG.oclc.z39.oclcUserInformation7

public class oclcUserInformation7

extends Object

oclcUserInformation7 is used in Search requests. The client requests the information by filling in the minimum, maximim and/or percent fields. The response contains (for each database) the total records in the database and the last record number examined.

Field Summary

static String

OID Object identifier for this field

Constructor Summary

oclcUserInformation7()

oclcUserInformation7(DataDir userInformationField)
Pick apart a request or response.

oclcUserInformation7(int minimumRecordsToRetrieve, int maximumRecordsToRetrieve, int percentToComplete)
Build a request.

oclcUserInformation7(String dbname, int totalInDatabase, int lastExamined)
Build a response.

Method Summary

void	addAnotherResponse(String dbname, int totalInDatabase, int lastExamined) Add an additional set of response data to the current response.
static DataDir	buildDir(int minimumRecordsToRetrieve, int maximumRecordsToRetrieve, int percentToComplete) Build an oclcUserInformation7 request and convert it to a DataDir
static DataDir	buildDir(int minimumRecordsToRetrieve, int maximumRecordsToRetrieve, int percentToComplete, String[] dbnames, int[] totalInDatabase, int[] lastExamined)
static DataDir	buildDir(oclcUserInformation7 oclc7)
void	changeToResponse(String[] dbname, int[] totalInDatabase, int[] lastExamined) Change the request to a response.
void	changeToResponse(String dbname, int totalInDatabase, int lastExamined) Change the request to a response.
Object	clone()
static oclcUserInformation7	combine(oclcUserInformation7[] o) Combine an array of oclcUserInformation7 objects into a single object with results for a single combined databases.
String[]	dbNames()
int[]	lastRecnoExamined()
int	maximumRecordsToRetrieve()
static oclcUserInformation7	merge(oclcUserInformation7[] o) Merge an array of oclcUserInformation7 objects into a single object with results for multiple databases.
int	minimumRecordsToRetrieve()
int	percentToComplete()
String	toString()
int[]	totalInDatabase()

Methods inherited from class java.lang.Object

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

Field Detail

OID

public static final String OID

Object identifier for this field

Constructor Detail

oclcUserInformation7

public oclcUserInformation7(DataDir userInformationField)

Pick apart a request or response.

Parameters:

userInformationField - the additional search info containing an oclcUserInformation7.

oclcUserInformation7

public oclcUserInformation7(String dbname,
                            int totalInDatabase,
                            int lastExamined)

Build a response.

Parameters:

dbname - name of database for this response

totalInDatabase - number of records in database

lastExamined - last record number examined for this search. 0 = all the record numbers were examined, the search completed.

oclcUserInformation7

public oclcUserInformation7()

oclcUserInformation7

public oclcUserInformation7(int minimumRecordsToRetrieve,
                            int maximumRecordsToRetrieve,
                            int percentToComplete)

Build a request.

Parameters:

minimumRecordsToRetrieve - the result set must have at least this many records

maximumRecordsToRetrieve - the result set is satisfactory when it has this many records

percentToComplete - the result set is satisfactory when this many records have been examined.

Method Detail

clone

public Object clone()

Overrides:

clone in class Object

minimumRecordsToRetrieve

public int minimumRecordsToRetrieve()

Returns:

min

maximumRecordsToRetrieve

public int maximumRecordsToRetrieve()

Returns:

max

percentToComplete

public int percentToComplete()

Returns:

percent

totalInDatabase

public int[] totalInDatabase()

Returns:

total

lastRecnoExamined

public int[] lastRecnoExamined()

Returns:

lastExamined

dbNames

public String[] dbNames()

Returns:

dbNames

addAnotherResponse

public void addAnotherResponse(String dbname,
                               int totalInDatabase,
                               int lastExamined)

Add an additional set of response data to the current response.

Parameters:

dbname - name of database for this response

totalInDatabase - number of records in database

lastExamined - last record number examined for this search. 0 = all the

changeToResponse

public void changeToResponse(String[] dbname,
                             int[] totalInDatabase,
                             int[] lastExamined)

Change the request to a response. 0's out the request fields and sets the response fields.

Parameters:

dbname - names of databases in this response

totalInDatabase - number of records in each database

lastExamined - last record number examined for each database

changeToResponse

public void changeToResponse(String dbname,
                             int totalInDatabase,
                             int lastExamined)

Change the request to a response. 0's out the request fields and sets the response fields.

Parameters:

dbname - name of database for this response

totalInDatabase - number of records in database

lastExamined - last record number examined for this search. 0 = all the

buildDir

public static DataDir buildDir(oclcUserInformation7 oclc7)

Parameters:

oclc7 - oclcUserInformation7 to convert to DataDir

Returns:

DataDir for an oclcUserInformation7

buildDir

public static DataDir buildDir(int minimumRecordsToRetrieve,
                               int maximumRecordsToRetrieve,
                               int percentToComplete)

Build an oclcUserInformation7 request and convert it to a DataDir

Parameters:

minimumRecordsToRetrieve - the result set must have at least this many records

maximumRecordsToRetrieve - the result set is satisfactory when it has this many records

percentToComplete - the result set is satisfactory when this many records have been examined.

Returns:

DataDir for an oclcUserInformation7

buildDir

public static DataDir buildDir(int minimumRecordsToRetrieve,
                               int maximumRecordsToRetrieve,
                               int percentToComplete,
                               String[] dbnames,
                               int[] totalInDatabase,
                               int[] lastExamined)

Parameters:

minimumRecordsToRetrieve - the result set must have at least this many records

maximumRecordsToRetrieve - the result set is satisfactory when it has this many records

percentToComplete - the result set is satisfactory when this many records have been examined.

dbname - name of database for this response

totalInDatabase - number of records in database

lastExamined - last record number examined for this search. 0 = all the

Returns:

DataDir for an oclcUserInformation7

combine

public static oclcUserInformation7 combine(oclcUserInformation7[] o)

Combine an array of oclcUserInformation7 objects into a single object with results for a single combined databases.

Parameters:

o - array of oclcUserInformation7 objects

Returns:

new oclcUserInformation7 object with combined information

merge

public static oclcUserInformation7 merge(oclcUserInformation7[] o)

Merge an array of oclcUserInformation7 objects into a single object with results for multiple databases.

Parameters:

o - array of oclcUserInformation7 objects

Returns:

new oclcUserInformation7 object with merged information

toString

public String toString()

Overrides:

toString in class Object