Ruddi™ UDDI Client API
1.0

inspireit.uddi.response
Class DispositionReport

java.lang.Object
  |
  +--inspireit.uddi.response.DispositionReport
All Implemented Interfaces:
java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

public class DispositionReport
extends java.lang.Object
implements java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

DispositionReport represents a dispositionReport response message. Errors that are not reported by way of SOAP Faults are reported using the dispositionReport structure. This structure can be used to signal success for asynchronous requests as well.

Success Reporting with the dispositionReport structure

The general form of a success report is:

 <?xml version="1.0" encoding="UTF-8" ?>
 <Envelope xmlns="http://schemas.xmlsoaporg.org/soap/envelope/">
     <Body>
        <dispositionReport generic="1.0" operator="OperatorUrl" xmlns="urn:uddi-org:api " >
            <result errno="0" >
                <errInfo errCode="E_success" />
            </result>
        </dispositionReport>
     </Body>
 </Envelope>
Error reporting with the dispositionReport structure

All application errors are communicated via the use of the SOAP FAULT structure. The general form of an error report is:

 <?xml version="1.0" encoding="UTF-8" ?>
 <Envelope xmlns="http://schemas.xmlsoaporg.org/soap/envelope/">
     <Body>
         <Fault>
             <faultcode>Client</faultcode>
             <faultstring>Client Error</faultstring>
             <detail>
                 <dispositionReport generic="1.0" operator="OperatorUrl" xmlns="urn:uddi-org:api " >
                     <result errno="10050" >
                         <errInfo errCode="E_notSupported"> The findQualifier value passed is unrecognized. </errInfo>
                     </result>
                 </dispositionReport>
             </detail>
         </Fault>
     </Body>
 </Envelope>
Multiple result elements may be present within the dispositionReport structure, and can be used to provide very detailed error reports for multiple error conditions. The number of result elements returned within a disposition report is implementation specific. In general it is permissible to return an error response as soon as the first error in a request is detected.

Author:
Bertrand Fontaine, INSPIRE IT $Revision: 1.2 $
See Also:
Serialized Form

Field Summary
protected  java.lang.String generic
          The UDDI version in use.
protected  Operator operator
          The characteristics of the Operator Site.
protected  Results results
          The Results of the call.
protected  boolean truncated
          Whether the Operator Site has truncated or not the result set.
 
Constructor Summary
DispositionReport(Results results, boolean truncated)
          DispositionReport constructor.
DispositionReport(Results results, java.lang.String generic, Operator operator, boolean truncated)
          Deprecated. as of UDDI V3.0
 
Method Summary
 boolean equals(java.lang.Object o)
          Checks whether an object is equal to this DispositionReport.
 java.lang.String getGeneric()
          Deprecated. as of UDDI V3.0
 Operator getOperator()
          Deprecated. as of UDDI V3.0
 Results getResults()
          Gets the Results of the call.
 boolean isTruncated()
          Checks whether the Operator Site has truncated the result set.
 java.lang.Object visit(inspireit.uddi.util.visitors.UDDIVisitor visitor)
          Visits this UDDI element.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

results

protected Results results
The Results of the call.


generic

protected java.lang.String generic
The UDDI version in use.


operator

protected Operator operator
The characteristics of the Operator Site.


truncated

protected boolean truncated
Whether the Operator Site has truncated or not the result set.

Constructor Detail

DispositionReport

public DispositionReport(Results results,
                         java.lang.String generic,
                         Operator operator,
                         boolean truncated)
Deprecated. as of UDDI V3.0

DispositionReport constructor.

Parameters:
results - The Results of the call.
generic - The UDDI version in use.
operator - Operator object characterising the Operator Site.
truncated - Whether the Operator Site has truncated or not the result set.

DispositionReport

public DispositionReport(Results results,
                         boolean truncated)
DispositionReport constructor.

Parameters:
results - The Results of the call.
truncated - Whether the Operator Site has truncated or not the result set.
Since:
UDDI V3.0
Method Detail

getResults

public Results getResults()
Gets the Results of the call.

Returns:
the Results of the call

getGeneric

public java.lang.String getGeneric()
Deprecated. as of UDDI V3.0

Gets the UDDI version in use.

Returns:
the UDDI version in use

getOperator

public Operator getOperator()
Deprecated. as of UDDI V3.0

Gets the characteristics of the Operator Site.

Returns:
the characteristics of the Operator Site as an Operator object

isTruncated

public boolean isTruncated()
Checks whether the Operator Site has truncated the result set.

Returns:
true if the Operator Site has truncated the result set; false otherwise

visit

public java.lang.Object visit(inspireit.uddi.util.visitors.UDDIVisitor visitor)
Visits this UDDI element.

Specified by:
visit in interface inspireit.uddi.util.visitors.UDDIElement
Parameters:
visitor - The visiting UDDI object.

equals

public boolean equals(java.lang.Object o)
Checks whether an object is equal to this DispositionReport.

Overrides:
equals in class java.lang.Object
Parameters:
o - The object to test for equality.
Returns:
true if o and this DispositionReport are equal; false otherwise

Ruddi™ UDDI Client API
1.0

Download now! | Submit a bug or feature
(c) 2003 INSPIRE IT
Bld Brand Whitlock 109
1200 Brussels, Belgium
All Rights Reserved.