com.hqme.cm
Interface IRequestManager

All Known Implementing Classes:
IRequestManager.Stub

public interface IRequestManager

IRequestManager defines the HQME request manager interface for HQME applications.


Nested Class Summary
static class IRequestManager.Stub
          Local-side IPC implementation stub class.
 
Method Summary
 int cancelRequest(long requestId)
          Cancel a previously submitted QueueRequest in the request queue
 IQueueRequest createQueueRequest()
          Create a QueueRequest
 IQueueRequest createQueueRequestXml(java.lang.String queueRequestXml)
          Create a QueueRequest
 int getPriority(long requestId)
          Retrieve the priority of a previously submitted QueueRequest currently in the request queue.
 int getProgress(long requestId)
          Retrieve the process (as a percentage) for a QueueRequest in the request queue.
 IQueueRequest getRequest(long requestId)
          Retrieve a QueueRequest object from the request queue
 long[] getRequestIds()
          Retrieve an array of RequestIds associated with the currently queued QueueRequests
 long[] getRequestIdsState(int state)
          Retrieve an array of RequestIds associated with the currently queued QueueRequests
 QueueRequestState getState(long requestId)
          Retrieve the state of a previously submitted QueueRequest.
 void registerCallback(IRequestManagerCallback cb)
          Register a client application callback function to get informed with RequestManager status changes.
 int requestCount()
          Retrieve a count of queued QueueRequests.
 int requestCountState(int state)
          Retrieve a count of queued QueueRequests.
 int resumeRequest(long requestId)
          Resume a previously suspended QueueRequest in the request queue
 int setPriority(long requestId, int relativePriority)
          Set the priority of a previously submitted QueueRequest currently in the request queue.
 long submitRequest(IQueueRequest request)
          Submit a QueueRequest to the request queue.
 int suspendRequest(long requestId)
          Suspend a previously submitted QueueRequest in the request queue
 void unregisterCallback(IRequestManagerCallback cb)
          Unregister a client application callback function to get informed with RequestManager status changes.
 

Method Detail

createQueueRequest

IQueueRequest createQueueRequest()
                                 throws android.os.RemoteException
Create a QueueRequest

Returns:
Reference to the QueueRequest Object. Note: [non-normative]
Throws:
android.os.RemoteException

createQueueRequestXml

IQueueRequest createQueueRequestXml(java.lang.String queueRequestXml)
                                    throws android.os.RemoteException
Create a QueueRequest

Parameters:
queueRequestXml - An XML-format string representing a QueueRequest object and its Properties
Returns:
Reference to the QueueRequest Object. Note: [non-normative]
Throws:
android.os.RemoteException

requestCount

int requestCount()
                 throws android.os.RemoteException
Retrieve a count of queued QueueRequests.

Returns:
Number of queued requests in the queue.
Throws:
android.os.RemoteException

requestCountState

int requestCountState(int state)
                      throws android.os.RemoteException
Retrieve a count of queued QueueRequests.

Parameters:
state - Used as a filter.
Returns:
Number of queued requests in the given state.
Throws:
android.os.RemoteException

getRequestIds

long[] getRequestIds()
                     throws android.os.RemoteException
Retrieve an array of RequestIds associated with the currently queued QueueRequests

Returns:
List of all request ids in the queue.
Throws:
android.os.RemoteException

getRequestIdsState

long[] getRequestIdsState(int state)
                          throws android.os.RemoteException
Retrieve an array of RequestIds associated with the currently queued QueueRequests

Parameters:
state - Used as a filter.
Returns:
List of request ids in the given state.
Throws:
android.os.RemoteException

getRequest

IQueueRequest getRequest(long requestId)
                         throws android.os.RemoteException
Retrieve a QueueRequest object from the request queue

Parameters:
requestId - Request ID of the requested QueueRequest.
Returns:
QueueRequest object.
Throws:
android.os.RemoteException

submitRequest

long submitRequest(IQueueRequest request)
                   throws android.os.RemoteException
Submit a QueueRequest to the request queue.

Parameters:
request - QueueRequest to be submitted..
Returns:
1 on success. Negative error code on error.
Throws:
android.os.RemoteException

cancelRequest

int cancelRequest(long requestId)
                  throws android.os.RemoteException
Cancel a previously submitted QueueRequest in the request queue

Parameters:
requestId - Request ID of the QueueRequest.
Returns:
1 on success. Negative error code on error.
Throws:
android.os.RemoteException

suspendRequest

int suspendRequest(long requestId)
                   throws android.os.RemoteException
Suspend a previously submitted QueueRequest in the request queue

Parameters:
requestId - Request ID of the QueueRequest.
Returns:
1 on success. Negative error code on error.
Throws:
android.os.RemoteException

resumeRequest

int resumeRequest(long requestId)
                  throws android.os.RemoteException
Resume a previously suspended QueueRequest in the request queue

Parameters:
requestId - Request ID of the QueueRequest.
Returns:
1 on success. Negative error code on error.
Throws:
android.os.RemoteException

getProgress

int getProgress(long requestId)
                throws android.os.RemoteException
Retrieve the process (as a percentage) for a QueueRequest in the request queue.

Parameters:
requestId - Request ID of the QueueRequest.
Returns:
Progress value on success. Negative error code on error.
Throws:
android.os.RemoteException

getState

QueueRequestState getState(long requestId)
                           throws android.os.RemoteException
Retrieve the state of a previously submitted QueueRequest.

Parameters:
requestId - Request ID of the QueueRequest.
Returns:
QueueRequestState on success. Null on erro.
Throws:
android.os.RemoteException

getPriority

int getPriority(long requestId)
                throws android.os.RemoteException
Retrieve the priority of a previously submitted QueueRequest currently in the request queue.

Parameters:
requestId - Request ID of the QueueRequest.
Returns:
Priority value on success [0-100]. Negative error code on error.
Throws:
android.os.RemoteException

setPriority

int setPriority(long requestId,
                int relativePriority)
                throws android.os.RemoteException
Set the priority of a previously submitted QueueRequest currently in the request queue.

Parameters:
requestId - Request ID of the QueueRequest.
relativePriority - New priority value. [0-100]
Returns:
New priority value on success. Negative error code on error.
Throws:
android.os.RemoteException

registerCallback

void registerCallback(IRequestManagerCallback cb)
                      throws android.os.RemoteException
Register a client application callback function to get informed with RequestManager status changes.

Parameters:
cb - the client application's callback function Note: not a P2200 API
Throws:
android.os.RemoteException

unregisterCallback

void unregisterCallback(IRequestManagerCallback cb)
                        throws android.os.RemoteException
Unregister a client application callback function to get informed with RequestManager status changes.

Parameters:
cb - the client application's callback function Note: not a P2200 API
Throws:
android.os.RemoteException