OperationServiceListener.java

/*
 * Copyright 2013 Robotoworks Limited
 * 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.
 */
package com.robotoworks.mechanoid.ops;

import android.content.Intent;
import android.os.Bundle;

/**
 * <p>A listener that can be registered/unregistered with an implementation of {@link OperationServiceBridge}
 * that will listen to the status of scheduled and/or currently running operations.</p>
 *
 */
public abstract class OperationServiceListener {
	/**
	 * <p>Callback when an operation is about to start.<p>
	 * @param id The unique id of the operation
	 * @param intent The intent that represents the operation request
	 * @param data currently unused
	 */
	public void onOperationStarting(int id, Intent intent, Bundle data) {
		
	}
	/**
	 * <p>Callback when an operation has completed</p>
	 * @param bridge the operation bridge responsible for this operation 
	 * @param id The unique id of the operation
	 * @param result Arbitrary data describing the result of the operation, this should ussually
	 * be created with one of the operation result helpers 
	 * such as {@link Operation#createOkResult()} or {@link Operation#createErrorResult(Throwable)}
	 */
	public abstract void onOperationComplete(int id, OperationResult result);
	
	/**
	 * <p>Callback when an operation invokes {@link Operation#postProgress(int, Bundle)}, useful
	 * in scenarios where long running operations need to report progress.</p>
	 * @param bridge the bridge responsible for this operation
	 * @param id The unique id of the operation
	 * @param intent The intent that represents the operation request
	 * @param progress an integer to describe the progress of the operation, ie :- 0 to 100%
	 * @param data arbitrary data
	 */
	public void onOperationProgress(int id, Intent intent, int progress, Bundle data) {
		
	}
	
	/**
	 * <p>Callback when an operation invokes {@link Operation#abort(int)} or if {@link OperationServiceBridge#abort(int, int)}
	 * is invoked.</p>
	 * <p>Note: Aborted operations will not call {@link OperationServiceListener#onOperationComplete(OperationServiceBridge, int, Bundle)}
	 *  if an operation is aborted.</p>
	 * @param id The unique id of the aborted operation
	 * @param intent The intent that represents the operation request
	 * @param reason A user defined reason for the aborting of the operation
	 * @param data arbitrary data
	 */
	public void onOperationAborted(int id, Intent intent, int reason, Bundle data) {
		
	}
}