|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectibi.broker.api.data.schedule.Task
ibi.broker.api.data.schedule.TaskFtp
public class TaskFtp
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.
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 |
---|
public TaskFtp()
Method Detail |
---|
public java.lang.String getFileName()
setFileName(java.lang.String)
public boolean isDeleteAfterRetrieval()
setDeleteAfterRetrieval(boolean)
public java.lang.String getPassword()
public java.lang.String getServerName()
public java.lang.String getUserName()
public void setFileName(java.lang.String string)
string
- The name of the file.getFileName()
public void setDeleteAfterRetrieval(boolean b)
b
- The deleteJobAfterRun to set.isDeleteAfterRetrieval()
public void setPassword(java.lang.String string)
string
- A character Array representing this password.public void setServerName(java.lang.String string)
string
- The name of the server containing FOCUS Executable that
creates the Dynamic Distribution List, as a String.public void setUserName(java.lang.String string)
string
- A String representing this user name.public java.lang.String getSendFormat()
public void setSendFormat(java.lang.String sendFormat)
public java.lang.String getProcedureName()
Task
getProcedureName
in class Task
Task.setProcedureName(java.lang.String)
public void setProcedureName(java.lang.String procedureName)
Task
setProcedureName
in class Task
procedureName
- The FOCUS executable procedure name.Task.getProcedureName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |