com.ibm.websphere.naming

Interface WsnBatchResult


  1. 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

Modifier and Type Field and Description
  1. static
  2. int
BIND
Constant returned by getOperation() which indicates that the results contained in this object are from a bind operation.
  1. static
  2. int
CREATE_SUBCONTEXT
Constant returned by getOperation() which indicates that the results contained in this object are from a createSubcontext operation.
  1. static
  2. int
CREATESUBCONTEXT
Deprecated. see CREATE_SUBCONTEXT
  1. static
  2. int
DESTROY_SUBCONTEXT
Constant returned by getOperation() which indicates that the results contained in this object are from a destroySubcontext operation.
  1. static
  2. int
DESTROYSUBCONTEXT
Deprecated. see DESTROY_SUBCONTEXT
  1. static
  2. int
LOOKUP
Constant returned by getOperation() which indicates that the results contained in this object are from a lookup operation.
  1. static
  2. int
REBIND
Constant returned by getOperation() which indicates that the results contained in this object are from a rebind operation.
  1. static
  2. int
RENAME
Constant returned by getOperation() which indicates that the results contained in this object are from a rename operation.
  1. static
  2. int
UNBIND
Constant returned by getOperation() which indicates that the results contained in this object are from a unbind operation.

Method Summary

Modifier and Type Method and Description
  1. javax.naming.NamingException
getException()
Returns the exception thrown by the operation, if an exception was thrown.
  1. java.lang.Object
getInputObject()
Returns the java.lang.Object input parameter value.
  1. javax.naming.Name
getName()
Returns the javax.naming.Name input parameter value.
  1. javax.naming.Name
getNewName()
Returns the "new name" javax.naming.Name input parameter value.
  1. javax.naming.Name
getOldName()
Returns the "old name" javax.naming.Name input parameter value.
  1. int
getOperation()
Returns the batched operation type.
  1. java.lang.Object
getOutputObject()
Returns the Object result.
  1. boolean
getResult()
Indicates whether or not the operation was successful.
  1. javax.naming.Context
getSubcontext()
Returns the Context result.

Field Detail

LOOKUP

  1. 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:

BIND

  1. 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:

REBIND

  1. 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:

UNBIND

  1. 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:

CREATE_SUBCONTEXT

  1. static final int CREATE_SUBCONTEXT
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:

CREATESUBCONTEXT

  1. @Deprecated
  2. static final int CREATESUBCONTEXT
Deprecated. see CREATE_SUBCONTEXT
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:

DESTROY_SUBCONTEXT

  1. static final int DESTROY_SUBCONTEXT
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:

DESTROYSUBCONTEXT

  1. @Deprecated
  2. static final int DESTROYSUBCONTEXT
Deprecated. see DESTROY_SUBCONTEXT
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:

RENAME

  1. 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:

Method Detail

getOperation

  1. int getOperation()
Returns the batched operation type.
Returns:
Returns the static final int of the operation requested, e.g. BIND, LOOKUP, etc.

getName

  1. javax.naming.Name getName()
  2. 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

  1. javax.naming.Name getOldName()
  2. 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

  1. javax.naming.Name getNewName()
  2. 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

  1. javax.naming.Context getSubcontext( )
  2. 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

  1. java.lang.Object getInputObject( )
  2. 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

  1. java.lang.Object getOutputObject( )
  2. 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

  1. boolean getResult()
Indicates whether or not the operation was successful.
Returns:
true if the operation was successul, false if an exception was thrown.

getException

  1. javax.naming.NamingException getException( )
  2. 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.