Class CollectResponse
java.lang.Object
se.swedenconnect.bankid.rpapi.types.CollectResponse
- All Implemented Interfaces:
Serializable
Representation of the response received from a collect call.
- Author:
- Martin Lindström
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Represents the status field values. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionIf the progress status isProgressStatus.COMPLETE
this method will return the completion data.If the overall status is "failed", this method returns the error code found in hint code.Gets the hint code.Returns theorderRef
corresponding to the auth or sign call.Returns the progess status of the operation.Returns the overall status for the collect call.void
setCompletionData
(CompletionData completionData) Assigns the completion data.void
setHintCode
(String hintCode) Assigns the hint code.void
setOrderReference
(String orderReference) Assigns the order reference.void
setStatus
(CollectResponse.Status status) Assigns the overall status for the collect call.toString()
-
Constructor Details
-
CollectResponse
public CollectResponse()
-
-
Method Details
-
getOrderReference
Returns theorderRef
corresponding to the auth or sign call.- Returns:
- the order reference
-
setOrderReference
Assigns the order reference.- Parameters:
orderReference
- the order reference
-
getStatus
Returns the overall status for the collect call.- Returns:
- the status
-
setStatus
Assigns the overall status for the collect call.- Parameters:
status
- the status
-
getProgressStatus
Returns the progess status of the operation.- Returns:
- the progress status
-
getErrorCode
If the overall status is "failed", this method returns the error code found in hint code.- Returns:
- the error code, or
null
-
getCompletionData
If the progress status isProgressStatus.COMPLETE
this method will return the completion data.- Returns:
- the completion data
-
setCompletionData
Assigns the completion data.- Parameters:
completionData
- the completion data
-
getHintCode
Gets the hint code.- Returns:
- the hint code
-
setHintCode
Assigns the hint code.- Parameters:
hintCode
- the hint code
-
toString
-