de.adorsys.psd2.xs2a.core.consent

Enum ConsentStatus

java.lang.Object

java.lang.Enum<ConsentStatus>

de.adorsys.psd2.xs2a.core.consent.ConsentStatus

All Implemented Interfaces:

Serializable, Comparable<ConsentStatus>

public enum ConsentStatus
extends Enum<ConsentStatus>

This is the overall lifecycle status of the consent. Valid values are: - 'received': The consent data have been received and are technically correct. The data is not authorised yet. - 'rejected': The consent data have been rejected e.g. since no successful authorisation has taken place. - 'valid': The consent is accepted and valid for GET account data calls and others as specified in the consent object. - 'revokedByPsu': The consent has been revoked by the PSU towards the ASPSP. - 'expired': The consent expired. - 'terminatedByTpp': The corresponding TPP has terminated the consent by applying the DELETE method to the consent resource. The ASPSP might add further codes. These codes then shall be contained in the ASPSP's documentation of the XS2A interface and has to be added to this API definition as well.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXPIRED
PARTIALLY_AUTHORISED
RECEIVED
REJECTED
REVOKED_BY_PSU
TERMINATED_BY_ASPSP
TERMINATED_BY_TPP
VALID

Method Summary

Modifier and Type	Method and Description
static Optional<ConsentStatus>	fromValue(String text)
String	getValue()
boolean	isFinalisedStatus()
static ConsentStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConsentStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RECEIVED

public static final ConsentStatus RECEIVED

REJECTED

public static final ConsentStatus REJECTED

VALID

public static final ConsentStatus VALID

REVOKED_BY_PSU

public static final ConsentStatus REVOKED_BY_PSU

EXPIRED

public static final ConsentStatus EXPIRED

TERMINATED_BY_TPP

public static final ConsentStatus TERMINATED_BY_TPP

TERMINATED_BY_ASPSP

public static final ConsentStatus TERMINATED_BY_ASPSP

PARTIALLY_AUTHORISED

public static final ConsentStatus PARTIALLY_AUTHORISED

Method Detail

values

public static ConsentStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConsentStatus c : ConsentStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConsentStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isFinalisedStatus

public boolean isFinalisedStatus()

fromValue

public static Optional<ConsentStatus> fromValue(String text)

getValue

public String getValue()