Package energy.eddie.api.v0

Enum Class PermissionProcessStatus

java.lang.Object
java.lang.Enum<PermissionProcessStatus>
energy.eddie.api.v0.PermissionProcessStatus
All Implemented Interfaces:
Serializable, Comparable<PermissionProcessStatus>, Constable
public enum PermissionProcessStatus extends Enum<PermissionProcessStatus>
Implements the status of the Permission Process Model.

  • Enum Constant Details

    • CREATED

      public static final PermissionProcessStatus CREATED
      Permission Request has been created, but not validated or sent to a permission administrator

    • VALIDATED

      public static final PermissionProcessStatus VALIDATED
      The permission request has been validated. It contains only valid values at this point of the process.

    • MALFORMED

      public static final PermissionProcessStatus MALFORMED
      The permission request is malformed. If the user tries to re-send we can reattempt to validate it.

    • UNABLE_TO_SEND

      public static final PermissionProcessStatus UNABLE_TO_SEND
      We are unable to send the permission request to the permission administrator. Could be due to a service outage or a network issue.

    • SENT_TO_PERMISSION_ADMINISTRATOR

      public static final PermissionProcessStatus SENT_TO_PERMISSION_ADMINISTRATOR
      The permission request is now being processed by the PA.

    • TIMED_OUT

      public static final PermissionProcessStatus TIMED_OUT
      A user can forgo the option of accepting a permission request. In that case the request will time out.

    • ACCEPTED

      public static final PermissionProcessStatus ACCEPTED
      The user accepted the permission request.

    • REJECTED

      public static final PermissionProcessStatus REJECTED
      The user rejected the permission request.

    • INVALID

      public static final PermissionProcessStatus INVALID
      The permission request is not formatted correctly or contains semantic errors and is invalid.

    • REVOKED

      public static final PermissionProcessStatus REVOKED
      The user revoked the permission via the permission administrator or the permission administrator themselves removed the permission.

    • TERMINATED

      public static final PermissionProcessStatus TERMINATED
      The permission was terminated via the eligible party.

    • FULFILLED

      public static final PermissionProcessStatus FULFILLED
      The permission request has been fulfilled, i.e. all data has been delivered.

    • UNFULFILLABLE

      public static final PermissionProcessStatus UNFULFILLABLE
      The permission request specifies energy data that is not available for that final customer.

    • REQUIRES_EXTERNAL_TERMINATION

      public static final PermissionProcessStatus REQUIRES_EXTERNAL_TERMINATION
      A follow-up state for UNFULFILLABLE, FULFILLED, TERMINATED, since sometimes these states have to be externally terminated.

    • FAILED_TO_TERMINATE

      public static final PermissionProcessStatus FAILED_TO_TERMINATE
      The external termination process failed.

    • EXTERNALLY_TERMINATED

      public static final PermissionProcessStatus EXTERNALLY_TERMINATED
      The external termination process was successful.

  • Method Details

    • values

      public static PermissionProcessStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PermissionProcessStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null