Package de.aeb.xnsg.foundation.bf
Class AbstractResponseDTO
java.lang.Object
de.aeb.xnsg.foundation.bf.AbstractResponseDTO
- Direct Known Subclasses:
AcknowledgeEventsResponseDTO
,AcknowledgePublishedDataTransferPackagesResponseDTO
,CreateClientFromTemplateResponseDTO
,ExternalTMResponseDTO
,ExternalTMStatusResponseDTO
,GetClientFeaturesResponseDTO
,GetCreateClientFromTemplateStatusResponseDTO
,GetPartnerSystemSubscriptionsResponseDTO
,GetPublishedDataTransferPackageResponseDTO
,GetRolesResponseDTO
,SetClientFeaturesResponseDTO
,SetSyncEventResponseDTO
,SubscribePartnerSystemResponseDTO
,SyncEventsResponseDTO
,UnsubscribePartnerSystemResponseDTO
Abstract DTO superclass with typical response data
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Possible messageIdentCode: "EMPTY_MANDATORY_FIELD " : One ore more of the mandatory fields are empty.True, if there are any errors.True if the errors signal a temporary problem, like a locked resource.True, if there are any warnings.static final String
Possible messageIdentCode: "I18N_WARNING": One of the resultLanguageIsoCodes was not supported, so there are missing languages in ResponseMessageDTO.messageTextsstatic final String
Possible messageIdentCode: "INTERNAL_SERVER_ERROR": An unexpected exception occured when handling the request, e.g.static final String
Possible messageIdentCode: "INVALID_DATA_ERROR": One of the ident codes send was not recognized by the engine.static final String
Possible messageIdentCode: "INVALID_DATA_WARNING": One of the ident codes send was not recognized by the engine, but this was not treated as an error.static final String
Possible messageIdentCode: "LOCK_ERROR": A locking problem happened.Error or warning messages at the request level. -
Constructor Summary
-
Method Summary
-
Field Details
-
INVALID_DATA_ERROR
Possible messageIdentCode: "INVALID_DATA_ERROR": One of the ident codes send was not recognized by the engine.- See Also:
-
INVALID_DATA_WARNING
Possible messageIdentCode: "INVALID_DATA_WARNING": One of the ident codes send was not recognized by the engine, but this was not treated as an error.- See Also:
-
INTERNAL_SERVER_ERROR
Possible messageIdentCode: "INTERNAL_SERVER_ERROR": An unexpected exception occured when handling the request, e.g. a database transaction failure.- See Also:
-
LOCK_ERROR
Possible messageIdentCode: "LOCK_ERROR": A locking problem happened. Typically this error is retryable. (See also hasOnlyRetryableErrors).- See Also:
-
I18N_WARNING
Possible messageIdentCode: "I18N_WARNING": One of the resultLanguageIsoCodes was not supported, so there are missing languages in ResponseMessageDTO.messageTexts- See Also:
-
EMPTY_MANDATORY_FIELD
Possible messageIdentCode: "EMPTY_MANDATORY_FIELD " : One ore more of the mandatory fields are empty.- See Also:
-
hasErrors
True, if there are any errors.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
-
hasOnlyRetryableErrors
True if the errors signal a temporary problem, like a locked resource.
You may re-send the same request again at a later time.
-
hasWarnings
True, if there are any warnings.
A warning means that the request was performed but some non-critical problems arose
Warning details are provided in the messages[] array.
-
messages
Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
-
-
Constructor Details
-
AbstractResponseDTO
public AbstractResponseDTO()
-