Skip navigation links

com.essbase.eas.framework.defs.command
Class CommandResult

java.lang.Object
com.essbase.eas.framework.defs.command.CommandResult

public class CommandResult

extends java.lang.Object

Encapsulates the information returned by sending a command to a server through the framework command packages.

Since:

7.0.0

Version:

7.1.0

Author:

Hank Cox

Constructor Summary

CommandResult(java.lang.Class xtoClass, java.lang.Class msgClass, java.io.InputStream is)
Creates a command result object with given the raw results and the class of the expected xmltransfer object.

CommandResult(java.lang.Class xtoClass, java.lang.String results)
Creates a command result object with given the raw results and the class of the expected xmltransfer object.

Method Summary

void	clear() removes references to contained objects.
void	clearDeep() removes references to contained objects and clears contained objects.
void	dispose()
BinaryMessage	getBinaryMessage() returns the binary message results object.
java.io.InputStream	getInputStream()
java.lang.String	getRawResults() returns the raw results for this command result.
XMLTransferObject	getTransferObject() Returns the XMLTransferObject instance that contains the parsed results of the command.
void	setInputStream(java.io.InputStream inp)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandResult

public CommandResult(java.lang.Class xtoClass,
                     java.lang.String results)

Creates a command result object with given the raw results and the class of the expected xmltransfer object.

Parameters:

xtoClass - the class of the expected XMLTransferObject. If this value is null or is not a class that is assignable from XMLTransferObject, then XMLTransferObject will be used and no exception or error will be displayed.

results - the raw results from invoking the command.

CommandResult

public CommandResult(java.lang.Class xtoClass,
                     java.lang.Class msgClass,
                     java.io.InputStream is)

Creates a command result object with given the raw results and the class of the expected xmltransfer object.

Parameters:

xtoClass - the class of the expected XMLTransferObject. If this value is null or is not a class that is assignable from XMLTransferObject, then XMLTransferObject will be used and no exception or error will be displayed.

msgClass - the class of the expected BinaryMessage object.

is - for future use

Method Detail

getTransferObject

public XMLTransferObject getTransferObject()

Returns the XMLTransferObject instance that contains the parsed results of the command.

Returns:

returns the XMLTransferObject for this result

getRawResults

public java.lang.String getRawResults()

returns the raw results for this command result.

Returns:

the String representing hte eaw results

setInputStream

public void setInputStream(java.io.InputStream inp)

getInputStream

public java.io.InputStream getInputStream()

getBinaryMessage

public BinaryMessage getBinaryMessage()

returns the binary message results object.

Returns:

the BinaryMessage object as result

clear

public void clear()

removes references to contained objects. This method will be invoked by the framework after the results are routed to the correct listener object.

clearDeep

public void clearDeep()

removes references to contained objects and clears contained objects.

dispose

public void dispose()

Skip navigation links