Process Class Relationships

filenet.vw.api
Class VWLogElement

java.lang.Object
  |
  +--filenet.vw.api.VWFieldsObject
        |
        +--filenet.vw.api.VWWorkElement
              |
              +--filenet.vw.api.VWLogElement
All Implemented Interfaces:
IVWtoXML, java.io.Serializable

public final class VWLogElement
extends filenet.vw.api.VWWorkElement
implements IVWtoXML

Use this class to retrieve log element information.This class contains the information on the event log record. You can instantiate this class by calling the VWLogQuery.next() method.

Since:
VWWS3.10
See Also:
VWLogQuery, Serialized Form

Method Summary
 VWDataField[] getDataFields()
          Lists the data fields supported by the log element.
 long getDuration()
          Gets the duration of the logging period.
 int getEventType()
          Gets the event type of the log record.
 java.lang.String[] getFieldNames()
          Lists the system- and user-defined log element field names.
 java.lang.Object getFieldValue(java.lang.String fieldName)
          Gets the value of user-defined field names.
 java.lang.String getInstructionSheetName()
          Gets the name of the instruction sheet for the work object (if an instruction sheet is associated with the log element exists).
 int getMachineId()
          Retrieves the system type of the machine associated with the log element.
 java.lang.String getMapName()
          Gets the name of the workflow map of the work object (if an associated workflow map exists).
 java.lang.String getOperationName()
          Gets the Operation name of the log element (if an associated Operation exists).
 java.lang.String getParentWorkObjectNumber()
          Gets the string version of the Parent work object number.
 java.lang.String getQueueName()
          Gets the name of the queue, containing the log element, that contains the work object (if an associated queue name exists).
 int getSequenceNumber()
          Gets the simple sequence number of the record, beginning the count at 1 and increasing by one with each new record.
 int getServerLocation()
          Get the current server location of the work object.
 java.lang.String getStepName()
          Gets the step name for the log element (if an associated step name exists).
 java.lang.String getText()
          Gets the string of text entered in the log.
 java.util.Date getTimeStamp()
          Gets the timestamp of the current log record.
 java.lang.String getUserName()
          Gets the user name associated with the log record.
 java.lang.String getWorkClassName()
          Gets the name of the work class from which the work object is instantiated, if there is an associated work class name.
 java.lang.String getWorkflowName()
          Gets the name of the workflow (if an associated workflow name exists).
 java.lang.String getWorkFlowNumber()
          Get the string version of the WorkFlow number.
 java.lang.String getWorkObjectNumber()
          Gets the string version of the work object number.
 java.lang.String getWorkObjectTag()
          Gets the work object tag value.
 int getWorkOrderId()
          Gets the authored work order ID for the Instruction or step the work object was processing at the time the system logged the record.
 boolean hasField(java.lang.String fieldName)
          Determines whether or not the user-defined field name exists.
 java.lang.String toString()
          Gets a string version of the time stamp and sequence number for the record.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string that represents this VWLogElement object to the buffer specified by the input parameter.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getFieldNames

public java.lang.String[] getFieldNames()
Lists the system- and user-defined log element field names.
Returns:
A string containing an array of the system- and user-defined field names.

getFieldValue

public java.lang.Object getFieldValue(java.lang.String fieldName)
                               throws VWException
Gets the value of user-defined field names.
Parameters:
fieldName - The name of the field from which to return the value.
Throws:
VWException - The method throws an exception if the field name specified in the fieldName parameter does not exist.

hasField

public boolean hasField(java.lang.String fieldName)
                 throws VWException
Determines whether or not the user-defined field name exists.
Parameters:
fieldName - The user-defined field name to check.
Returns:
A Boolean value. The method returns true a field with the name specified in the fieldName parameter exists; otherwise, the method returns false.
Throws:
VWException - The method throws an exception if it cannot determine whether or not the user-defined field name exists.

getTimeStamp

public java.util.Date getTimeStamp()
                            throws VWException
Gets the timestamp of the current log record. This is a date variable showing the time the log element was included in the log.
Returns:
A time value for the time when the log element was included in the log.
Throws:
VWException - The method throws an exception if it cannot obtain the timestamp for the log record.

getSequenceNumber

public int getSequenceNumber()
                      throws VWException
Gets the simple sequence number of the record, beginning the count at 1 and increasing by one with each new record.
Throws:
VWException - The method throws an exception if it cannot obtain the sequence number of the record.

getUserName

public java.lang.String getUserName()
                             throws VWException
Gets the user name associated with the log record.
Returns:
The user name associated with the log record.
Throws:
VWException - The method throws an exception if it cannot obtain the user name associated with the log record.

getEventType

public int getEventType()
                 throws VWException
Gets the event type of the log record. Process system events belong to three categories: Events that pertain to Process system (VW), events that pertain to work objects (WO), and events that pertain to Work Performers (WP).

Possible logging options are:


The event type characterizes event the system logged for the logging option. To view descriptions of these events, refer to the "Manage Event Logs" section of the Process Configuration Console.

The following list includes all possible events; the list is arranged by logging option values, in ascending order:

VW_WOTraceOption:

    100     VW_WOSystemOperationMsg
    110     VW_WOMovedToServerMsg
    120     VW_WONameChangedMsg

VW_WOCreateOption:

    130     VW_WOChildCreationMsg
    140     VW_WOParentCreationMsg

VW_WOTerminateOption:

    150     VW_WOChildTerminationMsg
    160     VW_WOParentTerminationMsg

VW_WOExceptionOption:

    170     VW_WOExceptionMsg
    172     VW_WODeadlineMsg
    174     VW_WOReminderMsg

VW_ WOAdministrationOption:

    180     VW_WOForcedToSkipInstructionMsg
    190     VW_WOForcedToTerminateMsg
    200     VW_WOForcedToDeleteMsg

VW_VMSystem:

    230     VW_VWLogVectorChangedMsg
    240     VW_VWUserLoginMsg
    250     VW_VWUserLogoutMsg
    260     VW_VWStartTransferMsg
    270     VW_VWEndTransferMsg
    280     VW_VWStartCleanRepositoryMsg
    290     VW_VWEndCleanRepositoryMsg
    300     VW_VWStartInitRegionMsg
    310     VW_VWEndInitRegionMsg
    320     VW_VWStartFullInitializeMsg
    330     VW_VWEndFullInitializeMsg
    340     VW_VWRemoveDatabaseMsg

VW_VMBeginServiceOption:

    350     VW_WPBeginServiceMsg
    352     VW_WPWorkObjectQueuedMsg

VW_VMServiceCompleteOption:

    360     VW_WPEndServiceNormalMsg
    370     VW_WPEndServiceAbnormalMsg
    380     VW_WPEndServiceReleaseMsg
    382     VW_WPEndServiceReleaseDelegateMsg
    384     VW_WPEndServiceReleaseReassignMsg
    386     VW_WPEndServiceReleaseReturnMsg
    390     VW_WPEndServiceAbortMsg
    400     VW_WPCheckPointMsg

VW_USER1Option:

    410     VW_User11Msg
    420     VW_User12Msg
    430     VW_User13Msg
    440     VW_User14Msg

VW_USER2Option:
    450     VW_User21Msg
    460     VW_User22Msg
    470     VW_User23Msg
    480     VW_User24Msg

Returns:
An integer value indicating the event type.
Throws:
VWException - The method throws an exception if it cannot get the event type of the log record.
See Also:
VWLoggingOptionType.getLocalizedString(int)

getWorkObjectNumber

public java.lang.String getWorkObjectNumber()
                                     throws VWException
Gets the string version of the work object number.
Returns:
The work object number.
Throws:
VWException - The method throws an exception if it cannot obtain a work object Number.

getParentWorkObjectNumber

public java.lang.String getParentWorkObjectNumber()
                                           throws VWException
Gets the string version of the Parent work object number.
Returns:
The Parent work object number.
Throws:
VWException - The method throws an exception if it cannot obtain and formatthe Parent work object number.

getQueueName

public java.lang.String getQueueName()
                              throws VWException
Gets the name of the queue, containing the log element, that contains the work object (if an associated queue name exists).
Throws:
VWException - The method throws an exception if it cannot obtain the name of the appropriate queue.

getOperationName

public java.lang.String getOperationName()
                                  throws VWException
Gets the Operation name of the log element (if an associated Operation exists).
Returns:
The Operation name of the log element. If there is no Operation associated with the log element, the string value is null.
Throws:
VWException - The method throws an exception if it cannot obtain an existing Operation name of the log element.

getWorkClassName

public java.lang.String getWorkClassName()
                                  throws VWException
Gets the name of the work class from which the work object is instantiated, if there is an associated work class name.
Returns:
The name of the work class; null if there is no associated work class.
Throws:
VWException - The method throws an exception if it cannot obtain a string containing an associated name of the work class, if it exists. If there is no associated work class, the string returns null.

getInstructionSheetName

public java.lang.String getInstructionSheetName()
                                         throws VWException
Gets the name of the instruction sheet for the work object (if an instruction sheet is associated with the log element exists).
Returns:
The current instruction sheet name. If there is no instruction sheet associated with the log element, the string value is null.
Throws:
VWException - The method throws an exception if it cannot correctly obtain the name of the instruction sheet for the Work object.

getMachineId

public int getMachineId()
                 throws VWException
Retrieves the system type of the machine associated with the log element.

The following values identify the machine:
    0    There is no machine.
   -1    This indicates a Process system.
   -2    This indicates a Java Web Services application.
The value -2 returns when there is no machine ID associated with a Web Services application.

Returns:
A integer value indicating the machine type associated with this log element. The possible values are:

  • 0: No machine is associated with the log element.
  • 1: The system is running the Process system.
  • 2: The machine is running a Java-based web services application. (The value -2 returns when there is no machine ID associated with a web services application.)
Throws:
VWException - The method throws an exception if it cannot retrieve the system type of the machine associated with the log element.

getWorkOrderId

public int getWorkOrderId()
                   throws VWException
Gets the authored work order ID for the Instruction or step the work object was processing at the time the system logged the record.
Returns:
An integer value for the authored work order ID. If no associated work order ID exist, the method return –1 as the value.
Throws:
VWException - The method throws an exception if it cannot get the authored work order ID for the Instruction or step that the work object was processing at the time the system logged the record.

getDuration

public long getDuration()
                 throws VWException
Gets the duration of the logging period. Duration is valid only for a specific event.
Returns:
A duration.
Throws:
VWException - The method throws an exception if it cannot get the duration of the logging period.

getWorkObjectTag

public java.lang.String getWorkObjectTag()
                                  throws VWException
Gets the work object tag value.
Returns:
An integer value for the authored work order ID. If no associated work order ID exist, the method return –1 as the value.
Throws:
VWException - The method throws an exception if it cannot get the work object tag value.

getText

public java.lang.String getText()
                         throws VWException
Gets the string of text entered in the log.
Returns:
The text from the log element entry.
Throws:
VWException - The method throws an exception if it cannot get the string of text entered in the log.

getWorkflowName

public java.lang.String getWorkflowName()
                                 throws VWException
Gets the name of the workflow (if an associated workflow name exists).
Returns:
The workflow name. If there is no workflow name associated with the log element, the string value is null.
Throws:
VWException - The method throws an exception if it cannot get the name of an existing workflow.

getMapName

public java.lang.String getMapName()
                            throws VWException
Gets the name of the workflow map of the work object (if an associated workflow map exists).
Returns:
The name of the current workflow map. If there is no map name associated with the log element, the string value is null.
Throws:
VWException - The method throws an exception if it cannot get the name of an existing workflow map of the Work Object.

getStepName

public java.lang.String getStepName()
                             throws VWException
Gets the step name for the log element (if an associated step name exists).
Overrides:
getStepName in class filenet.vw.api.VWFieldsObject
Returns:
Step name of the log element; null if no step is associated with this log element.
Throws:
VWException - The method throws an exception if it cannot get an existing step name for the log element.

toString

public java.lang.String toString()
Gets a string version of the time stamp and sequence number for the record.
Overrides:
toString in class java.lang.Object
Returns:
The timestamp and the sequence number for this log element.

getDataFields

public VWDataField[] getDataFields()
                            throws VWException
Lists the data fields supported by the log element.
Returns:
Array of data field objects.
Throws:
VWException - The method throws an exception if it cannot list the data fields supported by the log element.
Since:
VWWS3.10
See Also:
VWDataField

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string that represents this VWLogElement object to the buffer specified by the input parameter.
Specified by:
toXML in interface IVWtoXML
Parameters:
theBuffer - A string buffer that this method will append with XML content.
Throws:
VWException -  
See Also:
VWXMLUtil

getWorkFlowNumber

public java.lang.String getWorkFlowNumber()
                                   throws VWException
Get the string version of the WorkFlow number.
Use the returned F_WorkFlowNumber as an index key component.
Returns:
WorkFlow Object number as a string, which corresponds to the F_WorkFlowNumber, if null then field does not exist.
Throws:
VWException - Thrown if a problem occurs

getServerLocation

public int getServerLocation()
                      throws VWException
Get the current server location of the work object.
Returns:
Number of the server where the work object is
Throws:
VWException - Thrown if a problem occurs

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.