RequestRunnable.java

/*
 * Copyright 2014 serso aka se.solovyev
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 * Contact details
 *
 * Email: se.solovyev@gmail.com
 * Site:  http://se.solovyev.org
 */

package org.solovyev.android.checkout;

import javax.annotation.Nullable;

/**
 * Runnable which executes a billing request.
 */
interface RequestRunnable {

    /**
     * @return associated request id
     */
    int getId();

    /**
     * @return associated request tag
     */
    @Nullable
    Object getTag();

    /**
     * Cancels request.
     * Note: nothing happens if request has already been executed
     */
    void cancel();

    /**
     * @return associated request, null if request was cancelled
     */
    @Nullable
    Request getRequest();

    /**
     * Note that implementation of this method should always check if the request was cancelled.
     *
     * @return true if request was successfully executed, false if request was not executed (and
     * should be rerun)
     */
    boolean run();
}