org.uddi.api_v2

Class DispositionReport

java.lang.Object

org.uddi.api_v2.DispositionReport

public class DispositionReport
extends Object

Java class for dispositionReport complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="dispositionReport">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:uddi-org:api_v2}result" maxOccurs="unbounded"/>
       </sequence>
       <attribute name="generic" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="operator" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="truncated" type="{urn:uddi-org:api_v2}truncated" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	E_ACCOUNT_LIMIT_EXCEEDED E_accountLimitExceeded: (10160) Signifies that a save request exceeded the quantity limits for a given data type.
static String	E_ASSERTION_NOT_FOUND (30000) Signifies that a particular publisher assertion (consisting of two businessKey values, and a keyed reference with three components) cannot be identified in a save or delete operation.
static String	E_AUTH_TOKEN_EXPIRED E_authTokenExpired: (10110) Signifies that the authentication token information has timed out.
static String	E_AUTH_TOKEN_REQUIRED E_authTokenRequired: (10120) Signifies that an invalid authentication token was passed to an API call that requires authentication.
static String	E_BUSY E_busy: (10400) Signifies that the request cannot be processed at the current time.
static String	E_CATEGORIZATION_NOT_ALLOWED E_categorizationNotAllowed: (20100) RETIRED.
static String	E_FATAL_ERROR E_fatalError: (10500) Signifies that a serious technical error has occurred while processing the request.
static String	E_INVALID_CATEGORY Deprecated.
static String	E_INVALID_COMPLETION_STATUS E_invalidCompletionStatus: (30100) signifies that one of the assertion status values passed is unrecognized.
static String	E_INVALID_KEY_PASSED E_invalidKeyPassed: (10210) Signifies that the uuid_key value passed did not match with any known key values.
static String	E_INVALID_PROJECTION E_invalidProjection: (20230) Signifies that an attempt was made to save a businessEntity containing a service projection that does not match the businessService being projected.
static String	E_INVALID_URL_PASSED E_invalidURLPassed: (10220) DO NOT USE.
static String	E_INVALID_VALUE E_invalidValue: (20200) A value that was passed in a keyValue attribute did not pass validation.
static String	E_KEY_RETIRED E_keyRetired: (10310) DO NOT USE.
static String	E_LANGUAGE_ERROR E_languageError: (10060) Signifies that an error was detected while processing elements that were annotated with xml:lang qualifiers.
static String	E_MESSAGE_TOO_LARGE E_messageTooLarge: (30110) Signifies that the message is too large.
static String	E_NAME_TOO_LONG E_nameTooLong: (10020) RETIRED.
static String	E_OPERATOR_MISMATCH E_operatorMismatch: (10130) DO NOT USE.
static String	E_PUBLISHER_CANCELLED E_publisherCancelled: (30220) The target publisher cancelled the custody transfer operation.
static String	E_REQUEST_DENIED E_requestDenied: (30210) A custody transfer request has been refused.
static String	E_REQUEST_TIMEOUT E_requestTimeout: (20240) Signifies that the request could not be carried out because a needed web service, such as validate_values, did not respond in a reasonable amount of time.
static String	E_SECRET_UNKNOWN E_secretUnknown: (30230) The target publisher was unable to match the shared secret and the five (5) attempt limit was exhausted.
static String	E_SUCCESS E_success: (0) Signifies no failure occurred.
static String	E_TOO_MANY_OPTIONS E_tooManyOptions: (10030) Signifies that too many or incompatible arguments were passed.
static String	E_TRANSFER_ABORTED E_transferAborted: (30200) Signifies that a custody transfer request will not succeed.
static String	E_UNKNOWN_USER E_unknownUser: (10150) Signifies that the user ID and password pair passed in a get_authToken message is not known to the Operator Site or is not valid.
static String	E_UNRECOGNIZED_VERSION E_unrecognizedVersion: (10040) Signifies that the value of the generic attribute passed is unsupported by the Operator Instance being queried.
static String	E_UNSUPPORTED E_unsupported: (10050) Signifies that the implementer does not support a feature or API.
static String	E_UNVALIDATABLE E_unvalidatable: (20220) Signifies that an attempt was made to reference a taxonomy or identifier system in a keyedReference whose tModel is categorized with the unvalidatable categorization.
static String	E_USER_MISMATCH E_userMismatch: (10140) Signifies that an attempt was made to use the publishing API to change data that is controlled by another party.
static String	E_VALUE_NOT_ALLOWED E_valueNotAllowed: (20210) Signifies that a value did not pass validation because of contextual issues.
protected String	generic
protected String	operator
protected List<Result>	result
protected Truncated	truncated

Constructor Summary

Constructors

Constructor and Description
DispositionReport()
DispositionReport(Node firstChild)

Method Summary

Modifier and Type	Method and Description
boolean	countainsErrorCode(String errCodeKey) Determines if one of the Results in the this DispositionReport has a Error Code that matches the errCodeKey passed in.
String	getGeneric() Gets the value of the generic property.
String	getOperator() Gets the value of the operator property.
List<Result>	getResult() Gets the value of the result property.
Truncated	getTruncated() Gets the value of the truncated property.
void	setGeneric(String value) Sets the value of the generic property.
void	setOperator(String value) Sets the value of the operator property.
void	setTruncated(Truncated value) Sets the value of the truncated property.

Methods inherited from class java.lang.Object

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

Field Detail

result

protected List<Result> result

generic

protected String generic

operator

protected String operator

truncated

protected Truncated truncated

E_ASSERTION_NOT_FOUND

public static final transient String E_ASSERTION_NOT_FOUND

(30000) Signifies that a particular publisher assertion (consisting of two businessKey values, and a keyed reference with three components) cannot be identified in a save or delete operation.

See Also:

Constant Field Values

E_AUTH_TOKEN_EXPIRED

public static final transient String E_AUTH_TOKEN_EXPIRED

E_authTokenExpired: (10110) Signifies that the authentication token information has timed out.

See Also:

Constant Field Values

E_AUTH_TOKEN_REQUIRED

public static final transient String E_AUTH_TOKEN_REQUIRED

E_authTokenRequired: (10120) Signifies that an invalid authentication token was passed to an API call that requires authentication.

See Also:

Constant Field Values

E_ACCOUNT_LIMIT_EXCEEDED

public static final transient String E_ACCOUNT_LIMIT_EXCEEDED

E_accountLimitExceeded: (10160) Signifies that a save request exceeded the quantity limits for a given data type. See "Structure Limits" in Appendix D for details.

See Also:

Constant Field Values

E_BUSY

public static final transient String E_BUSY

E_busy: (10400) Signifies that the request cannot be processed at the current time.

See Also:

Constant Field Values

E_CATEGORIZATION_NOT_ALLOWED

public static final transient String E_CATEGORIZATION_NOT_ALLOWED

E_categorizationNotAllowed: (20100) RETIRED. Used for UDDI Version 1.0 compatibility. Replaced by E_valueNotAllowed in 2 and higher. Restrictions have been placed on the types of information that can be categorized within a specific taxonomy. The data provided does not conform to the restrictions placed on the category used. Used with categorization only.

See Also:

Constant Field Values

E_FATAL_ERROR

public static final transient String E_FATAL_ERROR

E_fatalError: (10500) Signifies that a serious technical error has occurred while processing the request.

See Also:

Constant Field Values

E_INVALID_CATEGORY

@Deprecated
public static final transient String E_INVALID_CATEGORY

Deprecated.

E_invalidCategory (20000): RETIRED. Used for UDDI Version 1.0 compatibility only. Replaced by E_invalidValue in version 2 and higher. Signifies that the given keyValue did not correspond to a category within the taxonomy identified by the tModelKey. Used with categorization only.

See Also:

Constant Field Values

E_INVALID_COMPLETION_STATUS

public static final transient String E_INVALID_COMPLETION_STATUS

E_invalidCompletionStatus: (30100) signifies that one of the assertion status values passed is unrecognized. The completion status that caused the problem will be clearly indicated in the error text.

See Also:

Constant Field Values

E_INVALID_KEY_PASSED

public static final transient String E_INVALID_KEY_PASSED

E_invalidKeyPassed: (10210) Signifies that the uuid_key value passed did not match with any known key values. The details on the invalid key will be included in the dispositionReport element.

See Also:

Constant Field Values

E_INVALID_PROJECTION

public static final transient String E_INVALID_PROJECTION

E_invalidProjection: (20230) Signifies that an attempt was made to save a businessEntity containing a service projection that does not match the businessService being projected. The serviceKey of at least one such businessService will be included in the dispositionReport.

See Also:

Constant Field Values

E_INVALID_URL_PASSED

public static final transient String E_INVALID_URL_PASSED

E_invalidURLPassed: (10220) DO NOT USE. Signifies that an error occurred during processing of a save function involving accessing data from a remote URL. The details of the HTTP Get report will be included in the dispositionReport element. Not used in V1 or V2.

See Also:

Constant Field Values

E_INVALID_VALUE

public static final transient String E_INVALID_VALUE

E_invalidValue: (20200) A value that was passed in a keyValue attribute did not pass validation. This applies to checked categorizations, identifiers and other validated code lists. The error text will clearly indicate the key and value combination that failed validation.

See Also:

Constant Field Values

E_KEY_RETIRED

public static final transient String E_KEY_RETIRED

E_keyRetired: (10310) DO NOT USE. Signifies that a uuid_key value passed has been removed from the registry. While the key was once valid as an accessor, and is still possibly valid, the publisher has removed the information referenced by the uuid_key passed. V1 errata – not used. Included here for historical code-set completion.

See Also:

Constant Field Values

E_LANGUAGE_ERROR

public static final transient String E_LANGUAGE_ERROR

E_languageError: (10060) Signifies that an error was detected while processing elements that were annotated with xml:lang qualifiers. Presently, only the description and name elements support xml:lang qualifications.

See Also:

Constant Field Values

E_MESSAGE_TOO_LARGE

public static final transient String E_MESSAGE_TOO_LARGE

E_messageTooLarge: (30110) Signifies that the message is too large. The upper limit will be clearly indicated in the error text.

See Also:

Constant Field Values

E_NAME_TOO_LONG

public static final transient String E_NAME_TOO_LONG

E_nameTooLong: (10020) RETIRED. Used for UDDI Version 1.0 compatibility only. Signifies that the partial name value passed exceeds the maximum name length designated by the policy of an implementation or Operator Site.

See Also:

Constant Field Values

E_OPERATOR_MISMATCH

public static final transient String E_OPERATOR_MISMATCH

E_operatorMismatch: (10130) DO NOT USE. Signifies that an attempt was made to use the publishing API to change data that is mastered at another Operator Site. This error is only relevant to the public Operator Sites and does not apply to other UDDI compatible registries. V1 defined this in error – caused precedence problems with E_unknownUser. Included here for historical code set completeness. Retired.

See Also:

Constant Field Values

E_PUBLISHER_CANCELLED

public static final transient String E_PUBLISHER_CANCELLED

E_publisherCancelled: (30220) The target publisher cancelled the custody transfer operation.

See Also:

Constant Field Values

E_REQUEST_DENIED

public static final transient String E_REQUEST_DENIED

E_requestDenied: (30210) A custody transfer request has been refused.

See Also:

Constant Field Values

E_REQUEST_TIMEOUT

public static final transient String E_REQUEST_TIMEOUT

E_requestTimeout: (20240) Signifies that the request could not be carried out because a needed web service, such as validate_values, did not respond in a reasonable amount of time. Details identifying the failing service will be included in the dispositionReport element.

See Also:

Constant Field Values

E_SECRET_UNKNOWN

public static final transient String E_SECRET_UNKNOWN

E_secretUnknown: (30230) The target publisher was unable to match the shared secret and the five (5) attempt limit was exhausted. The target operator automatically cancelled the transfer operation.

See Also:

Constant Field Values

E_SUCCESS

public static final transient String E_SUCCESS

E_success: (0) Signifies no failure occurred. This return code is used with the dispositionReport for reporting results from requests with no natural response document.

See Also:

Constant Field Values

E_TOO_MANY_OPTIONS

public static final transient String E_TOO_MANY_OPTIONS

E_tooManyOptions: (10030) Signifies that too many or incompatible arguments were passed. The error text will clearly indicate the nature of the problem.

See Also:

Constant Field Values

E_TRANSFER_ABORTED

public static final transient String E_TRANSFER_ABORTED

E_transferAborted: (30200) Signifies that a custody transfer request will not succeed.

See Also:

Constant Field Values

E_UNKNOWN_USER

public static final transient String E_UNKNOWN_USER

E_unknownUser: (10150) Signifies that the user ID and password pair passed in a get_authToken message is not known to the Operator Site or is not valid.

See Also:

Constant Field Values

E_UNRECOGNIZED_VERSION

public static final transient String E_UNRECOGNIZED_VERSION

E_unrecognizedVersion: (10040) Signifies that the value of the generic attribute passed is unsupported by the Operator Instance being queried.

See Also:

Constant Field Values

E_UNSUPPORTED

public static final transient String E_UNSUPPORTED

E_unsupported: (10050) Signifies that the implementer does not support a feature or API.

See Also:

Constant Field Values

E_UNVALIDATABLE

public static final transient String E_UNVALIDATABLE

E_unvalidatable: (20220) Signifies that an attempt was made to reference a taxonomy or identifier system in a keyedReference whose tModel is categorized with the unvalidatable categorization.

See Also:

Constant Field Values

E_USER_MISMATCH

public static final transient String E_USER_MISMATCH

E_userMismatch: (10140) Signifies that an attempt was made to use the publishing API to change data that is controlled by another party.

See Also:

Constant Field Values

E_VALUE_NOT_ALLOWED

public static final transient String E_VALUE_NOT_ALLOWED

E_valueNotAllowed: (20210) Signifies that a value did not pass validation because of contextual issues. The value may be valid in some contexts, but not in the context used. The error text may contain information about the contextual problem.

See Also:

Constant Field Values

Constructor Detail

DispositionReport

public DispositionReport(Node firstChild)
                  throws JAXBException

Throws:

JAXBException

DispositionReport

public DispositionReport()

Method Detail

getResult

public List<Result> getResult()

Gets the value of the result property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the result property.

For example, to add a new item, do as follows:

    getResult().add(newItem);
 

Objects of the following type(s) are allowed in the list Result

getGeneric

public String getGeneric()

Gets the value of the generic property.

Returns:

possible object is String

setGeneric

public void setGeneric(String value)

Sets the value of the generic property.

Parameters:

value - allowed object is String

getOperator

public String getOperator()

Gets the value of the operator property.

Returns:

possible object is String

setOperator

public void setOperator(String value)

Sets the value of the operator property.

Parameters:

value - allowed object is String

getTruncated

public Truncated getTruncated()

Gets the value of the truncated property.

Returns:

possible object is Truncated

setTruncated

public void setTruncated(Truncated value)

Sets the value of the truncated property.

Parameters:

value - allowed object is Truncated

countainsErrorCode

public boolean countainsErrorCode(String errCodeKey)

Determines if one of the Results in the this DispositionReport has a Error Code that matches the errCodeKey passed in. The errCodeKey should be one of the

Parameters:

errCodeKey -

Returns:

true if the errCodeKey matches with a code in the Results.