com.ptc.wvs.client.beans
Class Schedule

java.lang.Object
  com.ptc.wvs.client.beans.Schedule

public class Schedule

extends Object

Field Summary

private String

containerRef

Constructor Summary

Schedule()

Method Summary

boolean	createScheduleItem(String name, String description, String publish, boolean immediate, String startYear, String startMonth, String startDay, String startHour, String startMinute, String frequency, String freqDay, String freqHour, String freqMinute, String dateMessage) Creates a schedule entry Supported API: false
boolean	createScheduleItem(String name, String description, String publish, boolean immediate, String startYear, String startMonth, String startDay, String startHour, String startMinute, String frequency, String freqDay, String freqHour, String freqMinute, String dateMessage, boolean listOnly) Creates a schedule entry Supported API: false
boolean	deleteScheduleItem(String objectReference) Deletes a schedule entry Supported API: false
String	getContainerName()
String	getContainerRef()
String	getDayPulldown() retrives the Day pulldown Supported API: false
String	getErrorMessage() Returns error message during server side processing Supported API: false
String	getHourPulldown() retrives the Hour pulldown Supported API: false
String	getHourPulldown(int defaultHour, String idPrefix) retrives the Hour pulldown Supported API: false
String	getList(String statusText, Locale locale) Returns a list of all the Scheduled jobs Supported API: false
String	getLogFileContents(String objectReference) get the log file contents for a schedule job Supported API: false
String	getMinutePulldown() retrives the Minute pulldown Supported API: false
String	getMinutePulldown(int defaultMinute, String idPrefix) retrives the Minute pulldown Supported API: false
String	getMonthPulldown() retrives the Month pulldown Supported API: false
String	getPublishMethods() retrives the Publish Methods in a form of an HTML SELECT list Supported API: false
String	getQueueName() Returns the name of the Schedule Queue Supported API: false
String	getYearPulldown() retrives the Year pulldown Supported API: false
boolean	isVerbose()
void	setContainerRef(String ref)

Methods inherited from class java.lang.Object

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

Field Detail

containerRef

private String containerRef

Constructor Detail

Schedule

public Schedule()

Method Detail

setContainerRef

public void setContainerRef(String ref)

getContainerRef

public String getContainerRef()

getContainerName

public String getContainerName()

getQueueName

public String getQueueName()

Returns the name of the Schedule Queue

Supported API: false

Returns:

String Schedule Queue Name

getLogFileContents

public String getLogFileContents(String objectReference)

get the log file contents for a schedule job

Supported API: false

Parameters:

objectReference - queue entry

Returns:

String log file contents

getList

public String getList(String statusText,
                      Locale locale)

Returns a list of all the Scheduled jobs

Supported API: false

Parameters:

statusText - value for status field, comma separated eg. "Done,Once"

Returns:

String HTML table

createScheduleItem

public boolean createScheduleItem(String name,
                                  String description,
                                  String publish,
                                  boolean immediate,
                                  String startYear,
                                  String startMonth,
                                  String startDay,
                                  String startHour,
                                  String startMinute,
                                  String frequency,
                                  String freqDay,
                                  String freqHour,
                                  String freqMinute,
                                  String dateMessage)

Creates a schedule entry

Supported API: false

Parameters:

name - The name of the schedule entry to be created

description - The description of the schedule entry to be created

publish - The type of job to submit

immediate - true if job is to be submitted immediately (otherewise uses start)

startYear - Year in the form YYYY

startMonth - Month the form MM start from 01 for January

startDay - Day the form DD

startHour - Hour the form DD

startMinute - Minute the form DD

frequency - The number of runs

freqDay - Day frequency

freqHour - Hour frequency

freqMinute - Minute frequency

dateMessage - Invalid date error message

Returns:

boolean success is TRUE

createScheduleItem

public boolean createScheduleItem(String name,
                                  String description,
                                  String publish,
                                  boolean immediate,
                                  String startYear,
                                  String startMonth,
                                  String startDay,
                                  String startHour,
                                  String startMinute,
                                  String frequency,
                                  String freqDay,
                                  String freqHour,
                                  String freqMinute,
                                  String dateMessage,
                                  boolean listOnly)

Creates a schedule entry

Supported API: false

Parameters:

name - The name of the schedule entry to be created

description - The description of the schedule entry to be created

publish - The type of job to submit

immediate - true if job is to be submitted immediately (otherewise uses start)

startYear - Year in the form YYYY

startMonth - Month the form MM start from 01 for January

startDay - Day the form DD

startHour - Hour the form DD

startMinute - Minute the form DD

frequency - The number of runs

freqDay - Day frequency

freqHour - Hour frequency

freqMinute - Minute frequency

dateMessage - Invalid date error message

listOnly - only create a log file with the list of object to be published

Returns:

boolean success is TRUE

deleteScheduleItem

public boolean deleteScheduleItem(String objectReference)

Deletes a schedule entry

Supported API: false

Parameters:

objectReference - entry to delete

Returns:

boolean success is true

getPublishMethods

public String getPublishMethods()

retrives the Publish Methods in a form of an HTML SELECT list

Supported API: false

Returns:

String HTML Select list

getYearPulldown

public String getYearPulldown()

retrives the Year pulldown

Supported API: false

Returns:

String HTML Option pulldown for year

getMonthPulldown

public String getMonthPulldown()

retrives the Month pulldown

Supported API: false

Returns:

String HTML Option pulldown for Month

getDayPulldown

public String getDayPulldown()

retrives the Day pulldown

Supported API: false

Returns:

String HTML Option pulldown for Day

getHourPulldown

public String getHourPulldown()

retrives the Hour pulldown

Supported API: false

Returns:

String HTML Option pulldown for Hour

getHourPulldown

public String getHourPulldown(int defaultHour,
                              String idPrefix)

retrives the Hour pulldown

Supported API: false

Parameters:

defaultHour - The selected hour

Returns:

String HTML Option pulldown for Hour

getMinutePulldown

public String getMinutePulldown()

retrives the Minute pulldown

Supported API: false

Returns:

String HTML Option pulldown for Minute

getMinutePulldown

public String getMinutePulldown(int defaultMinute,
                                String idPrefix)

retrives the Minute pulldown

Supported API: false

Parameters:

defaultMinute - The selected item

Returns:

String HTML Option pulldown for Minute

isVerbose

public boolean isVerbose()

getErrorMessage

public String getErrorMessage()

Returns error message during server side processing

Supported API: false

Returns:

String Error Message