com.ibm.websphere.naming
Interface WsnBatchResult

public interface WsnBatchResult

An instance of this interface consists of the input and results for one JNDI operation on a com.ibm.websphere.naming.WsnBatchModeContext context. This interface contains "get" methods for the operation name, all possible parameters, the return value, a success/failure indicator, and the exception thrown, if any.

See Also:
WsnBatchCompleteResults, WsnBatchModeContext

Field Summary
static int BIND
          Constant returned by getOperation() which indicates that the results contained in this object are from a bind operation.
static int CREATESUBCONTEXT
          Constant returned by getOperation() which indicates that the results contained in this object are from a createSubcontext operation.
static int DESTROYSUBCONTEXT
          Constant returned by getOperation() which indicates that the results contained in this object are from a destroySubcontext operation.
static int LOOKUP
          Constant returned by getOperation() which indicates that the results contained in this object are from a lookup operation.
static int REBIND
          Constant returned by getOperation() which indicates that the results contained in this object are from a rebind operation.
static int RENAME
          Constant returned by getOperation() which indicates that the results contained in this object are from a rename operation.
static int UNBIND
          Constant returned by getOperation() which indicates that the results contained in this object are from a unbind operation.
 
Method Summary
 javax.naming.NamingException getException()
          Returns the exception thrown by the operation, if an exception was thrown.
 java.lang.Object getInputObject()
          Returns the java.lang.Object input parameter value.
 javax.naming.Name getName()
          Returns the javax.naming.Name input parameter value.
 javax.naming.Name getNewName()
          Returns the "new name" javax.naming.Name input parameter value.
 javax.naming.Name getOldName()
          Returns the "old name" javax.naming.Name input parameter value.
 int getOperation()
          Returns the batched operation type.
 java.lang.Object getOutputObject()
          Returns the Object result.
 boolean getResult()
          Indicates whether or not the operation was successful.
 javax.naming.Context getSubcontext()
          Returns the Context result.
 

Field Detail

LOOKUP

public static final int LOOKUP
Constant returned by getOperation() which indicates that the results contained in this object are from a lookup operation.

The value for this constant is 1.

See Also:
Constant Field Values

BIND

public static final int BIND
Constant returned by getOperation() which indicates that the results contained in this object are from a bind operation.

The value for this constant is 2.

See Also:
Constant Field Values

REBIND

public static final int REBIND
Constant returned by getOperation() which indicates that the results contained in this object are from a rebind operation.

The value for this constant is 3.

See Also:
Constant Field Values

UNBIND

public static final int UNBIND
Constant returned by getOperation() which indicates that the results contained in this object are from a unbind operation.

The value for this constant is 4.

See Also:
Constant Field Values

CREATESUBCONTEXT

public static final int CREATESUBCONTEXT
Constant returned by getOperation() which indicates that the results contained in this object are from a createSubcontext operation.

The value for this constant is 5.

See Also:
Constant Field Values

DESTROYSUBCONTEXT

public static final int DESTROYSUBCONTEXT
Constant returned by getOperation() which indicates that the results contained in this object are from a destroySubcontext operation.

The value for this constant is 6.

See Also:
Constant Field Values

RENAME

public static final int RENAME
Constant returned by getOperation() which indicates that the results contained in this object are from a rename operation.

The value for this constant is 7.

See Also:
Constant Field Values
Method Detail

getOperation

public int getOperation()
Returns the batched operation type.

Returns:
Returns the static final int of the operation requested, e.g. BIND, LOOKUP, etc.

getName

public javax.naming.Name getName()
                          throws javax.naming.NamingException
Returns the javax.naming.Name input parameter value. This parameter is specified on the following operations: bind, createSubcontext, destroySubcontext, lookup, rebind, rename, or unbind.

Returns:
the javax.naming.Name input parameter value.
Throws:
javax.naming.NamingException - if the value was not specified on input to the batch operation.

getOldName

public javax.naming.Name getOldName()
                             throws javax.naming.NamingException
Returns the "old name" javax.naming.Name input parameter value. This parameter is specified on rename operations.

Returns:
the "old name" javax.naming.Name input parameter value.
Throws:
javax.naming.NamingException - if the value was not specified on input to the batch operation.

getNewName

public javax.naming.Name getNewName()
                             throws javax.naming.NamingException
Returns the "new name" javax.naming.Name input parameter value. This parameter is specified on rename operations.

Returns:
the "new name" javax.naming.Name input parameter value.
Throws:
javax.naming.NamingException - if the value was not specified on input to the batch operation.

getSubcontext

public javax.naming.Context getSubcontext()
                                   throws javax.naming.NamingException
Returns the Context result. This result may be returned on the following operations: createSubcontext.

Returns:
the Context which resulted from the createSubcontext batch operation.
Throws:
javax.naming.NamingException - if the batch operation did not produce a return value.

getInputObject

public java.lang.Object getInputObject()
                                throws javax.naming.NamingException
Returns the java.lang.Object input parameter value. A java.lang.Object is input to the following operations: rebind.

Returns:
the java.lang.Object input parameter value to the batched rebind operation.
Throws:
javax.naming.NamingException - if the value was not specified on input to the batch operation.

getOutputObject

public java.lang.Object getOutputObject()
                                 throws javax.naming.NamingException
Returns the Object result. An Object may be returned on the following operations: lookup.

Returns:
Returns the object result of a batched lookup operation.
Throws:
javax.naming.NamingException - if the batch operation did not produce the specified value.

getResult

public boolean getResult()
Indicates whether or not the operation was successful.

Returns:
true if the operation was successul, false if an exception was thrown.

getException

public javax.naming.NamingException getException()
                                          throws javax.naming.NamingException
Returns the exception thrown by the operation, if an exception was thrown. If a call to getResult returns false, an exception was thrown. If no exception was thrown, getException throws a NamingException.

Returns:
the NamingException thrown during the batch operation.
Throws:
javax.naming.NamingException - if the batch operation did not result in an exception.

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.