oracle.calendar.soap.client
Class Error

java.lang.Object
oracle.calendar.soap.client.Error

public class Error

extends java.lang.Object

Provides all the information reported from the Calendaring Web Service, contained with a SOAP fault details. This object is not to be instantiated directly, but rather can be retrieved from a SOAP Fault object.

if (oracle.calendar.soap.client.CalendarUtils.isSOAPFault(bodyEntries))
{
  Fault soapFault = oracle.calendar.soap.client.CalendarUtils.getSOAPFault(bodyEntries);
  Error cwslError = oracle.calendar.soap.client.Error.unmarshall(soapFault);
}

The most valuable piece of information within this class is the Code element. This element represents a unique error that was triggerred server side. These include errors from OCAS, Calendar Server, Web services, OS RTL, or FCGI.

Field Summary

static java.lang.String	k_Author
static java.lang.String	k_Class
static java.lang.String	k_Code
static java.lang.String	k_Date
static java.lang.String	k_FileName
static java.lang.String	k_LastMod
static java.lang.String	k_Level
static java.lang.String	k_Line
static java.lang.String	k_PID
static java.lang.String	k_TID
static java.lang.String	k_Version

Constructor Summary

Error()
The default constructor for the object.

Method Summary

java.lang.String	getAuthor() Intentionally left blank.
java.lang.String	getCode() Returns the error class describing the OCAS error code.
java.lang.String	getDate() Returns the OCAS timestamp of when the error occurred.
java.lang.String	getErrorClass() Returns the error class describing the OCAS error.
java.lang.String	getFileName() Returns the original OCAS source code file.
java.lang.String	getLastMod() Returns the original OCAS source code file last modification timestamp.
java.lang.String	getLevel() Returns the event level at which the error was triggered.
java.lang.String	getLine() Returns the original OCAS line in the source code file.
java.lang.String	getPID() Returns the OCAS process ID of the originating FCGI application.
java.lang.String	getTID() Returns the OCAS thread ID of the originating FCGI application.
java.lang.String	getVersion() Returns the original OCAS source code file version.
static Error	unmarshall(org.apache.soap.Fault in_fault) Creates an Error object instance from the information found in a SOAP fault details XML DOM.

Methods inherited from class java.lang.Object

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

Field Detail

k_Date

public static final java.lang.String k_Date

See Also:

Constant Field Values

k_PID

public static final java.lang.String k_PID

See Also:

Constant Field Values

k_TID

public static final java.lang.String k_TID

See Also:

Constant Field Values

k_Level

public static final java.lang.String k_Level

See Also:

Constant Field Values

k_Class

public static final java.lang.String k_Class

See Also:

Constant Field Values

k_Code

public static final java.lang.String k_Code

See Also:

Constant Field Values

k_Line

public static final java.lang.String k_Line

See Also:

Constant Field Values

k_FileName

public static final java.lang.String k_FileName

See Also:

Constant Field Values

k_Version

public static final java.lang.String k_Version

See Also:

Constant Field Values

k_LastMod

public static final java.lang.String k_LastMod

See Also:

Constant Field Values

k_Author

public static final java.lang.String k_Author

See Also:

Constant Field Values

Constructor Detail

Error

public Error()

The default constructor for the object. version 2002-12-16 fix008343

Method Detail

getDate

public java.lang.String getDate()

Returns the OCAS timestamp of when the error occurred. version 2002-12-16 fix008343

Returns:

String

getPID

public java.lang.String getPID()

Returns the OCAS process ID of the originating FCGI application. version 2002-12-16 fix008343

Returns:

String

getTID

public java.lang.String getTID()

Returns the OCAS thread ID of the originating FCGI application. version 2002-12-16 fix008343

Returns:

String

getLevel

public java.lang.String getLevel()

Returns the event level at which the error was triggered. version 2002-12-16 fix008343

Returns:

String

getErrorClass

public java.lang.String getErrorClass()

Returns the error class describing the OCAS error. version 2002-12-16 fix008343

Returns:

String

getCode

public java.lang.String getCode()

Returns the error class describing the OCAS error code. This code should be used to map specific user interface messages. version 2002-12-16 fix008343

Returns:

String

getLine

public java.lang.String getLine()

Returns the original OCAS line in the source code file. This is used for locating the source of a problem. version 2002-12-16 fix008343

Returns:

String

getFileName

public java.lang.String getFileName()

Returns the original OCAS source code file. This is used for locating the source of a problem. version 2002-12-16 fix008343

Returns:

String

getVersion

public java.lang.String getVersion()

Returns the original OCAS source code file version. This is used for locating the source of a problem. version 2002-12-16 fix008343

Returns:

String

getLastMod

public java.lang.String getLastMod()

Returns the original OCAS source code file last modification timestamp. This is used for locating the source of a problem. version 2002-12-16 fix008343

Returns:

String

getAuthor

public java.lang.String getAuthor()

Intentionally left blank. version 2002-12-16 fix008343

Returns:

String

unmarshall

public static Error unmarshall(org.apache.soap.Fault in_fault)

Creates an Error object instance from the information found in a SOAP fault details XML DOM. It is possible that the Error object is empty; SOAP faults may be generated without details. version 2002-12-16 fix008343

Parameters:

in_fault - SOAP fault object

Returns:

Error - new Error object