Christopher Tate | 7d562ec | 2009-06-25 18:03:43 -0700 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright (C) 2009 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.backup; |
| 18 | |
| 19 | /** |
| 20 | * Callback class for receiving progress reports during a restore operation. |
| 21 | * |
| 22 | * @hide |
| 23 | */ |
| 24 | interface IRestoreObserver { |
| 25 | /** |
| 26 | * The restore operation has begun. |
| 27 | * |
| 28 | * @param numPackages The total number of packages being processed in |
| 29 | * this restore operation. |
| 30 | */ |
| 31 | void restoreStarting(int numPackages); |
| 32 | |
| 33 | /** |
| 34 | * An indication of which package is being restored currently, out of the |
| 35 | * total number provided in the restoreStarting() callback. This method |
| 36 | * is not guaranteed to be called. |
| 37 | * |
| 38 | * @param nowBeingRestored The index, between 1 and the numPackages parameter |
| 39 | * to the restoreStarting() callback, of the package now being restored. |
| 40 | */ |
| 41 | void onUpdate(int nowBeingRestored); |
| 42 | |
| 43 | /** |
| 44 | * The restore operation has completed. |
| 45 | * |
| 46 | * @param error Zero on success; a nonzero error code if the restore operation |
| 47 | * as a whole failed. |
| 48 | */ |
| 49 | void restoreFinished(int error); |
| 50 | } |