Open SiteSearch 4.1.1
Final

ORG.oclc.z39.client
Class Z39delete

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

public class Z39delete
extends Object

deleteRequest builds and parses DeleteResultSetRequests.


Field Summary
 int deleteFunction
          Specified by the origin.
 int[] deleteListStatuses
          If the deleteFunction was 'list', then these are statuses for each list
 String deleteMessage
          Optional text message from the target
 int deleteOperationStatus
          Returned by the target
 int numberNotDeleted
          If the deleteFunction was 'bulk' and some were not delete, the target fills this in
 int referenceId
          Value passed to Request and returned by a target Z39.50 server and Response stores it here
 int requestLength
          integer data type containing the number of bytes in the request.
 int responseLength
          integer data type containing the number of bytes in the response.
 String[] resultSetList
          If the deleteFunction is 'list', then this is the list
 Z39session zsession
          Z39session
 
Constructor Summary
Z39delete()
           
Z39delete(Z39session z)
           
 
Method Summary
 void doDelete(int referenceId, int deleteFunction, String[] resultSetList)
          Creates, Issues, and Processes a Z39.50 DeleteResultSet
 BerString Request(int referenceId, int deleteFunction, String[] resultSetList)
          Creates a Z39.50 DeleteResultSetRequest
 BerString Request(int referenceId, int deleteFunction, String[] resultSetList, int extraLen, int offset)
          Creates a Z39.50 DeleteResultSetRequest
 void Response(BerString response)
          Processes a Z39.50 DeleteResponse.
 void Response(DataDir response)
           
 BerString toBer()
          BER encodes the Z39.50 Delete Request
 BerString toBerString()
          Creates a Z39.50 DeleteRequest BerString given that all the initclass request are already set up.
 BerString toBerString(int extraLen, int offset)
          Creates a Z39.50 DeleteRequest BerString given that all the initclass request are already set up
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

referenceId

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

deleteFunction

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

resultSetList

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

deleteOperationStatus

public int deleteOperationStatus
Returned by the target

deleteListStatuses

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

numberNotDeleted

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

deleteMessage

public String deleteMessage
Optional text message from the target

requestLength

public int requestLength
integer data type containing the number of bytes in the request.

responseLength

public int responseLength
integer data type containing the number of bytes in the response.

zsession

public Z39session zsession
Z39session
Constructor Detail

Z39delete

public Z39delete()

Z39delete

public Z39delete(Z39session z)
Method Detail

doDelete

public void doDelete(int referenceId,
                     int deleteFunction,
                     String[] resultSetList)
              throws Exception,
                     Diagnostic1
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.
Throws:
Exception - exceptions from BerConnect
Diagnostic1 - Z39.50 diagnostic

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

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

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

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

toBer

public BerString toBer()
BER encodes the Z39.50 Delete Request
Returns:
BerString containing Request or null if space was unavailable

Response

public void Response(BerString response)
Processes a Z39.50 DeleteResponse.
Parameters:
response - BerString containing response.

Response

public void Response(DataDir response)

toString

public String toString()
Overrides:
toString in class Object

Open SiteSearch 4.1.1
Final