5-6 Scheduling Jobs Guide for Oracle Business Intelligence Enterprise Edition
boolean hasResultSet; File getResultSetFile;
String userID; int getExitCode;
void setExitCodeint exitCode; int getStatus;
void setStatusint status; String getMessage;
void setMessageString message; void appendMessageString message;
}
Three public final integers, kJavaJobInformation, kJavaJobWarning, and kJavaJobError are the suggested values that are used to set the status depending upon the circumstances.
The following table describes the circumstances:
The following table describes all the methods that are declared in the interface:
5.7 SchedulerJobException Class
If your custom code cannot complete successfully, then throw an instance of this exception class.
package com.siebel.analytics.scheduler.javahostrpccalls; public final class SchedulerJobException extends Exception {
Members Description
public final int kJavaJobInformation = 0 Contains an informational message.
public final int kJavaJobWarning = 1 Contains a warning message.
public final int kJavaJobError = 2 Contains an error message.
Method Description
int jobID Returns the job ID that is associated with the agent.
int instanceID Returns the instance ID that is associated with the agent.
int parameterCount Returns how many parameters are associated with the
agent. String parameterint index
Returns the indexed parameter for the agent.1. boolean hasResultSet
Specifies if there is a result set for this agent. File getResultSetFile
Returns a file of result set for this agent 2. String userID
Returns the ID of the user who is running the agent. int getExitCode
Returns the exit code for the agent. void setExitCodeint exitCode
User can set the exit code for the agent. int getStatus
Returns the status code for the agent. void setStatusint status
User can set the status code for the agent. String getMessage
Returns the message that is associated with the agent. void setMessageString
message User can set the message that is associated with the agent. It
replaces the existing message. void appendMessageString
message User can append an additional message to the agent.
Programming BI Scheduler Java Jobs 5-7
public SchedulerJobExceptionint exitCode, int status, String message { m_exitCode = exitCode;
m_status = status; m_message = message;
} public int getExitCode {
return m_exitCode; }
public int getStatus { return m_status;
} public String getMessage {
return m_message; }
private int m_exitCode; private int m_status;
private String m_message; }
The run method of the SchedulerJavaExtension interface is declared to throw SchedulerJobException. The following table describes the three members:
5.8 Oracle BI Scheduler Java Extension Example
