com.ibm.uddi.response
Class DispositionReport

java.lang.Object
  |
  +--com.ibm.uddi.UDDIElement
        |
        +--com.ibm.uddi.response.DispositionReport

public class DispositionReport
extends UDDIElement

Represents an UDDI defined error. This object is returned from certain UDDI API calls. Other UDDI APIs return a data object if success and generate a fault message if failure. The API returns the fault by throwing a UDDIException.

UDDIException usually contains a Disposition report that has detailed information about the UDDI error as defined by the UDDI specification. If the response is a SOAP fault, but does not contains a disposition report, a UDDIException may be thrown without containing a DispositionReport.

This class contains defines for the various error values that can be returned.


Field Summary
static java.lang.String E_accountLimitExceeded
          signifies that user account limits have been exceeded.
static java.lang.String E_authTokenExpired
          signifies that the authentication token value passed in the authInfo argument is no longer valid because the token has expired.
static java.lang.String E_authTokenRequired
          signifies that the authentication token value passed in the authInfo argument is either missing or is not valid.
static java.lang.String E_categorizationNotAllowed
          Restrictions have been placed by the taxonomy provider on the types of information that should be included at that location within a specific taxonomy.
static java.lang.String E_invalidCategory
          signifies that the given keyValue did not correspond to a category within the taxonomy identified by a tModelKey value within one of the categoryBag elements provided.
static java.lang.String E_invalidKeyPassed
          signifies that the request cannot be satisfied because one or more uuid_key values specified is not a valid key value.
static java.lang.String E_invalidURLPassed
          an error occurred with one of the uploadRegister URL values.
static java.lang.String E_keyRetired
          signifies that the request cannot be satisfied because one or more uuid_key values specified has previously been hidden or removed by the requester.
static java.lang.String E_operatorMismatch
          signifies that one or more of the uuid_key values passed refers to data that is not controlled by the Operator Site that received the request for processing.
static java.lang.String E_userMismatch
          signifies that one or more of the uuid_key values passed refers to data that is not controlled by the individual who is represented by the authentication token.
static java.lang.String UDDI_TAG
           
 
Fields inherited from class com.ibm.uddi.UDDIElement
GENERIC, XMLNS
 
Constructor Summary
DispositionReport(org.w3c.dom.Element el)
          Constructer that parses the XML dom tree and extracts useful attributes.
 
Method Summary
 java.lang.String getErrCode()
           
 java.lang.String getErrInfoText()
           
 int getErrno()
           
 java.lang.String getGeneric()
           
 java.lang.String getOperator()
           
 boolean isValidElement(org.w3c.dom.Element el)
          Tests the passed in element to determine if the element is a serialized version of this object.
 void saveToXML(org.w3c.dom.Element el)
           
 boolean success()
           
 
Methods inherited from class com.ibm.uddi.UDDIElement
getChildElementsByTagName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UDDI_TAG

public static java.lang.String UDDI_TAG

E_authTokenExpired

public static final java.lang.String E_authTokenExpired
signifies that the authentication token value passed in the authInfo argument is no longer valid because the token has expired.

E_authTokenRequired

public static final java.lang.String E_authTokenRequired
signifies that the authentication token value passed in the authInfo argument is either missing or is not valid.

E_keyRetired

public static final java.lang.String E_keyRetired
signifies that the request cannot be satisfied because one or more uuid_key values specified has previously been hidden or removed by the requester. This specifically applies to the tModelKey values passed.

E_invalidKeyPassed

public static final java.lang.String E_invalidKeyPassed
signifies that the request cannot be satisfied because one or more uuid_key values specified is not a valid key value. This will occur if a uuid_key value is passed in a tModel that does not match with any known tModel key.

E_invalidURLPassed

public static final java.lang.String E_invalidURLPassed
an error occurred with one of the uploadRegister URL values.

E_userMismatch

public static final java.lang.String E_userMismatch
signifies that one or more of the uuid_key values passed refers to data that is not controlled by the individual who is represented by the authentication token.

E_operatorMismatch

public static final java.lang.String E_operatorMismatch
signifies that one or more of the uuid_key values passed refers to data that is not controlled by the Operator Site that received the request for processing.

E_invalidCategory

public static final java.lang.String E_invalidCategory
signifies that the given keyValue did not correspond to a category within the taxonomy identified by a tModelKey value within one of the categoryBag elements provided.

E_categorizationNotAllowed

public static final java.lang.String E_categorizationNotAllowed
Restrictions have been placed by the taxonomy provider on the types of information that should be included at that location within a specific taxonomy. The validation routine chosen by the Operator Site has rejected this tModel for at least one specified category.

E_accountLimitExceeded

public static final java.lang.String E_accountLimitExceeded
signifies that user account limits have been exceeded.
Constructor Detail

DispositionReport

public DispositionReport(org.w3c.dom.Element el)
                  throws UDDIException
Constructer that parses the XML dom tree and extracts useful attributes.
Parameters:
el - Root element of the tree within the SOAP body.
Method Detail

getGeneric

public java.lang.String getGeneric()

getOperator

public java.lang.String getOperator()

success

public boolean success()

getErrno

public int getErrno()

getErrCode

public java.lang.String getErrCode()

getErrInfoText

public java.lang.String getErrInfoText()

isValidElement

public boolean isValidElement(org.w3c.dom.Element el)
Tests the passed in element to determine if the element is a serialized version of this object.
Parameters:
el - Root element for this object

saveToXML

public void saveToXML(org.w3c.dom.Element el)
Overrides:
saveToXML in class UDDIElement