3-10 Developers Guide for Oracle Business Intelligence Publisher
3.21 getScheduledJobInfo Method
Use the getScheduledJobInfo method to return a JobDetail object that provides the details about a submitted job, including report parameters and other properties. This
method retrieves all information stored in the database for a given jobInstanceID, userID, and password.
Signature JobInfo getScheduledJobInfoint jobInstanceID, String userID, String password;
3.22 getScheduledJobInfoInSession Method
Returns a JobDetail object that provides the details for the job that’s associated with a given jobInstanceID and the bipSessionToken of a given user.
For more information about in-session methods, see Section 1.2, About In-Session
Methods.
Signature JobDetail getScheduledJobInfoInSessionString jobInstanceID, String
bipSessionToken;
Table 3–20 Parameters for getDocumentDataInSession Method
Parameter Description
String jobOutputID The ID assigned to the output. The jobOutputID is a string
of integers. String bipSessionToken
The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the
user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore
the BI Publisher server session to perform needed operation.
Table 3–21 Parameters for getScheduledJobInfo Method
Parameter Description
int jobInstanceID The ID of the job for which to return job information.
String userID Specifies the BI Publisher user name.
String password Specifies the password for the user name.
Table 3–22 Parameters for getScheduledJobInfoInSession Method
Parameter Description
String jobInstanceID The ID assigned to the job instance. The jobInstanceID is a
string of integers. String bipSessionToken
The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the
user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore
the BI Publisher server session to perform needed operation.
ScheduleService 3-11
3.23 getScheduledReportDeliveryInfo Method
Use the getScheduledReportdeliveryInfo method to retrieve information about the delivery of a scheduled job output. For each scheduled Job, it could have multiple
outputIDs. For each outputID, there could be multiple delivery info. See Section 2.3.35,
JobOutputDeliverysList.
Signature JobOutputDeliverysList getScheduledReportDeliveryInfoString jobOutputID, String
userID, String password;
3.24 getScheduledReportDeliveryInfoInSession Method
Returns a JobOutputDeliverysList object that provides the details for a given jobOutputID and the bipSessionToken of a given user.
For more information about in-session methods, see Section 1.2, About In-Session
Methods.
Signature JobOutputDeliverysList getScheduledReportDeliveryInfoInSessionString
jobOutputID, String bipSessionToken;
3.25 getScheduledReportOutputInfo Method
Use the getScheduledReportOutputInfo method to return information about a specific scheduled report output.
Signature JobOutputsList getScheduledReportOutputInfoString jobInstanceID, String userID,
String password;
Table 3–23 Parameters for getScheduledReportDeliveryInfo Method
Parameter Description
String jobOutputID The ID assigned to the output of the job for which you
want information. The jobOutputID is a string of integers. String userID
Specifies the BI Publisher user name. String password
Specifies the password for the user name.
Table 3–24 Parameters for getScheduledReportDeliveryInfoInSession Method
Parameter Description
String jobOutputID The ID assigned to the job output. The jobOutputID is a
string of integers. String bipSessionToken
The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the
user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore
the BI Publisher server session to perform needed operation.