com.ptc.windchill.cadx.common.htmllog
Class StandardHTMLLogService

java.lang.Object
  wt.services.StandardManager
      com.ptc.windchill.cadx.common.htmllog.StandardHTMLLogService

All Implemented Interfaces:

HTMLLogService, Manager, NetFactor, Serializable

public class StandardHTMLLogService

extends StandardManager

implements HTMLLogService, Serializable

Use the newStandardHTMLLogService static factory method(s), not the StandardHTMLLogService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Nested Class Summary

private class

StandardHTMLLogService.MessageTransactionListener

Field Summary

private static String	CLASSNAME
private static ScheduleItem	g_scheduledLogMessagePurging
private static String	RESOURCE
private static boolean	VERBOSE

Fields inherited from class wt.services.StandardManager

Fields inherited from interface wt.services.Manager

MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE

Constructor Summary

StandardHTMLLogService()

Method Summary

void	addMessage(int messageType, String message) Supported API: false
void	clearLog() method to clear all log messages for given user Supported API: false
private HTMLLog	createLog(String id)
String	getConceptualClassname() Deprecated.
private HTMLLog	getLog()
private HTMLLog	getLog(String id)
List	getLogMessages(int max_nof_messages, boolean most_recent) method to get list of messages for the current user Parameters : max_nof_messages - maximum no.
private HTMLLogMessage	newLogMessage(int messageType, String message)
static StandardHTMLLogService	newStandardHTMLLogService() Default factory for the class.

Methods inherited from class wt.services.StandardManager

emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, performStartupProcess, registerEvents, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

VERBOSE

private static boolean VERBOSE

g_scheduledLogMessagePurging

private static ScheduleItem g_scheduledLogMessagePurging

Constructor Detail

StandardHTMLLogService

public StandardHTMLLogService()

Method Detail

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Overrides:

getConceptualClassname in class StandardManager

Returns:

String

getLog

private HTMLLog getLog(String id)
                throws WTException

Parameters:

id -

Returns:

HTMLLog

Throws:

WTException

newStandardHTMLLogService

public static StandardHTMLLogService newStandardHTMLLogService()
                                                        throws WTException

Default factory for the class.

Supported API: false

Returns:

StandardHTMLLogService

Throws:

WTException

clearLog

public void clearLog()
              throws WTException

method to clear all log messages for given user

Supported API: false

Specified by:

clearLog in interface HTMLLogService

Throws:

WTException

getLogMessages

public List getLogMessages(int max_nof_messages,
                           boolean most_recent)
                    throws WTException

method to get list of messages for the current user Parameters : max_nof_messages - maximum no. of messages to be returned by the method. If all messages are to be returned then -1 should be passed as parameter. most_recent - If messages are more than max_nof_messages parameter then this parameter is used to determine if most recent (parameter = true) or the first (parameter = false) messages equal to max_nof_messages should be returned.

Supported API: false

Specified by:

getLogMessages in interface HTMLLogService

Parameters:

max_nof_messages -

most_recent -

Returns:

List

Throws:

WTException

addMessage

public void addMessage(int messageType,
                       String message)
                throws WTException

Supported API: false

Specified by:

addMessage in interface HTMLLogService

Parameters:

messageType -

message -

Throws:

WTException

createLog

private HTMLLog createLog(String id)
                   throws WTException

Throws:

WTException

getLog

private HTMLLog getLog()
                throws WTException

Throws:

WTException

newLogMessage

private HTMLLogMessage newLogMessage(int messageType,
                                     String message)
                              throws WTException

Throws:

WTException