com.ptc.wvs.common.ui
Class QueueMonitor

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

public class QueueMonitor

extends Object

Field Summary

private static boolean	SERVER
private static String	SERVER_CLASS

Constructor Summary

QueueMonitor()

Method Summary

static void	deleteQueueEntry(boolean deleteWaiting, boolean deleteOnlySuccess, String containerRef) Deletes all the users queue entries
static void	deleteQueueEntry(String containerRef) Deletes all the users queue entries Supported API: false
static void	deleteQueueEntry(String queueNo, String queueEntryNo) Deletes a queue entry from a queue Supported API: false
static String	displayQueueEntry(String queueNo, String queueEntryNo, Boolean refresh, Locale locale) Retrieves the detailed log information for a PublishJob Supported API: false
static String	getStatistics(Boolean refresh, Boolean onlyFailures, Boolean displayAll, String containerRef, Locale locale) Retrieves the PublishJob statistics from the Publisher Queues 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

Constructor Detail

QueueMonitor

public QueueMonitor()

Method Detail

deleteQueueEntry

public static void deleteQueueEntry(String containerRef)

Deletes all the users queue entries

Supported API: false

deleteQueueEntry

public static void deleteQueueEntry(boolean deleteWaiting,
                                    boolean deleteOnlySuccess,
                                    String containerRef)

Deletes all the users queue entries

Parameters:

deleteWaiting - - deletes jobs waiting to execute

deleteOnlySuccess - - only delete completed jobs that were also successfull

Supported API: false

deleteQueueEntry

public static void deleteQueueEntry(String queueNo,
                                    String queueEntryNo)

Deletes a queue entry from a queue

Supported API: false

Parameters:

queueNo - The queue number in which the job was processed

queueEntryNo - The queue entry number of the job

getStatistics

public static String getStatistics(Boolean refresh,
                                   Boolean onlyFailures,
                                   Boolean displayAll,
                                   String containerRef,
                                   Locale locale)

Retrieves the PublishJob statistics from the Publisher Queues

Supported API: false

Parameters:

refresh - True if the contents of the table is refreshing

onlyFailures - display only failures

displayAll - force the display of all entries (ie. more than max count)

containerRef - container that the display is for, null for all

locale - the client locale for the data

Returns:

String The complete table of results in HTML

displayQueueEntry

public static String displayQueueEntry(String queueNo,
                                       String queueEntryNo,
                                       Boolean refresh,
                                       Locale locale)

Retrieves the detailed log information for a PublishJob

Supported API: false

Parameters:

queueNo - The queue number in which the job was processed

queueEntryNo - The queue entry number of the job

Returns:

String The complete log in HTML