com.ptc.wvs.server.schedule
Class SchedulerHelper

java.lang.Object
  com.ptc.wvs.server.schedule.SchedulerHelper

All Implemented Interfaces:

RemoteAccess

public class SchedulerHelper

extends Object

implements RemoteAccess

The server side methods to handle requestes from Schedule

Supported API: false

Extendable: false

Field Summary

private static String	deleteGif
private static String	gifOption
private static String	jspScheduleList
static String	QUEUENAME
private static ScheduleDefinitions	sdefns
private static String	TABLEEVENROWBG
private static String	TABLEODDROWBG
private static String	TARGETCLASS
private static String	TARGETMETHOD
private static boolean	VERBOSE
private static WVSProperties	wvsProperties

Fields inherited from interface wt.method.RemoteAccess

versionID

Constructor Summary

SchedulerHelper()

Method Summary

static Boolean	createScheduleItem(String name, String description, String publish, Boolean immediate, Timestamp start, Integer nruns, Long periodicity, String containerRef, Boolean listOnly) Create a schedule entry Supported API: false
private static boolean	createScheduleQueue(String queueName) Create a schedule Queue Supported API: false
static Boolean	deleteScheduleItem(String objectReference) Deletes a schedule entry Supported API: false
private static MethodArgument[]	getArgsUtil(ScheduleItem item) Temporary just until the scheduler is correctly submitted
static String	getContainerName(String containerRef)
private static WTContainerRef	getContainerRef(String oid)
static String	getListHTML(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
private static String	getPublishClass(String scheduleJob) For the schedulejob selected, return the class definition from the properties file Supported API: false
private static String	getPublishMethod(String scheduleJob) For the schedulejob selected, return the method definition from the properties file Supported API: false
static String	getPublishMethods(String containerRef) retrives the Publish Methods in a form of an HTML SELECT list Supported API: false

Methods inherited from class java.lang.Object

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

Field Detail

QUEUENAME

public static final String QUEUENAME

See Also:

Constant Field Values

TARGETCLASS

private static String TARGETCLASS

TARGETMETHOD

private static String TARGETMETHOD

TABLEODDROWBG

private static String TABLEODDROWBG

TABLEEVENROWBG

private static String TABLEEVENROWBG

jspScheduleList

private static String jspScheduleList

deleteGif

private static String deleteGif

gifOption

private static String gifOption

sdefns

private static ScheduleDefinitions sdefns

VERBOSE

private static boolean VERBOSE

wvsProperties

private static WVSProperties wvsProperties

Constructor Detail

SchedulerHelper

public SchedulerHelper()

Method Detail

getContainerRef

private static WTContainerRef getContainerRef(String oid)
                                       throws WTException

Throws:

WTException

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

getListHTML

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

Returns a list of all the Scheduled jobs

Supported API: false

Returns:

String HTML table

createScheduleQueue

private static boolean createScheduleQueue(String queueName)

Create a schedule Queue

Supported API: false

Returns:

boolean true if created or already created

createScheduleItem

public static Boolean createScheduleItem(String name,
                                         String description,
                                         String publish,
                                         Boolean immediate,
                                         Timestamp start,
                                         Integer nruns,
                                         Long periodicity,
                                         String containerRef,
                                         Boolean listOnly)

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

start - Time for job to start (if not immediate)

nruns - The number of runs

periodicity - The frequency in seconds

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

getPublishClass

private static String getPublishClass(String scheduleJob)

For the schedulejob selected, return the class definition from the properties file

Supported API: false

Parameters:

scheduleJob - The scheduleJob

Returns:

String The class associate to the scheduleJob

getPublishMethod

private static String getPublishMethod(String scheduleJob)

For the schedulejob selected, return the method definition from the properties file

Supported API: false

Parameters:

scheduleJob - The scheduleJob

Returns:

String The method associate to the scheduleJob

getArgsUtil

private static MethodArgument[] getArgsUtil(ScheduleItem item)

Temporary just until the scheduler is correctly submitted