com.ibm.cics.gen.api
Interface IAssistantResponse


public interface IAssistantResponse

This interface is used to return information from the Web services assistant to the caller of the API.


Field Summary
static java.lang.String COPYRIGHT
           
static int RC_ERROR
          The error return code.
static int RC_INVALID_PARAMETERS
          The invalid parameters return code.
static int RC_SUCCESS
          The success return code.
static int RC_WARNING
          The warning return code.
static java.lang.String SCCSID
          CICS SCCSID String
 
Method Summary
 java.lang.String[] getAllMessages()
          Get all of the messages that have been issued by the Web services assistant.
 java.lang.String[] getErrorMessages()
          Get all of the error messages that have been issued by the Web services assistant.
 java.lang.String[] getInformationalMessages()
          Get all of the informational messages that have been issued by the Web services assistant.
 int getReturnCode()
          Get the return code following an execution of the Web services assistant.
 java.lang.String[] getStatusMessages()
          Get all of the status messages that have been issued by the Web services assistant.
 java.lang.String[] getWarningMessages()
          Get all of the warning messages that have been issued by the Web services assistant.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

SCCSID

public static final java.lang.String SCCSID
CICS SCCSID String

See Also:
Constant Field Values

RC_SUCCESS

public static final int RC_SUCCESS
The success return code. This implies that the Assistant has executed successfully.

See Also:
Constant Field Values

RC_WARNING

public static final int RC_WARNING
The warning return code. This implies that the Assistant has executed with warnings. The output files may or may not be suitable for use.

See Also:
Constant Field Values

RC_INVALID_PARAMETERS

public static final int RC_INVALID_PARAMETERS
The invalid parameters return code. This implies that the Assistant has executed with errors due to a mismatch or mistake in the supplied IAssistantParameters object. The output files are not suitable for use.

See Also:
Constant Field Values

RC_ERROR

public static final int RC_ERROR
The error return code. This implies that the Assistant has executed with errors. The output files are not suitable for use.

See Also:
Constant Field Values
Method Detail

getReturnCode

public int getReturnCode()
Get the return code following an execution of the Web services assistant. The possible return codes are: RC_ERROR, RC_INVALID_PARAMETERS, RC_WARNING, RC_SUCCESS.

Returns:
Returns the assistant completion code

getAllMessages

public java.lang.String[] getAllMessages()
Get all of the messages that have been issued by the Web services assistant.

Returns:
Returns all status, informational, warning and error type messages.

getStatusMessages

public java.lang.String[] getStatusMessages()
Get all of the status messages that have been issued by the Web services assistant.

Returns:
Returns all status messages.

getInformationalMessages

public java.lang.String[] getInformationalMessages()
Get all of the informational messages that have been issued by the Web services assistant.

Returns:
Returns all information messages.

getWarningMessages

public java.lang.String[] getWarningMessages()
Get all of the warning messages that have been issued by the Web services assistant.

Returns:
Returns all warning messages.

getErrorMessages

public java.lang.String[] getErrorMessages()
Get all of the error messages that have been issued by the Web services assistant.

Returns:
Returns all error messages.