com.sap.netweaver.bc.uwl

Class StepLog

java.lang.Object
  com.sap.netweaver.bc.uwl.StepLog

public class StepLog

extends Object

The StepLog class defines the basic structure for the elementary unit of a log data. Each step corresponds to a task item of the provider and is associated with its respective internal item id. StepLog can be repeated for the same step to capture whatever actions that should be tracked in the log by the provider.
The steps will be collectively referenced by the WorkLog of the workflow where these steps belong to.
Main data includes the name of the step, time executed, executed by who, and actions taken, ....

See Also:

IProviderConnector, com.sap.netweaver.bc.uwl.connect.PriorityEnum, com.sap.netweaver.bc.uwl.connect.StatusEnum, com.sap.netweaver.bc.uwl.connect.WorkLog

Constructor Summary

StepLog(String stepId, String title, Date createdTime, Date executedTime, Date dueDate, String processor, PriorityEnum priority, StatusEnum status, String result)
Mainly for executed step

StepLog(String stepId, String title, Date createdTime, Date executedTime, Date dueDate, String processor, PriorityEnum priority, StatusEnum status, String[] eligibleProcessors, String result, String additionalComment)

StepLog(String stepId, String title, Date createdTime, Date dueDate, String processor, PriorityEnum priority, StatusEnum status, String[] eligibleProcessors)
Mainly for pending step.

Method Summary

String	getComment()
Date	getCreatedTime()
Date	getDueDate()
String[]	getEligibleProcessors()
Date	getExecTime()
PriorityEnum	getPriority()
String	getProcessor()
String	getResult()
StatusEnum	getStatus()
String	getStepId()
String	getTitle()
boolean	isSubprocessLog()
void	setStatus(StatusEnum _status)
void	setSubprocessLogFlag(boolean flag)

Methods inherited from class java.lang.Object

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

Constructor Detail

StepLog

public StepLog(String stepId,
               String title,
               Date createdTime,
               Date dueDate,
               String processor,
               PriorityEnum priority,
               StatusEnum status,
               String[] eligibleProcessors)

Mainly for pending step.

Parameters:

stepId - Can be null

title -

createdTime -

dueDate - Can be null

processor -

priority -

status -

eligibleProcessors - Can be null

StepLog

public StepLog(String stepId,
               String title,
               Date createdTime,
               Date executedTime,
               Date dueDate,
               String processor,
               PriorityEnum priority,
               StatusEnum status,
               String result)

Mainly for executed step

Parameters:

stepId - Can be null

title -

createdTime -

executedTime -

dueDate - Can be null

processor -

priority -

status -

result - Can be null

StepLog

public StepLog(String stepId,
               String title,
               Date createdTime,
               Date executedTime,
               Date dueDate,
               String processor,
               PriorityEnum priority,
               StatusEnum status,
               String[] eligibleProcessors,
               String result,
               String additionalComment)

Parameters:

stepId - Can be null

title -

createdTime -

executedTime - Null for pending step

dueDate - Can be null

processor -

priority -

status -

eligibleProcessors - Null for executed step

result - Null for pending step

additionalComment - Optional

Method Detail

getStepId

public String getStepId()

getTitle

public String getTitle()

getCreatedTime

public Date getCreatedTime()

getExecTime

public Date getExecTime()

getDueDate

public Date getDueDate()

getProcessor

public String getProcessor()

getPriority

public PriorityEnum getPriority()

getStatus

public StatusEnum getStatus()

setStatus

public void setStatus(StatusEnum _status)

getEligibleProcessors

public String[] getEligibleProcessors()

getResult

public String getResult()

getComment

public String getComment()

isSubprocessLog

public boolean isSubprocessLog()

setSubprocessLogFlag

public void setSubprocessLogFlag(boolean flag)