com.sap.mdm.workflow.commands
Class DeleteWorkflowJobCommand

java.lang.Object
  extended bycom.sap.mdm.commands.AbstractCommandBase
      extended bycom.sap.mdm.commands.AbstractCommand
          extended bycom.sap.mdm.session.AbstractSessionCommand
              extended bycom.sap.mdm.session.AbstractUserSessionCommand
                  extended bycom.sap.mdm.workflow.commands.DeleteWorkflowJobCommand
All Implemented Interfaces:
Command, PassportSupport

public class DeleteWorkflowJobCommand
extends AbstractUserSessionCommand

This command allows deleting the specified workflow job. If job contains checked-out records then these records are handled according to record action type: CHECKIN_RECORD_ACTION - check in all checked out records ROLLBAC_RECORD_ACTION - rollback all checked out records NONE_RECORD_ACTION - nothing If check-in or rollback action is failed then workflow job is not deleted.


Field Summary
static int CHECKIN_RECORD_ACTION
           
static int NONE_RECORD_ACTION
           
static int ROLLBACK_RECORD_ACTION
           
 
Constructor Summary
DeleteWorkflowJobCommand(ConnectionAccessor connection)
          Creates an instance of this command.
DeleteWorkflowJobCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 WorkflowJobId getJobId()
          Returns the workflow job ID.
 int getRecordActionType()
          Returns the record action type.
 void setJobId(WorkflowJobId jobId)
          Sets the workflow job ID that should be deleted (required).
 void setRecordActionType(int recordActionType)
          Sets the record action type (optional).
 
Methods inherited from class com.sap.mdm.commands.AbstractCommand
getSession, setSession
 
Methods inherited from class com.sap.mdm.commands.AbstractCommandBase
execute, getPassport, isCommandComplete, setPassport
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CHECKIN_RECORD_ACTION

public static final int CHECKIN_RECORD_ACTION
See Also:
Constant Field Values

ROLLBACK_RECORD_ACTION

public static final int ROLLBACK_RECORD_ACTION
See Also:
Constant Field Values

NONE_RECORD_ACTION

public static final int NONE_RECORD_ACTION
See Also:
Constant Field Values
Constructor Detail

DeleteWorkflowJobCommand

public DeleteWorkflowJobCommand(ConnectionAccessor connection)
Creates an instance of this command.

Parameters:
connection - the connection to the server

DeleteWorkflowJobCommand

public DeleteWorkflowJobCommand(UserSessionContext ctx)
                         throws ConnectionException,
                                SessionException
Creates a new instance of this command by context.

Parameters:
ctx - the user session context.
Method Detail

getJobId

public WorkflowJobId getJobId()
Returns the workflow job ID.

Returns:
the workflow job ID.

setJobId

public void setJobId(WorkflowJobId jobId)
Sets the workflow job ID that should be deleted (required).

Parameters:
jobId - the workflow job ID.

getRecordActionType

public int getRecordActionType()
Returns the record action type.

Returns:
the record action type. See constants in this class.

setRecordActionType

public void setRecordActionType(int recordActionType)
Sets the record action type (optional). The record action type defines the action that should be done for the checked-out record: CHECKIN_RECORD_ACTION - check in all checked out records (default type) ROLLBAC_RECORD_ACTION - rollback all checked out records NONE_RECORD_ACTION - nothing If check-in or rollback action is failed then workflow job is not deleted.

Parameters:
recordActionType - the record action type. See constants in this class.


Copyright 2004-2007 by SAP AG. All Rights Reserved.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.