com.ibm.itim.apps
Class Request

java.lang.Object
  |
  +--com.ibm.itim.apps.Request
Direct Known Subclasses:
BulkRequest

public class Request
extends java.lang.Object

Represents a request submitted to the provisioning platform.


Field Summary
static int FAILED
          Constant identifying the failed status.
static int IN_PROCESS
          Constant identifying the in-process status.
static int NOT_STARTED
          Constant identifying the not-started status.
static int SUCCEEDED
          Constant identifying the successfully completed status.
static int WARNING
          Constant identifying the warning status.
 
Constructor Summary
Request(PlatformContext platform, javax.security.auth.Subject subject, long id)
          Constructs with a platform, subject, and request id.
Request(PlatformContext platform, javax.security.auth.Subject subject, long id, java.util.Date scheduledTime)
          Constructs with a platform, subject, request id, and scheduled time.
 
Method Summary
 void abort()
          Aborts the request.
 long getID()
          Returns the ID of the request.
 java.util.Date getScheduledTime()
          Returns the time the request was scheduled to begin.
 int getStatus()
          Returns the status of the request.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NOT_STARTED

public static final int NOT_STARTED
Constant identifying the not-started status.

IN_PROCESS

public static final int IN_PROCESS
Constant identifying the in-process status.

SUCCEEDED

public static final int SUCCEEDED
Constant identifying the successfully completed status.

FAILED

public static final int FAILED
Constant identifying the failed status.

WARNING

public static final int WARNING
Constant identifying the warning status.
Constructor Detail

Request

public Request(PlatformContext platform,
               javax.security.auth.Subject subject,
               long id)
Constructs with a platform, subject, and request id.
Parameters:
platform - PlatformContext holding platform connection information.
subject - Authenticated user.
id - Unique id of the request.

Request

public Request(PlatformContext platform,
               javax.security.auth.Subject subject,
               long id,
               java.util.Date scheduledTime)
Constructs with a platform, subject, request id, and scheduled time.
Parameters:
platform - PlatformContext holding platform connection information.
subject - Authenticated user.
id - Unique id of the request.
scheduledTime - Date holding the time the request was scheduled to begin.
Method Detail

getID

public long getID()
Returns the ID of the request.
Returns:
ID of the request.

getScheduledTime

public java.util.Date getScheduledTime()
                                throws java.rmi.RemoteException,
                                       ApplicationException
Returns the time the request was scheduled to begin.
Returns:
Date holding the begin time.
Throws:
java.rmi.RemoteException - Thrown if unable to communicate with platform.
ApplicationException - Thrown if no request exists with the given ID.

getStatus

public int getStatus()
              throws java.rmi.RemoteException,
                     ApplicationException
Returns the status of the request.
Returns:
Enumeration of the request status. The value may be one of the following: NOT_STARTED, IN_PROCESS, SUCCEEDED, WARNING, or FAILED.
Throws:
java.rmi.RemoteException - Thrown if unable to communicate with platform.
ApplicationException - Thrown if no request exists with the given ID.

abort

public void abort()
           throws java.rmi.RemoteException,
                  ApplicationException
Aborts the request.
Throws:
java.rmi.RemoteException - Thrown if unable to communicate with platform.
ApplicationException - Thrown if no request exists with the given ID.