oracle.calendar.soap.client
Class Error

java.lang.Object
  |
  +--oracle.calendar.soap.client.Error

public class Error

extends java.lang.Object

The Error class 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. This code represents a unique error that was triggerred server side. These may be OCAS, Calendar Server, Web Services, OS RTL, FCGI, etc... errors.

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
private java.lang.String	m_author
private java.lang.String	m_class
private java.lang.String	m_code
private java.lang.String	m_date
private java.lang.String	m_fileName
private java.lang.String	m_lastMod
private java.lang.String	m_level
private java.lang.String	m_line
private java.lang.String	m_pid
private java.lang.String	m_tid
private java.lang.String	m_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() Return the original OCAS source code file.
java.lang.String	getLastMod() Return 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() Return the original OCAS source code file version.
static Error	unmarshall(org.apache.soap.Fault in_fault) This method is used to create an Error object instance from the information found in a SOAP fault details XML DOM.

Methods inherited from class java.lang.Object

<clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

k_Date

public static final java.lang.String k_Date

k_PID

public static final java.lang.String k_PID

k_TID

public static final java.lang.String k_TID

k_Level

public static final java.lang.String k_Level

k_Class

public static final java.lang.String k_Class

k_Code

public static final java.lang.String k_Code

k_Line

public static final java.lang.String k_Line

k_FileName

public static final java.lang.String k_FileName

k_Version

public static final java.lang.String k_Version

k_LastMod

public static final java.lang.String k_LastMod

k_Author

public static final java.lang.String k_Author

m_date

private java.lang.String m_date

m_pid

private java.lang.String m_pid

m_tid

private java.lang.String m_tid

m_level

private java.lang.String m_level

m_class

private java.lang.String m_class

m_code

private java.lang.String m_code

m_line

private java.lang.String m_line

m_fileName

private java.lang.String m_fileName

m_version

private java.lang.String m_version

m_lastMod

private java.lang.String m_lastMod

m_author

private java.lang.String m_author

Constructor Detail

Error

public Error()

The default constructor for the object.

Method Detail

getDate

public java.lang.String getDate()

Returns the OCAS timestamp of when the error occurred.

Returns:

String

getPID

public java.lang.String getPID()

Returns the OCAS process id of the originating FCGI application.

Returns:

String

getTID

public java.lang.String getTID()

Returns the OCAS thread id of the originating FCGI application.

Returns:

String

getLevel

public java.lang.String getLevel()

Returns the event level at which the error was triggered.

Returns:

String

getErrorClass

public java.lang.String getErrorClass()

Returns the error class describing the OCAS error.

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.

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.

Returns:

String

getFileName

public java.lang.String getFileName()

Return the original OCAS source code file. This is used for locating the source of a problem.

Returns:

String

getVersion

public java.lang.String getVersion()

Return the original OCAS source code file version. This is used for locating the source of a problem.

Returns:

String

getLastMod

public java.lang.String getLastMod()

Return the original OCAS source code file last modification timestamp. This is used for locating the source of a problem.

Returns:

String

getAuthor

public java.lang.String getAuthor()

Intentionally left blank.

Returns:

String

unmarshall

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

This method is used to create 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.

Parameters:

Fault - a SOAP fault object

Returns:

Error a new Error object