ibi.broker.api.data.schedule
Class TaskFtp

java.lang.Object
  extended by ibi.broker.api.data.schedule.Task
      extended by ibi.broker.api.data.schedule.TaskFtp
All Implemented Interfaces:
java.io.Serializable

public class TaskFtp
extends Task

 The TaskFTP class is one of six task types supported by ReportCaster (WebFOCUS 
 Server procedure, MyReport, Standard Report, File, and URL are the others). 
 Each task type corresponds to a means of running or accessing a report that 
 can be distributed by ReportCaster. TaskFTP allows ReportCaster to retrieve a file 
 from any FTP server.

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
TaskFtp()
           
 
Method Summary
 java.lang.String getFileName()
          Obtains the name of the file to be scheduled for distribution by ReportCaster.
 java.lang.String getPassword()
          Returns the password as a character Array.
 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 getSendFormat()
           
 java.lang.String getServerName()
          Returns the name of the reporting server that contains the Focus Executable that creates the dynamic distribution list.
 java.lang.String getUserName()
          Retrieves this user's name.
 boolean isDeleteAfterRetrieval()
          Obtains the state of the boolean flag indicating whether or not a schedule is deleted after retrieval.
 void setDeleteAfterRetrieval(boolean b)
          Assigns a boolean flag indicating whether or not a schedule is deleted after retrieval.
 void setFileName(java.lang.String string)
          Assigns the name of the file to be scheduled for distribution by ReportCaster.
 void setPassword(java.lang.String string)
          Sets this password, as a character Array, to this PasswordCredential.
 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 setSendFormat(java.lang.String sendFormat)
           
 void setServerName(java.lang.String string)
          Assigns the name of the reporting server that contains the Focus Executable that creates the dynamic distribution list.
 void setUserName(java.lang.String string)
          Set user name to PasswordCredential.
 
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

TaskFtp

public TaskFtp()
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)

isDeleteAfterRetrieval

public boolean isDeleteAfterRetrieval()
Obtains the state of the boolean flag indicating whether or not a schedule is deleted after retrieval. If TRUE, the job is deleted after retrieval is complete. If FALSE, the job is not deleted after retrieval is complete.

Returns:
Returns the deleteJobAfterRun.
See Also:
setDeleteAfterRetrieval(boolean)

getPassword

public java.lang.String getPassword()
Returns the password as a character Array.

Returns:
char[] A character array representing the password.

getServerName

public java.lang.String getServerName()
Returns the name of the reporting server that contains the Focus Executable that creates the dynamic distribution list.

Returns:
Returns The name of the server containing FOCUS Executable that creates the Dynamic Distribution List, as a String.

getUserName

public java.lang.String getUserName()
Retrieves this user's name.

Returns:
String A string representing the user's name.

setFileName

public void setFileName(java.lang.String string)
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:
string - The name of the file.
See Also:
getFileName()

setDeleteAfterRetrieval

public void setDeleteAfterRetrieval(boolean b)
Assigns a boolean flag indicating whether or not a schedule is deleted after retrieval. If TRUE, the job is deleted after retrieval is completed. If FALSE, the job is not deleted after retrieval is completed.

Parameters:
b - The deleteJobAfterRun to set.
See Also:
isDeleteAfterRetrieval()

setPassword

public void setPassword(java.lang.String string)
Sets this password, as a character Array, to this PasswordCredential.

Parameters:
string - A character Array representing this password.

setServerName

public void setServerName(java.lang.String string)
Assigns the name of the reporting server that contains the Focus Executable that creates the dynamic distribution list.

Parameters:
string - The name of the server containing FOCUS Executable that creates the Dynamic Distribution List, as a String.

setUserName

public void setUserName(java.lang.String string)
Set user name to PasswordCredential.

Parameters:
string - A String representing this user name.

getSendFormat

public java.lang.String getSendFormat()

setSendFormat

public void setSendFormat(java.lang.String sendFormat)

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()


Copyright © 2006 Information Builders, Incorporated.