com.ibm.task.api

Class IdWrongFormatException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.ibm.task.api.TaskException

com.ibm.task.api.IdWrongFormatException

All Implemented Interfaces:

java.io.Serializable

public class IdWrongFormatException
extends TaskException

Exception class for error message Api.IdWrongFormat.
Thrown when: The object ID passed has an incorrect format or is null.
User action: Pass a correct object ID.

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
	IdWrongFormatException(java.lang.Object[] vars) Constructor.
	IdWrongFormatException(java.lang.Object[] vars, java.lang.Throwable cause) Constructor.
protected	IdWrongFormatException(java.lang.String key, java.lang.Object[] vars, java.lang.String id, java.lang.Throwable cause) Constructor for subclasses only.
protected	IdWrongFormatException(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

IdWrongFormatException

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

Constructor.

Parameters:

vars - See IdWrongFormatException(Object[], Throwable)

IdWrongFormatException

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

Constructor.

Parameters:

vars - An array with 1 substitution variable for CWTKA0001E: The format of the ID ''{0}'' is invalid.
{0} is the ID that has the wrong format.

cause - The exception that was thrown.

IdWrongFormatException

protected IdWrongFormatException(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.

IdWrongFormatException

protected IdWrongFormatException(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.