Process API

filenet.vw.api
Class VWLogElement

java.lang.Object
  extended by filenet.vw.api.VWLogElement
All Implemented Interfaces:
IVWtoXML, java.io.Serializable

public final class VWLogElement
extends java.lang.Object
implements IVWtoXML, java.io.Serializable

Use this class to retrieve log element information, which is retrieved from the event log record.

Instantiate this class by calling VWLogQuery.next.

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

Method Summary
static java.lang.String _get_FILE_AUTHOR()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_DATE()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_REVISION()
          For FileNet internal use only, do not call.
 java.lang.String[] getAuthoredFieldNames()
          Lists the system and user-defined (authored) field names for this instance.
 java.lang.String getAuthoredStepName()
          Gets the authored (untranslated) step name for this log element.
 VWDataField getDataField(java.lang.String name)
          Gets the requested data field from this log element.
 VWDataField[] getDataFields()
          Gets the data fields supported by this 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 field names for this instance.
 java.lang.Object getFieldValue(java.lang.String fieldName)
          Gets the value of the named user-defined field.
 java.lang.String getInstructionSheetName()
          Gets the name of the instruction sheet for the work object.
 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.
 java.lang.String getOperationName()
          Gets the operation name of this log element.
 java.lang.String getParentWorkObjectNumber()
          Gets the string version of the parent work object number.
 java.lang.String getQueueName()
          Gets the name of the queue that is associated with this log element and the current work object.
 java.lang.String getSelectedResponse()
          Returns the value in the F_Response field for this instance.
 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()
          Gets the current server location of the work object.
 java.lang.String getStepName()
          Gets the step name for this log element.
 java.lang.String getSubject()
          Returns the value in the F_Subject field for this instance.
 java.lang.String getText()
          Gets the text entered in the log.
 java.util.Date getTimeStamp()
          Gets the timestamp of the current log record, as a date variable showing the time the log element was included in the log.
 java.lang.String getUserName()
          Gets the user name associated with the log record.
 VWParticipant getUserNamePx()
          Gets the security object of the user associated with the log record.
 java.lang.String getWorkClassName()
          Gets the name of the work class from which the current work object is instantiated.
 java.lang.String getWorkflowName()
          Gets the name of the workflow.
 java.lang.String getWorkFlowNumber()
          Gets 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 named 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 representing this instance to the buffer specified.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


getFieldNames

public java.lang.String[] getFieldNames()
Lists the system and user-defined field names for this instance. If a translation source exists, the authored names are translated.

Returns:
A String array of the system and user-defined field names. The translated names of the fields are returned if a translation source exists; otherwise, the authored names are returned.

getAuthoredFieldNames

public java.lang.String[] getAuthoredFieldNames()
Lists the system and user-defined (authored) field names for this instance.

Returns:
A String array of the system and user-defined (authored) field names.
Since:
P8 4.0

getFieldValue

public java.lang.Object getFieldValue(java.lang.String fieldName)
                               throws VWException
Gets the value of the named user-defined field. The authored (untranslated) name is used.

Parameters:
fieldName - A String containing the name of the field from which to return the value.
Returns:
the field value
Throws:
VWException - Thrown for various reasons, including when the field name specified is invalid.

hasField

public boolean hasField(java.lang.String fieldName)
                 throws VWException
Determines whether or not the named user-defined field name exists. The authored (untranslated) name is used.

Parameters:
fieldName - A String containing the user-defined field name to check.
Returns:
A boolean value of true if a field with the name specified in the fieldName parameter exists; otherwise, false.
Throws:
VWException - Thrown for various reasons, including when this method 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, as 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 - Thrown for various reasons, including when this method cannot find 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.

Returns:
The sequence number of the log record.
Throws:
VWException - Thrown for various reasons, including when the sequence number is not found.

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

getUserNamePx

public VWParticipant getUserNamePx()
                            throws VWException
Gets the security object of the user associated with the log record.

Returns:
The security object of the user associated with the log record.
Throws:
VWException

getEventType

public int getEventType()
                 throws VWException
Gets the event type of the log record. Process Engine events relate to the following categories:

The event type characterizes events the system logs for various logging options, as shown below. To view descriptions of these events, refer to the "Manage Event Logs" section of the Process Configuration Console online help.

The possible logging options are the follows:

Event types, ordered by ascending logging option value, are as follows:

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 - Thrown when a new log element is referenced. It will not have a work object number until it is dispatched (becomes a work object).

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 - Thrown for various reasons, including when this method cannot find the parent work object number.

getQueueName

public java.lang.String getQueueName()
                              throws VWException
Gets the name of the queue that is associated with this log element and the current work object. If a translation source exists, the authored name is translated.

Returns:
A String containing the translated name, if a translation source exists; otherwise, the authored name is returned. If an associated queue name cannot be found, null is returned.
Throws:
VWException

getOperationName

public java.lang.String getOperationName()
                                  throws VWException
Gets the operation name of this log element. If a translation source exists, the authored name is translated.

Returns:
A String containing the translated name, if a translation source exists; otherwise, the authored name is returned. If an operation name cannot be found, null is returned.
Throws:
VWException

getWorkClassName

public java.lang.String getWorkClassName()
                                  throws VWException
Gets the name of the work class from which the current work object is instantiated. If a translation source exists, the authored name is translated.

Returns:
A String containing the translated name, if a translation source exists; otherwise, the authored name is returned. If an associated work class name cannot be found, null is returned.
Throws:
VWException

getInstructionSheetName

public java.lang.String getInstructionSheetName()
                                         throws VWException
Gets the name of the instruction sheet for the work object. If a translation source exists, the authored name is translated.

Returns:
A String containing the translated name, if a translation source exists; otherwise, the authored name is returned. If an associated instruction sheet cannot be found, null is returned.
Throws:
VWException

getMachineId

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

Returns:
An 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 Engine
  • (-)2: The machine is running a Java-based web application-- -2 returns when there is no machine ID associated with a web application.
Throws:
VWException - Thrown for various reasons, including when the machine id value is not found.

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, or -1 if the is no associated work order ID.
Throws:
VWException - The method throws an exception if it cannot get the authored work order ID for the instruction or if it cannot get the 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 in milliseconds.
Throws:
VWException

getWorkObjectTag

public java.lang.String getWorkObjectTag()
                                  throws VWException
Gets the work object tag value.

Returns:
An integer value for the authored work order ID, or -1 if there is no associated work order ID.
Throws:
VWException

getText

public java.lang.String getText()
                         throws VWException
Gets the text entered in the log.

Returns:
The text from the log element entry.
Throws:
VWException

getWorkflowName

public java.lang.String getWorkflowName()
                                 throws VWException
Gets the name of the workflow. If a translation source exists, the authored name is translated.

Returns:
A String containing the translated name, if a translation source exists; otherwise, the authored name is returned. If an associated workflow name cannot be found, null is returned.
Throws:
VWException

getMapName

public java.lang.String getMapName()
                            throws VWException
Gets the name of the workflow map of the work object. If a translation source exists, the authored name is translated.

Returns:
A String containing the translated name, if a translation source exists; otherwise, the authored name is returned. If an workflow map cannot be found, null is returned.
Throws:
VWException

getStepName

public java.lang.String getStepName()
                             throws VWException
Gets the step name for this log element. If a translation source exists, the authored name is translated.

Returns:
A String containing the translated name, if a translation source exists; otherwise, the authored name is returned. If an step name cannot be found, null is returned.
Throws:
VWException - Thrown if a step name cannot be found for this log element.

getAuthoredStepName

public java.lang.String getAuthoredStepName()
                                     throws VWException
Gets the authored (untranslated) step name for this log element.

Returns:
A String containing the authored name, if it exists. If the step name cannot be found, null is returned.
Throws:
VWException - Thrown if a step name cannot be found for this log element.
Since:
P8 4.0

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
Gets the data fields supported by this log element. If a translation source exists, the authored names are translated.

Returns:
An array of the VWDataField objects supported by this log element. The translated names of the data fields are returned if a translation source exists; otherwise, the authored names are returned.
Throws:
VWException - Thrown if the data fields supported cannot be listed.
Since:
VWWS3.10
See Also:
VWDataField

getDataField

public VWDataField getDataField(java.lang.String name)
                         throws VWException
Gets the requested data field from this log element.

Parameters:
name - A String containing the name of the data field. If a translation source exists, the authored field name is translated.
Returns:
A VWDataField object for the data field specified. If the field cannot be found, null is returned.
Throws:
VWException
Since:
P8 4.0

getSelectedResponse

public java.lang.String getSelectedResponse()
                                     throws VWException
Returns the value in the F_Response field for this instance. If a translation source exists, the authored response is translated.

Returns:
A String containing the translated response, if a translation source exists; otherwise the authored response is returned.
Throws:
VWException - Thrown if a problem occurs retrieving the field.
Since:
P8 4.0

getSubject

public java.lang.String getSubject()
                            throws VWException
Returns the value in the F_Subject field for this instance. If a translation source exists, the authored subject is translated.

Returns:
A String containing the translated subject, if a translation source exists; otherwise the authored subject is returned.
Throws:
VWException - Thrown if a problem occurs retrieving the field.
Since:
P8 4.0

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string representing this instance to the buffer specified.

Warning: This XML string is nonextensible, and cannot be modified in any way.

Specified by:
toXML in interface IVWtoXML
Parameters:
theBuffer - A StringBuffer that will be appended with the XML content.
Throws:
VWException - Thrown if the specified buffer is null.
See Also:
VWXMLUtil

getWorkFlowNumber

public java.lang.String getWorkFlowNumber()
                                   throws VWException
Gets the workflow number. Use the returned F_WorkFlowNumber value as an index key component.

Returns:
The string representing the workflow number.
Throws:
VWException - An exception is thrown under the following conditions:
  • There is no workflow number currently assigned. This may be because the object has not yet been dispatched (has not yet become a work object).
  • The workflow number is null.

getServerLocation

public int getServerLocation()
                      throws VWException
Gets the current server location of the work object.

Returns:
Number of the server for the work object
Throws:
VWException

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.