All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class ORG.oclc.z39.client.Z39delete

java.lang.Object
   |
   +----ORG.oclc.z39.client.Z39delete

public class Z39delete
extends Object
deleteRequest builds and parses DeleteResultSetRequests.

Version:
@(#)Z39delete.java 1.1 07/09/97

Variable Index

 o deleteFunction
Specified by the origin.
 o deleteListStatuses
If the deleteFunction was 'list', then these are statuses for each list
 o deleteMessage
Optional text message from the target
 o deleteOperationStatus
Returned by the target
 o numberNotDeleted
If the deleteFunction was 'bulk' and some were not delete, the target fills this in
 o referenceId
Value passed to Request and returned by a target Z39.50 server and Response stores it here
 o resultSetList
If the deleteFunction is 'list', then this is the list
 o zsession
Z39session

Constructor Index

 o Z39delete()
 o Z39delete(Z39session)

Method Index

 o doDelete(int, int, String[])
Creates, Issues, and Processes a Z39.50 DeleteResultSet
 o Request(int, int, String[])
Creates a Z39.50 DeleteResultSetRequest
 o Request(int, int, String[], int, int)
Creates a Z39.50 DeleteResultSetRequest
 o Response(BerString)
Processes a Z39.50 DeleteResponse.
 o Response(DataDir)
 o toBer()
BER encodes the Z39.50 Delete Request
 o toBerString()
Creates a Z39.50 DeleteRequest BerString given that all the initclass request are already set up.
 o toBerString(int, int)
Creates a Z39.50 DeleteRequest BerString given that all the initclass request are already set up
 o toString()

Variables

 o referenceId
 public int referenceId
Value passed to Request and returned by a target Z39.50 server and Response stores it here

 o deleteFunction
 public int deleteFunction
Specified by the origin. Request to delete all results set or just a specified list of results sets

 o resultSetList
 public String resultSetList[]
If the deleteFunction is 'list', then this is the list

 o deleteOperationStatus
 public int deleteOperationStatus
Returned by the target

 o deleteListStatuses
 public int deleteListStatuses[]
If the deleteFunction was 'list', then these are statuses for each list

 o numberNotDeleted
 public int numberNotDeleted
If the deleteFunction was 'bulk' and some were not delete, the target fills this in

 o deleteMessage
 public String deleteMessage
Optional text message from the target

 o zsession
 public Z39session zsession
Z39session

Constructors

 o Z39delete
 public Z39delete()
 o Z39delete
 public Z39delete(Z39session z)

Methods

 o doDelete
 public boolean doDelete(int referenceId,
                         int deleteFunction,
                         String resultSetList[]) throws Exception
Creates, Issues, and Processes a Z39.50 DeleteResultSet

Parameters:
referenceId - Will be returned on Response and allows Requests and responses to be matched up by the application.
deleteFunction - See Z39.50 Specification.
resultSetList - See Z39.50 Specification.
Returns:
boolean indicating whether the command was a success or failure
Throws: Exception
exceptions from Z39Connect
 o Request
 public final BerString Request(int referenceId,
                                int deleteFunction,
                                String resultSetList[])
Creates a Z39.50 DeleteResultSetRequest

Parameters:
referenceId - Will be returned on Response and allows Requests and responses to be matched up by the application.
deleteFunction - See Z39.50 Specification.
resultSetList - See Z39.50 Specification.
Returns:
BerString containing Request or null if space was unavailable
 o Request
 public final BerString Request(int referenceId,
                                int deleteFunction,
                                String resultSetList[],
                                int extraLen,
                                int offset)
Creates a Z39.50 DeleteResultSetRequest

Parameters:
referenceId - Will be returned on Response and allows Requests and responses to be matched up by the application.
deleteFunction - See Z39.50 Specification.
resultSetList - See Z39.50 Specification.
extraLen - Allow this much extra room in the built BER record.
offset - Build the Request at this offset in the BerString
Returns:
BerString containing Request or null if space was unavailable
 o toBerString
 public BerString toBerString()
Creates a Z39.50 DeleteRequest BerString given that all the initclass request are already set up.

Returns:
BerString containing Request or null if space was unavailable
 o toBerString
 public BerString toBerString(int extraLen,
                              int offset)
Creates a Z39.50 DeleteRequest BerString given that all the initclass request are already set up

Parameters:
extraLen - Allow this much extra room in the built BER return record.
offset - Build the Request at this offset in the BerString
Returns:
BerString containing Request or null if space was unavailable
 o toBer
 public BerString toBer()
BER encodes the Z39.50 Delete Request

Returns:
BerString containing Request or null if space was unavailable
 o Response
 public void Response(BerString response)
Processes a Z39.50 DeleteResponse.

Parameters:
response - BerString containing response.
 o Response
 public void Response(DataDir response)
 o toString
 public String toString()
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index