|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWLogElement
public final class VWLogElement
Use this class to retrieve log element information, which is retrieved from the event log record.
Instantiate this class by calling VWLogQuery.next
.
VWLogQuery
,
Serialized FormMethod 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 |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public java.lang.String[] getFieldNames()
public java.lang.String[] getAuthoredFieldNames()
public java.lang.Object getFieldValue(java.lang.String fieldName) throws VWException
fieldName
- A String containing the name of the field from which to return the value.
VWException
- Thrown for various reasons, including when the
field name specified is invalid.public boolean hasField(java.lang.String fieldName) throws VWException
fieldName
- A String containing the user-defined field name to check.
VWException
- Thrown for various reasons, including when
this method cannot determine whether or not the user-defined field
name exists.public java.util.Date getTimeStamp() throws VWException
VWException
- Thrown for various reasons, including when
this method cannot find the timestamp for the log record.public int getSequenceNumber() throws VWException
VWException
- Thrown for various reasons, including when
the sequence number is not found.public java.lang.String getUserName() throws VWException
VWException
public VWParticipant getUserNamePx() throws VWException
VWException
public int getEventType() throws VWException
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
VWException
- The method throws an exception if it
cannot get the event type of the log record.public java.lang.String getWorkObjectNumber() throws VWException
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).public java.lang.String getParentWorkObjectNumber() throws VWException
VWException
- Thrown for various reasons, including when
this method cannot find the parent work object number.public java.lang.String getQueueName() throws VWException
VWException
public java.lang.String getOperationName() throws VWException
VWException
public java.lang.String getWorkClassName() throws VWException
VWException
public java.lang.String getInstructionSheetName() throws VWException
VWException
public int getMachineId() throws VWException
VWException
- Thrown for various reasons, including when
the machine id value is not found.public int getWorkOrderId() throws VWException
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.public long getDuration() throws VWException
VWException
public java.lang.String getWorkObjectTag() throws VWException
VWException
public java.lang.String getText() throws VWException
VWException
public java.lang.String getWorkflowName() throws VWException
VWException
public java.lang.String getMapName() throws VWException
VWException
public java.lang.String getStepName() throws VWException
VWException
- Thrown if a step name cannot be found for this log element.public java.lang.String getAuthoredStepName() throws VWException
VWException
- Thrown if a step name cannot be found for this log element.public java.lang.String toString()
toString
in class java.lang.Object
public VWDataField[] getDataFields() throws VWException
VWException
- Thrown if the data fields supported cannot be listed.VWDataField
public VWDataField getDataField(java.lang.String name) throws VWException
name
- A String containing the name of the data field. If a
translation source exists, the authored field name is translated.
VWException
public java.lang.String getSelectedResponse() throws VWException
VWException
- Thrown if a problem occurs retrieving the field.public java.lang.String getSubject() throws VWException
VWException
- Thrown if a problem occurs retrieving the field.public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in interface IVWtoXML
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public java.lang.String getWorkFlowNumber() throws VWException
VWException
- An exception is thrown under the following conditions:
public int getServerLocation() throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |