ibi.broker.api.data.schedule
Class Task

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Task.SystemTask, TaskFile, TaskFtp, TaskSchedule, TaskUrl, TaskWFServerProcedure

public abstract class Task
extends java.lang.Object
implements java.io.Serializable

 The Task class is an abstract class used to derive classes representing
 the six ReportCaster task objects:
 1. WF Server Procedure 
 2. MyReport
 3. Standard Report
 4. File
 5. URL
 6. Task
 Each task type corresponds to a means of accessing a report type
 distributed by ReportCaster. 

See Also:

Serialized Form

Nested Class Summary

static class

Task.SystemTask

Field Summary

protected java.lang.String	description
protected boolean	enabled
static int	FILE Task type indicating a File task.
static int	FTP
protected java.lang.String	id
static int	MAINFRAME_JES_RETRIEVE
static int	MY_REPORT Task type indicating a Managed Reporting My Report task.
protected java.lang.String	procedureName
protected java.lang.String	reportName
static int	SCHEDULE
static int	STANDARD_REPORT Task type indicating a Managed Reporting Standard Report task.
protected TimeInterval	taskRetry
static int	URL Task type indicating a URL task.
static int	WEBFOCUS_SERVER_PROCEDURE Task type indicating a WebFocus Server Procedure task.

Constructor Summary

Task()

Method Summary

java.lang.String	getDescription() Obtains the text used to describe the task.
java.lang.String	getId() Obtains the unique identifier ReportCaster generates for every saved task.
java.lang.String	getProcedureName() Obtains the name of the FOCUS executable procedure ("FOCEXEC") that resides on the reporting server associated with this task.
java.lang.String	getReportName() Obtains the name of the report associated with this task.
TimeInterval	getTaskRetry()
boolean	isEnabled()
void	setDescription(java.lang.String description) Assigns the text used to describe the task.
void	setEnabled(boolean enabled)
void	setId(java.lang.String id) Assigns the unique identifier ReportCaster generates for every saved task.
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.
void	setReportName(java.lang.String reportName) Assigns the name of the report associated with this task.
void	setTaskRetry(TimeInterval retry)

Methods inherited from class java.lang.Object

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

Field Detail

WEBFOCUS_SERVER_PROCEDURE

public static final int WEBFOCUS_SERVER_PROCEDURE

Task type indicating a WebFocus Server Procedure task.

See Also:

STANDARD_REPORT, MY_REPORT, URL, FILE, Constant Field Values

STANDARD_REPORT

public static final int STANDARD_REPORT

Task type indicating a Managed Reporting Standard Report task.

See Also:

WEBFOCUS_SERVER_PROCEDURE, MY_REPORT, URL, FILE, Constant Field Values

MY_REPORT

public static final int MY_REPORT

Task type indicating a Managed Reporting My Report task.

See Also:

WEBFOCUS_SERVER_PROCEDURE, STANDARD_REPORT, URL, FILE, Constant Field Values

URL

public static final int URL

Task type indicating a URL task.

See Also:

WEBFOCUS_SERVER_PROCEDURE, STANDARD_REPORT, MY_REPORT, FILE, Constant Field Values

FILE

public static final int FILE

Task type indicating a File task.

See Also:

WEBFOCUS_SERVER_PROCEDURE, STANDARD_REPORT, MY_REPORT, URL, Constant Field Values

FTP

public static final int FTP

See Also:

Constant Field Values

MAINFRAME_JES_RETRIEVE

public static final int MAINFRAME_JES_RETRIEVE

See Also:

Constant Field Values

SCHEDULE

public static final int SCHEDULE

See Also:

Constant Field Values

id

protected java.lang.String id

description

protected java.lang.String description

enabled

protected boolean enabled

reportName

protected java.lang.String reportName

procedureName

protected java.lang.String procedureName

taskRetry

protected TimeInterval taskRetry

Constructor Detail

Task

public Task()

Method Detail

getId

public java.lang.String getId()

Obtains the unique identifier ReportCaster generates for every saved task. The user/coder is not allowed to manipulate this ID. If it is assigned a value different from the generated value, ReportCaster will override that with the generated ID.

Returns:

The unique task id as a String.

See Also:

setId(java.lang.String)

setId

public void setId(java.lang.String id)

Assigns the unique identifier ReportCaster generates for every saved task. The user is not allowed to manipulate this ID. If it is assigned a value different from the generated value, ReportCaster will override that with the generated ID.

Parameters:

id - The String identifier.

See Also:

getId()

getDescription

public java.lang.String getDescription()

Obtains the text used to describe the task. This text occupies the Task Name field on the ReportCaster GUI. The maximum size for the description is 255 characters.

Returns:

The description as a String.

See Also:

setDescription(String)

setDescription

public void setDescription(java.lang.String description)

Assigns the text used to describe the task. This text occupies the Task Name field on the ReportCaster GUI. The maximum size for the description is 255 characters.

Parameters:

description - The description/name of the task.

See Also:

getDescription()

getReportName

public java.lang.String getReportName()

Obtains the name of the report associated with this task. The maximum size for report name is 64 characters.

Returns:

The report name as a String.

See Also:

setReportName(java.lang.String)

setReportName

public void setReportName(java.lang.String reportName)

Assigns the name of the report associated with this task. The maximum size for report name is 64 characters.

Parameters:

reportName - The name of the report.

See Also:

getReportName()

getTaskRetry

public TimeInterval getTaskRetry()

setTaskRetry

public void setTaskRetry(TimeInterval retry)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getProcedureName

public java.lang.String getProcedureName()

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.

Returns:

The FOCUS procedure name as a String.

See Also:

setProcedureName(java.lang.String)

setProcedureName

public 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. This FOCUS procedure is the program responsible for generating the report that this task will create.

Parameters:

procedureName - The FOCUS executable procedure name.

See Also:

getProcedureName()