MicroStrategy ONE
Job
When the getJobs method is called, the MonitorResults object contains Job objects, which describe each job that is active on MicroStrategy Intelligence Server. The amount of information on each Job object depends upon whether the flag has been set to retrieve browse information or detailed information.
The Job object consists primarily of a number of read-only properties that can be used to obtain a variety of information about a single job. The properties that are populated depend upon whether the details flag or the browsing flag was used when retrieving jobs.
The JobDetails interface extends the Job interface and contains the information that is retrieved when the details flag is set.
The following methods are exposed on the Job interface:
Method Name | Return Type | Requires Details? | Description |
---|---|---|---|
getJobID |
int |
No |
Returns the job ID, which is the unique identifier for the job |
getUserName |
string |
No |
Returns the full name for the owner of the job |
getJobStatus |
int |
No |
Returns the status of the job, from EnumDSSXMLJobStatus |
getDescription |
string |
No |
Returns the description of the job |
getProjectID |
string |
No |
Returns the project ID of the project on which the job is running |
getProjectDSSID |
string |
No |
Returns the DSSID of the project on which the job is running |
getProjectName |
string |
No |
Returns the name of the project on which the job is running |
getJobPriority |
int |
No |
Returns the job priority |
getCreationTime |
string |
No |
Returns the creation time, as a java.util.Date |
getServerName |
string |
No |
Returns the server name of the machine on which the job is running |
getClientMachine |
string |
No |
Returns the machine that invoked the job |
getDuration |
int |
No |
Returns the number of seconds that have passed since the job began |
hasDetails |
boolean |
No |
Returns whether the details are available or not |