com.ptc.wvs.common.ui
Class Scheduler

java.lang.Object
  com.ptc.wvs.common.ui.Scheduler

public class Scheduler

extends Object

Field Summary

private static String	errorMessage
private static boolean	SERVER
private static String	SERVER_CLASS

Constructor Summary

Scheduler()

Method Summary

static 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 invalidDate, String containerRef) Creates a schedule entry Supported API: false
static 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 invalidDate, String containerRef, boolean listOnly) Creates a schedule entry Supported API: false
static boolean	deleteScheduleItem(String objectReference) Deletes a schedule entry Supported API: false
static String	getContainerName(String containerRef)
static String	getErrorMessage() Returns error message during server side processing Supported API: false
static String	getList(String statusText) Returns a list of all the Scheduled jobs Supported API: false
static String	getList(String statusText, Locale locale)
static String	getList(String statusText, String containerRef, Locale locale) Returns a list of all the Scheduled jobs Supported API: false
static String	getLogFileContents(String objectReference) get the log file contents for a schedule job Supported API: false
static String	getPublishMethods(String containerRef) retrives the Publish Methods in a form of an HTML SELECT list Supported API: false
static String	getQueueName() Returns the name of the Schedule Queue Supported API: false
private static void	setErrorMessage(String message) Sets the error message Supported API: false

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_CLASS

private static final String SERVER_CLASS

SERVER

private static final boolean SERVER

errorMessage

private static String errorMessage

Constructor Detail

Scheduler

public Scheduler()

Method Detail

getQueueName

public static String getQueueName()

Returns the name of the Schedule Queue

Supported API: false

Returns:

String Schedule Queue Name

getContainerName

public static String getContainerName(String containerRef)

getLogFileContents

public static 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 static String getList(String statusText)

Returns a list of all the Scheduled jobs

Supported API: false

Returns:

String HTML table

getList

public static String getList(String statusText,
                             Locale locale)

getList

public static String getList(String statusText,
                             String containerRef,
                             Locale locale)

Returns a list of all the Scheduled jobs

Supported API: false

Returns:

String HTML table

createScheduleItem

public static 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 invalidDate,
                                         String containerRef)

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

Returns:

boolean success is TRUE

createScheduleItem

public static 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 invalidDate,
                                         String containerRef,
                                         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

Returns:

boolean success is TRUE

deleteScheduleItem

public static boolean deleteScheduleItem(String objectReference)

Deletes a schedule entry

Supported API: false

Parameters:

objectReference - entry to delete

Returns:

boolean success is true

getPublishMethods

public static String getPublishMethods(String containerRef)

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

Supported API: false

Returns:

String HTML Select list

getErrorMessage

public static String getErrorMessage()

Returns error message during server side processing

Supported API: false

Returns:

String Error Message

setErrorMessage

private static void setErrorMessage(String message)

Sets the error message

Supported API: false