Interstage Shunsaku Data Manager Application Development Guide - Microsoft(R) Windows(R) 2000/ Microsoft(R) Windows Server(TM) 2003 - - UNIX -

M.2.3 executeDelete

Function

This method sends search conditions for finding records to be deleted to Shunsaku, and deletes records that match the conditions.

Syntax

public void executeDelete(
    String   query,             /* (1) Search expression              */
    int      replyNo,           /* (2) Deletion start number          */
    int      requestCnt,        /* (3) Number of delete requests      */
    String   reserve1,          /* (4) Reserved (null)                */
    String   recordIDfileName   /* (5) Pathname of work file          */
) throws ShunException;

Return Value

None.

Parameters

(1) Search expression

Specify the search expression using Unicode.

Ensure that the size of the search expression is between 1 and 65,535 bytes inclusive.

Refer to B.3 Search Expressions for details on search expressions.

(2) Deletion start number

Specifies the deletion start number.

Specify the item of found data from which to commence deletion. Specify a number greater than zero.

(3) Number of delete requests

Specifies the number of delete requests.

Specify either the maximum number of items to be deleted (a number greater than zero), or "-1".

Note that if the maximum number of items to be deleted is greater than the maximum number of responses to a client request (specified in AnsMax in the director environment file), or if "-1" is specified as the maximum number of items to be deleted, all records that match the search conditions will be deleted.

(4) Reserved

Specify null.

(5) Pathname of work file

Specifies the full pathname of the work file that is used by the internal processing of the API used to delete data.

At least 24 bytes of work area space is required for each record.

The user must create in advance the directory that will contain the work file.

Exceptions

ShunException

ShunException is output when an error occurs while XML documentis being deleted.

Refer to M.4 Error Codes Output for details on error codes.

Note

• Since this method is invoked synchronously, control does not return to the invoking source until all specified data has been deleted.