com.commercetools.payment.model.PaymentOperationResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common Show documentation

The commercetools java payment project intend is to make payment integration easy

The newest version!

package com.commercetools.payment.model;

import com.commercetools.payment.actions.OperationResult;
import io.sphere.sdk.payments.Payment;

import java.util.Optional;

/**
 * Created by mgatz on 8/8/16.
 */
public interface PaymentOperationResult {
    /**
     * @return the basic operation result
     */
    OperationResult getOperationResult();

    /**
     * If the operation succeeded then this is the payment object that has been created.
     * @return the created payment object
     */
    Optional getRelatedPaymentObject();

    /**
     * If the operation failed because of an exception, then it is stored here.
     * @return the exception
     */
    Optional getException();

    /**
     * Can provide a message that describes the cause of the operation result.
     * @return the message
     */
    Optional getMessage();
}