ORG.oclc.z39
Class ExtSvcData

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

public class ExtSvcData

extends Object

The ExtSvcData class is a container class defining all the possible Elements that can be defined for a Z39.50 Extended Services Request. It is provided as source in the Open SiteSearch product so that custom Extended Services functionality can be added to the system.

DO NOT CHANGE THE DEFINITIONS IN THIS CLASS, as it is used by the Z39.50 classes manipulating the requests and saving response information.

For additional definitions of the elements in a Z39.50 Extended Services Request, refer to the Z39.50 Standard.

In addition to the variable elements, it defines accepted values for the extended services function, wait action, and permissions fields

Field Summary

int	allowableFunctionsForPermissions Integer data type containing the allowable functions for permissions in the ES request - an optional input parameter.
static int	CREATE_FUNCTION Integer data type defining the value for the create function.
static int	DELETE_FUNCTION Integer data type defining the value for the delete function.
static int	DELETE_PERMISSION Integer data type defining the permissions value for delete.
String	description String data type containing the description for the ES request - an optional input parameter.
Diagnostic1	diagnostic Diagnostic1 object from the ES server response.
static int	DONT_RETURN_PACKAGE Integer data type defining the value for the dontReturnPackage type waitAction.
static int	DONT_WAIT Integer data type defining the value for the dontWait type waitAction.
String	elementSetName String data type containing the Element Set Name value for the ES request - an optional input parameter.
int	function Integer data type defining the ES function (create, modify, or delete) - a required input parameter.
static int	INVOKE_PERMISSION Integer data type defining the permissions value for invoke.
static int	MODIFY_CONTENTS_PERMISSION Integer data type defining the permissions value for modifyContents.
static int	MODIFY_FUNCTION Integer data type defining the value for the modify function.
static int	MODIFY_PERMISSIONS Integer data type defining the permissions value for modify.
int	operationStatus Integer data type containing the operation status from the ES response.
DataDir	otherInformation DataDir object containing the OtherInformation data for the ES request - an optional input parameter.
String	otherInformationOID String data type containing the Object Identifier (OID) for the OtherInformation data for the ES request - an optional input parameter, but required when specifying the OtherInformation data.
String	packageName String data type containing the package name for the ES request - an optional input parameter.
String	packageTypeOID String data type containing the Object Identifier for the ES request - a required input parameter.
static int	PRESENT_PERMISSION Integer data type defining the permissions value for present.
DataDir	requestTaskPackage DataDir object containing the client request input task package of the ES request - a required input parameter.
DataDir	responseOtherInformation DataDir object containing the OtherInformation data for the ES response.
DataDir	responseTaskPackage DataDir object containing the response task package from the ES request.
int	retentionScaleFactor Integer data type containing the retention time scale factor to be associated with the retentionTime value for the ES request - an optional input parameter.
int	retentionTimeValue Integer data type containing the retention time value for the ES request - an optional input parameter.
String	retentionUnit String data type containing the retention time unit to be associated with the retentionTime value for the ES request - an optional parameter.
String	retentionUnitSystem String data type containing the retention time unit system to be associated with the retentionTime value for the ES request - an optional input parameter.
String	retentionUnitType String data type containing the retention time unit type to be associated with the retentionTime value for the ES request - an optional parameter.
String	userId String data type containing the userId for the ES request - an optional input parameter.
static int	WAIT Integer data type defining the value for the wait type waitAction.
static int	WAIT_IF_POSSIBLE Integer data type defining the value for the waitIfPossible type waitAction.
int	waitAction Integer data type containing the wait action value for the ES request - an optional input parameter.

Constructor Summary

ExtSvcData()
Constructs an ExtSvcDataObject.

Method Summary

String

toString() Generates a String representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

function

public int function

Integer data type defining the ES function (create, modify, or delete) - a required input parameter.

packageTypeOID

public String packageTypeOID

String data type containing the Object Identifier for the ES request - a required input parameter.

requestTaskPackage

public DataDir requestTaskPackage

DataDir object containing the client request input task package of the ES request - a required input parameter.

packageName

public String packageName

String data type containing the package name for the ES request - an optional input parameter.

userId

public String userId

String data type containing the userId for the ES request - an optional input parameter.

retentionTimeValue

public int retentionTimeValue

Integer data type containing the retention time value for the ES request - an optional input parameter.

retentionUnitSystem

public String retentionUnitSystem

String data type containing the retention time unit system to be associated with the retentionTime value for the ES request - an optional input parameter.

retentionUnitType

public String retentionUnitType

String data type containing the retention time unit type to be associated with the retentionTime value for the ES request - an optional parameter.

retentionUnit

public String retentionUnit

String data type containing the retention time unit to be associated with the retentionTime value for the ES request - an optional parameter.

retentionScaleFactor

public int retentionScaleFactor

Integer data type containing the retention time scale factor to be associated with the retentionTime value for the ES request - an optional input parameter.

allowableFunctionsForPermissions

public int allowableFunctionsForPermissions

Integer data type containing the allowable functions for permissions in the ES request - an optional input parameter.

description

public String description

String data type containing the description for the ES request - an optional input parameter.

waitAction

public int waitAction

Integer data type containing the wait action value for the ES request - an optional input parameter.

elementSetName

public String elementSetName

String data type containing the Element Set Name value for the ES request - an optional input parameter.

otherInformation

public DataDir otherInformation

DataDir object containing the OtherInformation data for the ES request - an optional input parameter.

otherInformationOID

public String otherInformationOID

String data type containing the Object Identifier (OID) for the OtherInformation data for the ES request - an optional input parameter, but required when specifying the OtherInformation data.

responseTaskPackage

public DataDir responseTaskPackage

DataDir object containing the response task package from the ES request.

diagnostic

public Diagnostic1 diagnostic

Diagnostic1 object from the ES server response.

operationStatus

public int operationStatus

Integer data type containing the operation status from the ES response.

responseOtherInformation

public DataDir responseOtherInformation

DataDir object containing the OtherInformation data for the ES response.

CREATE_FUNCTION

public static final int CREATE_FUNCTION

Integer data type defining the value for the create function.

DELETE_FUNCTION

public static final int DELETE_FUNCTION

Integer data type defining the value for the delete function.

MODIFY_FUNCTION

public static final int MODIFY_FUNCTION

Integer data type defining the value for the modify function.

WAIT

public static final int WAIT

Integer data type defining the value for the wait type waitAction.

WAIT_IF_POSSIBLE

public static final int WAIT_IF_POSSIBLE

Integer data type defining the value for the waitIfPossible type waitAction.

DONT_WAIT

public static final int DONT_WAIT

Integer data type defining the value for the dontWait type waitAction.

DONT_RETURN_PACKAGE

public static final int DONT_RETURN_PACKAGE

Integer data type defining the value for the dontReturnPackage type waitAction.

DELETE_PERMISSION

public static final int DELETE_PERMISSION

Integer data type defining the permissions value for delete.

MODIFY_CONTENTS_PERMISSION

public static final int MODIFY_CONTENTS_PERMISSION

Integer data type defining the permissions value for modifyContents.

MODIFY_PERMISSIONS

public static final int MODIFY_PERMISSIONS

Integer data type defining the permissions value for modify.

PRESENT_PERMISSION

public static final int PRESENT_PERMISSION

Integer data type defining the permissions value for present.

INVOKE_PERMISSION

public static final int INVOKE_PERMISSION

Integer data type defining the permissions value for invoke.

Constructor Detail

ExtSvcData

public ExtSvcData()

Constructs an ExtSvcDataObject.

Method Detail

toString

public final String toString()

Generates a String representation of the object.

Overrides:

toString in class Object