ibi.broker.api.data.schedule
Class TaskFile

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

All Implemented Interfaces:

java.io.Serializable

public class TaskFile
extends Task

 The TaskFile class is one of six task types supported by ReportCaster (WebFOCUS 
 Server procedure, MyReport, Standard Report, FTP, and URL are the others).  
 Each task type corresponds to a means of running or accessing a report that 
 can be distributed by ReportCaster. TaskFile allows ReportCaster to schedule 
 the distribution of a file, represented by a fully qualified path to which the
 ReportCaster Distribution Sever has read access.       
 The code below illustrates the use of the TaskFile 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.
        TaskFile task = new TaskFile();
        task.setFileName("c://myreportfiles/filetodistribute.xml");
 

Version:

5.3

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

TaskFile()

Method Summary

java.lang.String	getFileName() Obtains the name of the file to be scheduled for distribution by ReportCaster.
java.lang.String	getProcedureName() Obtains the name of the FOCUS executable procedure ("FOCEXEC") that resides on the reporting server associated with this task.
boolean	isDeleteFileAfterRetrieval()
void	setDeleteFileAfterRetrieval(boolean deleteFileAfterRetrieval)
void	setFileName(java.lang.String fileName) Assigns the name of the file to be scheduled for distribution by ReportCaster.
void	setProcedureName(java.lang.String procedureName) Assigns the name of the FOCUS executable procedure ("FOCEXEC") that resides on the reporting server that is associated with this task.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskFile

public TaskFile()

Method Detail

getFileName

public java.lang.String getFileName()

Obtains the name of the file to be scheduled for distribution by ReportCaster. The name of the file must be preceded by a fully qualified path to which the ReportCaster Server has read access. The maximum size for the file name (including path ) is 255 characters.

Returns:

name of the file to be scheduled as a String.

See Also:

setFileName(java.lang.String)

setFileName

public void setFileName(java.lang.String fileName)

Assigns the name of the file to be scheduled for distribution by ReportCaster. The name of the file must be preceded by a fully qualified path to which the ReportCaster Server has read access. . * The maximum size for the file name (including path String) is 255 characters.

Parameters:

fileName - The name of the file.

See Also:

getFileName()

isDeleteFileAfterRetrieval

public boolean isDeleteFileAfterRetrieval()

setDeleteFileAfterRetrieval

public void setDeleteFileAfterRetrieval(boolean deleteFileAfterRetrieval)

getProcedureName

public java.lang.String getProcedureName()

Description copied from class: Task

Obtains the name of the FOCUS executable procedure ("FOCEXEC") that resides on the reporting server associated with this task. This FOCUS procedure is the program responsible for generating the report that this task will create.

Overrides:

getProcedureName in class Task

Returns:

The FOCUS procedure name as a String.

See Also:

Task.setProcedureName(java.lang.String)

setProcedureName

public void setProcedureName(java.lang.String procedureName)

Description copied from class: Task

Assigns the name of the FOCUS executable procedure ("FOCEXEC") that resides on the reporting server that is associated with this task. This FOCUS procedure is the program responsible for generating the report that this task will create.

Overrides:

setProcedureName in class Task

Parameters:

procedureName - The FOCUS executable procedure name.

See Also:

Task.getProcedureName()