ibi.broker.api.data.schedule
Class TaskUrl

java.lang.Object
  ibi.broker.api.data.schedule.Task
      ibi.broker.api.data.schedule.TaskUrl

All Implemented Interfaces:

java.io.Serializable

public class TaskUrl
extends Task

 The TaskUrl class is one of six task types supported by ReportCaster 
 (WF Server Procedure, MyReport, Standard Report, FTP, and File 
 are the others). Each task type corresponds to a means of running or 
 accessing a report that can be distributed by ReportCaster. 
 TaskUrl allows ReportCaster to connect to a specified URL at execution time, retrieve the pages        
 returned by that URL and distribute them.  TaskURL can be used to call any type of URL, including programs
 that are executed by JSP and ASP pages as well as reports generated by other reporting products.
  The code below illustrates the use of the TaskURL class:

 + ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 +  Copyright (c) 2004 Information Builders, Inc. All  Rights Reserved.     +
 +                                                                          +
 +  Information Builders offers sample API programs as a heuristic device.  +
 +  They are not intended, as is, for production use. Licensed users are    +
 +  welcome to alter and extend these samples and deploy them in other      +
 +  environments, or alternate configurations, as they see fit.             +
 +  Information Builders will support the documented functionality of       +
 +  its API classes and methods. However, Information Builders is not       +
 +  responsible for functionality or behavior of products built with        +
 +  its API unless the documented behavior of its discrete classes and      +
 +  methods is different than the actual results.                           +
 +                                                                          +
 +  Redistributions of IBI source code and documentation must be within     +
 +  the scope of the Information Builders Software License Agreement.       +
 +                                                                          +
 + ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++   

  //Create task. This will be referenced by a Schedule object.
  TaskURL task = new TaskURL();
  task.setURLString("http://www.ibi.com");
  task.setUserName("foo");
  task.setPassword("foobar");
 

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ibi.broker.api.data.schedule.Task

Task.SystemTask

Field Summary

Fields inherited from class ibi.broker.api.data.schedule.Task

description, enabled, FILE, FTP, id, MAINFRAME_JES_RETRIEVE, MY_REPORT, procedureName, reportName, SCHEDULE, STANDARD_REPORT, taskRetry, URL, WEBFOCUS_SERVER_PROCEDURE

Constructor Summary

TaskUrl()

Method Summary

void	addParameter(Parameter parameter)
Parameter[]	getParameterList() Returns an array of Parameters objects associated with an instance of TaskURL.
java.lang.String	getPassword() Obtains the value of the password necessary to access the URL's Web server.
java.lang.String	getUrlString() Obtains the URL String associated with this instance of TaskURL.
java.lang.String	getUserName() Obtains the value of the user name necessary for access to the URL's Web server.
void	setParameterList(Parameter[] parameterList) Assigns an array of Parameters objects to be associated with an instance of TaskURL.
void	setPassword(java.lang.String password) Assigns the value of the password necessary for access to the URL's Web server.
void	setUrlString(java.lang.String urlString) Assigns the URL String associated with this instance of TaskURL.
void	setUserName(java.lang.String userName) Assigns the value of the user name necessary for access to the URL's Web server.

Methods inherited from class ibi.broker.api.data.schedule.Task

getDescription, getId, getProcedureName, getReportName, getTaskRetry, isEnabled, setDescription, setEnabled, setId, setProcedureName, setReportName, setTaskRetry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskUrl

public TaskUrl()

Method Detail

getParameterList

public Parameter[] getParameterList()

Returns an array of Parameters objects associated with an instance of TaskURL. Each Parameter object in the array contains one name value pair. Upon execution of a schedule, the parameters are appended to the URL in normal fashion, after the ?

Returns:

Returns an array of parameter objects associated with this instance of TaskURL.

setParameterList

public void setParameterList(Parameter[] parameterList)

Assigns an array of Parameters objects to be associated with an instance of TaskURL. Each Parameter object in the array contains one name value pair. Upon execution of a schedule, the parameters are appended to the URL in normal fashion, after the ?

Parameters:

parameterList - Thee array of Parameter objects associated with this instance of TaskURL.

getPassword

public java.lang.String getPassword()

Obtains the value of the password necessary to access the URL's Web server. This password is submitted within the HTTP header.

Returns:

the value of the password necessary to access the URL's Web server.

setPassword

public void setPassword(java.lang.String password)

Assigns the value of the password necessary for access to the URL's Web server. This password is submitted within the HTTP header.

Parameters:

password - The web server password to set as a String.

getUrlString

public java.lang.String getUrlString()

Obtains the URL String associated with this instance of TaskURL. Any parameters associated with this URL will be displayed only if they are manually supplied in the URL String. If the parameters are contained within the Parameter object, they will not be displayed when getUrlString() is called.

Returns:

Returns the URL String, without parameters, associated with this instance of TaskURL.

setUrlString

public void setUrlString(java.lang.String urlString)

Assigns the URL String associated with this instance of TaskURL. Any parameters associated with this URL will be displayed only if they are manually supplied in the URL String. If the parameters are contained within the Parameter object, they will not be displayed when getUrlString() is called.

Parameters:

urlString - The URL String associated with this instance of TaskURL.

getUserName

public java.lang.String getUserName()

Obtains the value of the user name necessary for access to the URL's Web server. This user name is submitted within the HTTP header.

Returns:

Returns the user name necessary for access to the URL's web server.

setUserName

public void setUserName(java.lang.String userName)

Assigns the value of the user name necessary for access to the URL's Web server. This user name is submitted within the HTTP header.

Parameters:

userName - The user name necessary for access to the URL's web server.

addParameter

public void addParameter(Parameter parameter)