com.ibm.task.api

Class ParameterNullException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.ibm.task.api.TaskException

com.ibm.task.api.ParameterNullException

All Implemented Interfaces:

java.io.Serializable

public class ParameterNullException
extends TaskException

Exception class for error message Api.ParameterNull.
Thrown when: An attempt was made to call an API function and a mandatory parameter value is 'null'.
User action: Specify a parameter value that is not null.

Since:

5.1.1

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT

Constructor Summary

Constructors

Modifier	Constructor and Description
	ParameterNullException(java.lang.Object[] vars) Constructor.
	ParameterNullException(java.lang.Object[] vars, java.lang.Throwable cause) Constructor.
protected	ParameterNullException(java.lang.String key, java.lang.Object[] vars, java.lang.String id, java.lang.Throwable cause) Constructor for subclasses only.
protected	ParameterNullException(java.lang.String catalog, java.lang.String key, java.lang.Object[] vars, java.lang.String id, java.lang.Throwable cause) Constructor for subclasses only.

Method Summary

Methods inherited from class com.ibm.task.api.TaskException

getCause, getMessage, getMessage, getMessageID, getMessageKey, getMessageVariables, getRootCause, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

Constructor Detail

ParameterNullException

public ParameterNullException(java.lang.Object[] vars)

Constructor.

Parameters:

vars - See ParameterNullException(Object[], Throwable)

ParameterNullException

public ParameterNullException(java.lang.Object[] vars,
                      java.lang.Throwable cause)

Constructor.

Parameters:

vars - An array with 2 substitution variables for CWTKA0013E: The mandatory parameter ''{0}'' cannot be null in ''{1}''.
{0} is the name of the parameter
{1} is the name of the API method

cause - The exception that was thrown.

ParameterNullException

protected ParameterNullException(java.lang.String key,
                      java.lang.Object[] vars,
                      java.lang.String id,
                      java.lang.Throwable cause)

Constructor for subclasses only. It has package access so it does not show up in the public Javadoc.

Parameters:

key - The message key.

vars - The values of the message variables. Can be an empty array. If the array contains objects, they must be Serializable.

id - The message identifier.

cause - The exception that was thrown.

ParameterNullException

protected ParameterNullException(java.lang.String catalog,
                      java.lang.String key,
                      java.lang.Object[] vars,
                      java.lang.String id,
                      java.lang.Throwable cause)

Constructor for subclasses only. It has package access so it does not show up in the public Javadoc.

Parameters:

catalog - The catalog which have to be used to retrieve the message.

key - The message key.

vars - The values of the message variables. Can be an empty array. If the array contains objects, they must be Serializable.

id - The message identifier.

cause - The exception that was thrown.