rootpa/Code/Android/lib/src/com/gd/mobicore/pa/ifc/CommandResult.java

/*
Copyright  © Trustonic Limited 2013

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this 
     list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, 
     this list of conditions and the following disclaimer in the documentation 
     and/or other materials provided with the distribution.

  3. Neither the name of the Trustonic Limited nor the names of its contributors 
     may be used to endorse or promote products derived from this software 
     without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.gd.mobicore.pa.ifc;

import android.os.Parcel;
import android.os.Parcelable;

/**
    Result of commands requested from interfaces in com.gd.mobicore.pa.ifc package
*/
public class CommandResult implements Parcelable{

    /*
    NOTE to the maintainer. These values and documentation needs to be in line with the ones in rootpaErrors.h
    */

    /**
    no errors detected, successful execution  
    */
    public static final int ROOTPA_OK=0x00000000;

    /**
    client has requested unsupported command or command that it can not execute via the used interface
    */
    public static final int ROOTPA_COMMAND_NOT_SUPPORTED=0x00000001;

    /** 
    either rootpa is locked by another client, or the client requests lock or unlock when it is not allowed to do that 
    */
    public static final int ROOTPA_ERROR_LOCK=0x00000002;


    /**
    error in one of the cmp commands, see command specific response for more details
    */
    public static final int ROOTPA_ERROR_COMMAND_EXECUTION=0x00000003;

    /** 
    mobicore registry returned an error 
    */
    public static final int ROOTPA_ERROR_REGISTRY=0x00000004;

    /**
     error in communicating with mobicore 
    */
    public static final int ROOTPA_ERROR_MOBICORE_CONNECTION=0x00000005;

    /** 
    either NWd or SWd software is out of memory 
    */
    public static final int ROOTPA_ERROR_OUT_OF_MEMORY=0x00000006;

    /** 
    rootpa internal error 
    */
    public static final int ROOTPA_ERROR_INTERNAL=0x00000007;

    /** 
    given argument is not allowed (in many cases it is NULL) or e.g. the format oif xml is unsupported
    */
    public static final int ROOTPA_ERROR_ILLEGAL_ARGUMENT=0x00000008;

    /** 
    error in network connection or use of networking library 
    */
    public static final int ROOTPA_ERROR_NETWORK=0x00000009;

    /** 
    error is parsing received XML command or creating new XML response
    */
    public static final int ROOTPA_ERROR_XML=0x0000000A;

    /** 
    mobicore registry error, requested object does not exists (or cannot be read for some other reason)
    */
    public static final int ROOTPA_ERROR_REGISTRY_OBJECT_NOT_AVAILABLE=0x0000000B;

    /** 
    requested container does not exist. This is not always considered an error 
    but is used as an informative return code
    */
    public static final int ROOTPA_ERROR_INTERNAL_NO_CONTAINER=0x00000030;


    private int result_;
    
    public static final Parcelable.Creator<CommandResult> CREATOR = new Parcelable.Creator<CommandResult>(){
        public CommandResult createFromParcel(Parcel in){
            return new CommandResult(in);
        }
        
        public CommandResult[] newArray(int size){
            return null;
        }
    };
    
    /**
        Constructor 
        @param result of the command
    */    
    public CommandResult(int result){
        result_=result;
    }

    public CommandResult(){
        result_=ROOTPA_OK;
    }

    /**
        Constructor required by parcelable
    */    
    public CommandResult(Parcel in){
        readFromParcel(in);
    }

    public int result(){
        return result_;
    }

    public boolean isOk(){
        return (result_==ROOTPA_OK);
    }

    @Override    
    public String toString() {  
        String ret=new Integer(result_).toString();
        switch(result_){
            case ROOTPA_OK:
                ret+=": ROOTPA_OK";
                break; 
            case ROOTPA_COMMAND_NOT_SUPPORTED:
                ret+=": ROOTPA_COMMAND_NOT_SUPPORTED";
                break; 
            case ROOTPA_ERROR_INTERNAL:
                ret+=": ROOTPA_ERROR_INTERNAL";
                break; 
            case ROOTPA_ERROR_LOCK:
                ret+=": ROOTPA_ERROR_LOCK";
                break; 
            case ROOTPA_ERROR_ILLEGAL_ARGUMENT:
                ret+=": ROOTPA_ERROR_ILLEGAL_ARGUMENT";
                break; 
            case ROOTPA_ERROR_INTERNAL_NO_CONTAINER:
                ret+=": ROOTPA_ERROR_INTERNAL_NO_CONTAINER";
                break;
            case ROOTPA_ERROR_COMMAND_EXECUTION:
                ret+=": ROOTPA_ERROR_COMMAND_EXECUTION";
                break;
            case ROOTPA_ERROR_REGISTRY:
                ret+=": ROOTPA_ERROR_REGISTRY";
                break;
            case ROOTPA_ERROR_MOBICORE_CONNECTION:
                ret+=": ROOTPA_ERROR_MOBICORE_CONNECTION";
                break;
            case ROOTPA_ERROR_OUT_OF_MEMORY:
                ret+=": ROOTPA_ERROR_OUT_OF_MEMORY";
                break;
            case ROOTPA_ERROR_NETWORK:
                ret+=": ROOTPA_ERROR_NETWORK";
                break;
            case ROOTPA_ERROR_XML:
                ret+=": ROOTPA_ERROR_XML";
                break;         
            case ROOTPA_ERROR_REGISTRY_OBJECT_NOT_AVAILABLE:
                ret+=": ROOTPA_ERROR_REGISTRY_OBJECT_NOT_AVAILABLE";
                break;
            default:
                break;
        }
            
        return ret;
    } 

    @Override    
    public int describeContents() {  
        return 0;  
    } 

    @Override    
    public void writeToParcel(Parcel out, int flags){
        out.writeInt(result_);
    }

    private void readFromParcel(Parcel in){
        result_=in.readInt();
    }

}