Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkXDOBase

All Superinterfaces:
dkDataObjectBase
All Known Subinterfaces:
dkXDO

public interface dkXDOBase
extends dkDataObjectBase

dkXDOBase: an abstract class that represents a data value, ranging from a simple UDT (User Defined Type) to a complex LOB(Large Object).


Method Summary
 boolean equals(dkXDOBase aXDOBase)
          Check if the objects have the same value
 java.lang.String getOpenHandler()
          Gets the current program name of the handler for this object instance
 boolean isNull()
          Checks if the part content is null (in memory).
 boolean isOpenSynchronous()
          Gets the current synchronization property
 boolean notEqual(dkXDOBase aXDOBase)
           
 void open()
          Unloads the object content to a client file with a system generated name and then synchronously invoking a default handler against the file.
 void open(java.lang.String afileName)
          Unloads the object content to a file afileName provided by the application and then synchronously invoking a default handler against the file.
 short protocol()
          Returns the protocol supported by this object.
 void setClassOpenHandler(java.lang.String ahandler, boolean newSynchronousFlag)
          Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object class
 void setInstanceOpenHandler(java.lang.String ahandler, boolean newSynchronousFlag)
          Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object instant
 void setNull()
          Sets the part content to null (in memory).
 
Methods inherited from interface com.ibm.mm.sdk.common.dkDataObjectBase
getObjectType, getParent, getRootObject, setParent, setRootObject
 

Method Detail

setNull

public void setNull()
Sets the part content to null (in memory).

isNull

public boolean isNull()
Checks if the part content is null (in memory).
Returns:
true if the object content is null; false otherwise.

equals

public boolean equals(dkXDOBase aXDOBase)
               throws DKException
Check if the objects have the same value
Parameters:
adkXDOBase - an instance of dkXDOBase
Returns:
true if the objects have the same value false otherwise.
Throws:
DKException, - Exception If error occurred

notEqual

public boolean notEqual(dkXDOBase aXDOBase)
                 throws DKException

protocol

public short protocol()
Returns the protocol supported by this object.
Specified by:
protocol in interface dkDataObjectBase
Following copied from interface: com.ibm.mm.sdk.common.dkDataObjectBase
Returns:
the protocol

open

public void open()
          throws DKException,
                 java.lang.Exception
Unloads the object content to a client file with a system generated name and then synchronously invoking a default handler against the file.

Note:DKUsageError exception thrown if method is not implemented

Throws:
DKException, - Exception If error occurred

open

public void open(java.lang.String afileName)
          throws DKException,
                 java.lang.Exception
Unloads the object content to a file afileName provided by the application and then synchronously invoking a default handler against the file.

Note:DKUsageError exception thrown if method is not implemented

Parameters:
afileName - a provided file name
Throws:
DKException, - Exception If error occurred

setInstanceOpenHandler

public void setInstanceOpenHandler(java.lang.String ahandler,
                                   boolean newSynchronousFlag)
Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object instant
Parameters:
ahandler - the handler program name to view the content
newSynchronousFlag - true for synchronous process; false otherwise.

setClassOpenHandler

public void setClassOpenHandler(java.lang.String ahandler,
                                boolean newSynchronousFlag)
Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object class
Parameters:
ahandler - the handler program name to view the content
newSynchronousFlag - true for synchronous process; false otherwise.

getOpenHandler

public java.lang.String getOpenHandler()
Gets the current program name of the handler for this object instance
Returns:
the handler program name

isOpenSynchronous

public boolean isOpenSynchronous()
Gets the current synchronization property
Returns:
TRUE or FALSE for the handler

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.