blob: 4e2af53432326494a8655f0566a4128ee408e02b [file] [log] [blame]
/*
* Copyright (C) 2017 The Android Open Source Project
*
* 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 android.service.euicc;
import android.annotation.IntDef;
import android.os.Parcel;
import android.os.Parcelable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* Result of a {@link EuiccService#downloadSubscription} operation.
* @hide
*
* TODO(b/35851809): Make this a SystemApi.
*/
public final class DownloadResult implements Parcelable {
public static final Creator<DownloadResult> CREATOR = new Creator<DownloadResult>() {
@Override
public DownloadResult createFromParcel(Parcel in) {
return new DownloadResult(in);
}
@Override
public DownloadResult[] newArray(int size) {
return new DownloadResult[size];
}
};
/** @hide */
@IntDef({
RESULT_OK,
RESULT_GENERIC_ERROR,
RESULT_MUST_DEACTIVATE_SIM,
})
@Retention(RetentionPolicy.SOURCE)
public @interface ResultCode {}
public static final int RESULT_OK = 0;
public static final int RESULT_GENERIC_ERROR = 1;
public static final int RESULT_MUST_DEACTIVATE_SIM = 2;
/** Result of the operation - one of the RESULT_* constants. */
public final @ResultCode int result;
/** Implementation-defined detailed error code in case of a failure not covered here. */
public final int detailedCode;
private DownloadResult(int result, int detailedCode) {
this.result = result;
this.detailedCode = detailedCode;
}
private DownloadResult(Parcel in) {
this.result = in.readInt();
this.detailedCode = in.readInt();
}
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeInt(result);
dest.writeInt(detailedCode);
}
/** Return a result indicating that the download was successful. */
public static DownloadResult success() {
return new DownloadResult(RESULT_OK, 0);
}
/**
* Return a result indicating that an active SIM must be deactivated to perform the operation.
*/
public static DownloadResult mustDeactivateSim() {
return new DownloadResult(RESULT_MUST_DEACTIVATE_SIM, 0);
}
/**
* Return a result indicating that an error occurred for which no other more specific error
* code has been defined.
*
* @param detailedCode an implemenation-defined detailed error code for debugging purposes.
*/
public static DownloadResult genericError(int detailedCode) {
return new DownloadResult(RESULT_GENERIC_ERROR, detailedCode);
}
@Override
public int describeContents() {
return 0;
}
}