com.sap.mdm.data.commands
Class DeleteRecordsCommand

java.lang.Object
  com.sap.mdm.commands.AbstractCommandBase
      com.sap.mdm.commands.AbstractCommand
          com.sap.mdm.session.AbstractSessionCommand
              com.sap.mdm.session.AbstractUserSessionCommand
                  com.sap.mdm.data.commands.DeleteRecordsCommand

All Implemented Interfaces:

Command

public class DeleteRecordsCommand

extends AbstractUserSessionCommand

This command is responsible for deleting a set of records. In order to specify set of records that should be deleted the user can supply either record IDs or instances of Record interface. In case the instances of Record interface are supplied the change stamp stored in the Record will be used for delete process and if this change stamp is out-of-date this record will be deleted only if the 'isDeleteAnyway' parameter is true. The record specified by record ID or by Record without change stamp will always be deleted. Mandatory input parameters: - Set of records or record IDs, it should include at least one record/ID value. - Table ID Optional input parameters: - isDeleteAnyway. By default it is false Output parameter: - none

Constructor Summary

DeleteRecordsCommand(ConnectionAccessor connection)
Constructor

DeleteRecordsCommand(UserSessionContext ctx)
Creates a new instance of this command by context.

Method Summary

void	addRecord(Record record) Adds a record to the list of records that should be deleted from repository (required*).
void	addRecord(RecordId recordId) Adds a record to the list of records that should be deleted from repository (required*).
void	addRecords(Record[] records) Adds records that should be deleted from repository (required*).
void	addRecords(RecordId[] recordIds) Adds records that should be deleted from repository (required*).
void	execute() Executes the command.
TableId	getTable() Returns table ID.
boolean	isDeleteAnyway() Specify if the record should be deleted even if the change stamps are out-of-date.
void	setDeleteAnyway(boolean isDeleteAnyway) Specify if the records should be deleted even if the change stamps are out-of-date (optional).
void	setTable(TableId tableId) Sets the table Id the records are from (required).

Methods inherited from class com.sap.mdm.commands.AbstractCommand

getSession, setSession

Methods inherited from class com.sap.mdm.commands.AbstractCommandBase

isCommandComplete

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteRecordsCommand

public DeleteRecordsCommand(ConnectionAccessor connection)

Constructor

Parameters:

connection - a connection to the MDM server

DeleteRecordsCommand

public DeleteRecordsCommand(UserSessionContext ctx)
                     throws ConnectionException,
                            SessionException

Creates a new instance of this command by context.

Parameters:

ctx - the user session context.

Method Detail

getTable

public TableId getTable()

Returns table ID.

Returns:

table ID

setTable

public void setTable(TableId tableId)

Sets the table Id the records are from (required).

Parameters:

tableId - the table Id

addRecords

public void addRecords(Record[] records)

Adds records that should be deleted from repository (required^*).

Parameters:

records - array of record

addRecords

public void addRecords(RecordId[] recordIds)

Adds records that should be deleted from repository (required^*).

Parameters:

recordIds - array of record IDs

addRecord

public void addRecord(Record record)

Adds a record to the list of records that should be deleted from repository (required^*).

Parameters:

record - record

addRecord

public void addRecord(RecordId recordId)

Adds a record to the list of records that should be deleted from repository (required^*).

Parameters:

recordId - the record Id

setDeleteAnyway

public void setDeleteAnyway(boolean isDeleteAnyway)

Specify if the records should be deleted even if the change stamps are out-of-date (optional). The default is false.

Parameters:

isDeleteAnyway - specify if the record should be deleted anyway

isDeleteAnyway

public boolean isDeleteAnyway()

Specify if the record should be deleted even if the change stamps are out-of-date.

Returns:

true if the record should be deleted anyway, false otherwise

execute

public void execute()
             throws CommandException

Description copied from interface: Command

Executes the command.

Throws:

CommandException - if there is an error in executing the command.