com.businessobjects.dsws
Interface DSWSException

public interface DSWSException

The DSWSException interface is an exception interface of the Business Objects Web Services. The purpose of this interface is to throw an exception thay may occur in the code. For example, getOperation retrieves the method that has caused an exception.

Example: Retrieve the exception message produced by the Web Services SDK.

 try
 {
          // write web service code
 }
catch(AxisFault af)
        {
                DSWSException d = Consumer.GetAxisFaultDetails(af);
                if (d!=null)
                {
                        String afString = "exception caught
";
     afString += d.getCauseID();
            afString += ".
";
     afString += d.getCauseException();
     afString += ".
";
     out.println(afString);
                }
else
                {
                 System.out.println(af.toString());
                }
        }
 

Nested Class Summary

static class

DSWSException.Factory A class with methods for creating instances of the DSWSException type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

java.lang.String	getCallStackTrace() Returns the CallStackTrace element.
java.lang.String	getCauseDetail() Retrieve more explanations about the exception cause.
java.lang.String	getCauseException() Retrieve the name of the class that caused the exception.
java.lang.String	getCauseID() Retrieve the exception cause id.
java.lang.String	getCauseMessage() Retrieves the exception message produced by the underlying Enterprise SDK.
java.lang.String	getID() Retrieve the exception id.
java.lang.String	getMessage() Retrieves the exception message produced by the Web Services SDK.
java.lang.String	getOperation() Retrieve the web service operation that caused the exception.
boolean	isNilCallStackTrace() Checks if the CallStackTrace element is set to Nil.
boolean	isNilCauseDetail() Checks if the CauseDetail element has been set to Nil.
boolean	isNilCauseException() Checks if the CauseException element is nil.
boolean	isNilCauseID() Checks if the CauseID element has been set to Nil.
boolean	isNilCauseMessage() Checks if the CauseMessage element has been set to Nil.
boolean	isSetCallStackTrace() Checks if the CallStackTrace element has been set.
boolean	isSetCauseDetail() Checks if the CauseDetail element has been set.
boolean	isSetCauseException() Checks if the CauseException element has been set.
boolean	isSetCauseID() Checks if the CauseID element has been set.
boolean	isSetCauseMessage() Checks if the CauseMessage element has been set.
void	setCallStackTrace(java.lang.String callStackTrace) Sets the CallStackTrace element.
void	setCauseDetail(java.lang.String causeDetail) Set more explanation about the exception cause.
void	setCauseException(java.lang.String causeException) Set the name of the class that caused the exception.
void	setCauseID(java.lang.String causeID) Set the exception cause id.
void	setCauseMessage(java.lang.String causeMessage) Sets the exception message produced by the underlying Enterprise SDK.
void	setID(java.lang.String id) Set the exception id.
void	setMessage(java.lang.String message) Sets the exception message produced by the Web Services SDK.
void	setNilCallStackTrace() Nils the CallStackTrace element.
void	setNilCauseDetail() Nils the CauseDetail element.
void	setNilCauseException() Nils the CauseException element.
void	setNilCauseID() Nils the CauseID element.
void	setNilCauseMessage() Nils the CauseMessage element.
void	setOperation(java.lang.String operation) Set the web service operation that caused the exception.
void	unsetCallStackTrace() Deletes or unsets the CallStackTrace element.
void	unsetCauseDetail() Deletes or unsets the CauseDetail element.
void	unsetCauseException() Deletes or unsets the CauseException element.
void	unsetCauseID() Deletes or unsets the CauseID element.
void	unsetCauseMessage() Deletes or unsets the CauseMessage element.
org.apache.xmlbeans.XmlString	xgetCallStackTrace() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetCauseDetail() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetCauseException() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetCauseID() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetCauseMessage() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetID() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetMessage() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetOperation() Internal Use Only.
void	xsetCallStackTrace(org.apache.xmlbeans.XmlString callStackTrace) Internal Use Only.
void	xsetCauseDetail(org.apache.xmlbeans.XmlString causeDetail) Internal Use Only.
void	xsetCauseException(org.apache.xmlbeans.XmlString causeException) Internal Use Only.
void	xsetCauseID(org.apache.xmlbeans.XmlString causeID) Internal Use Only.
void	xsetCauseMessage(org.apache.xmlbeans.XmlString causeMessage) Internal Use Only.
void	xsetID(org.apache.xmlbeans.XmlString id) Internal Use Only.
void	xsetMessage(org.apache.xmlbeans.XmlString message) Internal Use Only.
void	xsetOperation(org.apache.xmlbeans.XmlString operation) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getID

java.lang.String getID()

Retrieve the exception id.

Returns:

String containing the exception id.

xgetID

org.apache.xmlbeans.XmlString xgetID()

Internal Use Only.

setID

void setID(java.lang.String id)

Set the exception id.

Parameters:

id - A String that contains the exception id.

xsetID

void xsetID(org.apache.xmlbeans.XmlString id)

Internal Use Only.

getMessage

java.lang.String getMessage()

Retrieves the exception message produced by the Web Services SDK.

Returns:

A String that contains the exception message produced by the Web Services SDK.

xgetMessage

org.apache.xmlbeans.XmlString xgetMessage()

Internal Use Only.

setMessage

void setMessage(java.lang.String message)

Sets the exception message produced by the Web Services SDK.

Parameters:

message - A String that contains the exception message produced by the Web Services SDK.

xsetMessage

void xsetMessage(org.apache.xmlbeans.XmlString message)

Internal Use Only.

getOperation

java.lang.String getOperation()

Retrieve the web service operation that caused the exception.

Returns:

A String that contains the web service operation that caused the exception.

Throws:

None

xgetOperation

org.apache.xmlbeans.XmlString xgetOperation()

Internal Use Only.

setOperation

void setOperation(java.lang.String operation)

Set the web service operation that caused the exception.

Parameters:

operation - A String that contains the web service operation name.

xsetOperation

void xsetOperation(org.apache.xmlbeans.XmlString operation)

Internal Use Only.

getCallStackTrace

java.lang.String getCallStackTrace()

Returns the CallStackTrace element.

Returns:

A String that contains the CallStackTrace element.

xgetCallStackTrace

org.apache.xmlbeans.XmlString xgetCallStackTrace()

Internal Use Only.

isNilCallStackTrace

boolean isNilCallStackTrace()

Checks if the CallStackTrace element is set to Nil.

Returns:

true if the CallStackTrace element has been set to nil,otherwise false.

isSetCallStackTrace

boolean isSetCallStackTrace()

Checks if the CallStackTrace element has been set.

Returns:

true if the CallStackTrace element has been set,otherwise false.

setCallStackTrace

void setCallStackTrace(java.lang.String callStackTrace)

Sets the CallStackTrace element.

Parameters:

callStackTrace - String containing the web service operation name.

xsetCallStackTrace

void xsetCallStackTrace(org.apache.xmlbeans.XmlString callStackTrace)

Internal Use Only.

setNilCallStackTrace

void setNilCallStackTrace()

Nils the CallStackTrace element.

unsetCallStackTrace

void unsetCallStackTrace()

Deletes or unsets the CallStackTrace element.

getCauseException

java.lang.String getCauseException()

Retrieve the name of the class that caused the exception.

Returns:

A String that contains the name of the class that caused the exception.

xgetCauseException

org.apache.xmlbeans.XmlString xgetCauseException()

Internal Use Only.

isNilCauseException

boolean isNilCauseException()

Checks if the CauseException element is nil.

Returns:

true if the CauseException element has been set to nil,otherwise false.

isSetCauseException

boolean isSetCauseException()

Checks if the CauseException element has been set.

Returns:

true if the CauseException element has been set,otherwise false.

setCauseException

void setCauseException(java.lang.String causeException)

Set the name of the class that caused the exception.

Parameters:

causeException - A String that contains the name of the class that caused the exception.

xsetCauseException

void xsetCauseException(org.apache.xmlbeans.XmlString causeException)

Internal Use Only.

setNilCauseException

void setNilCauseException()

Nils the CauseException element.

unsetCauseException

void unsetCauseException()

Deletes or unsets the CauseException element.

getCauseID

java.lang.String getCauseID()

Retrieve the exception cause id.

Returns:

A String that contains the the cause id.

xgetCauseID

org.apache.xmlbeans.XmlString xgetCauseID()

Internal Use Only.

isNilCauseID

boolean isNilCauseID()

Checks if the CauseID element has been set to Nil.

Returns:

true if the CauseID element has been set to nil,otherwise false.

isSetCauseID

boolean isSetCauseID()

Checks if the CauseID element has been set.

Returns:

true if the CauseID element has been set,otherwise false.

setCauseID

void setCauseID(java.lang.String causeID)

Set the exception cause id.

Parameters:

causeID - String containing the cause id.

xsetCauseID

void xsetCauseID(org.apache.xmlbeans.XmlString causeID)

Internal Use Only.

setNilCauseID

void setNilCauseID()

Nils the CauseID element.

unsetCauseID

void unsetCauseID()

Deletes or unsets the CauseID element.

getCauseMessage

java.lang.String getCauseMessage()

Retrieves the exception message produced by the underlying Enterprise SDK.

Returns:

A String that contains the exception message produced by the underlying Enterprise SDK.

xgetCauseMessage

org.apache.xmlbeans.XmlString xgetCauseMessage()

Internal Use Only.

isNilCauseMessage

boolean isNilCauseMessage()

Checks if the CauseMessage element has been set to Nil.

Returns:

true if the CauseMessage element has been set to nil,otherwise false.

isSetCauseMessage

boolean isSetCauseMessage()

Checks if the CauseMessage element has been set.

Returns:

true if the CauseMessage element has been set,otherwise false.

setCauseMessage

void setCauseMessage(java.lang.String causeMessage)

Sets the exception message produced by the underlying Enterprise SDK.

Parameters:

causeMessage - A String that contains the exception message produced by the underlying Enterprise SDK.

xsetCauseMessage

void xsetCauseMessage(org.apache.xmlbeans.XmlString causeMessage)

Internal Use Only.

setNilCauseMessage

void setNilCauseMessage()

Nils the CauseMessage element.

unsetCauseMessage

void unsetCauseMessage()

Deletes or unsets the CauseMessage element.

getCauseDetail

java.lang.String getCauseDetail()

Retrieve more explanations about the exception cause.

Returns:

A String that contains more explanations about the exception cause.

xgetCauseDetail

org.apache.xmlbeans.XmlString xgetCauseDetail()

Internal Use Only.

isNilCauseDetail

boolean isNilCauseDetail()

Checks if the CauseDetail element has been set to Nil.

Returns:

true if the CauseDetail element has been set to nil,otherwise false.

isSetCauseDetail

boolean isSetCauseDetail()

Checks if the CauseDetail element has been set.

Returns:

true if the CauseDetail element has been set,otherwise false.

setCauseDetail

void setCauseDetail(java.lang.String causeDetail)

Set more explanation about the exception cause.

Parameters:

causeDetail - A String that contains more explanations about the exception cause.

xsetCauseDetail

void xsetCauseDetail(org.apache.xmlbeans.XmlString causeDetail)

Internal Use Only.

setNilCauseDetail

void setNilCauseDetail()

Nils the CauseDetail element.

unsetCauseDetail

void unsetCauseDetail()

Deletes or unsets the CauseDetail element.