|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.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
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*). |
RecordId[] |
getFailedRecords()
Returns the records that failed deletion. |
Integer |
getReturnCode(RecordId recordId)
Returns the reason the record failed deletion. |
RecordId[] |
getSucceededRecords()
Returns the records that were successfully deleted. |
TableId |
getTable()
Returns table ID. |
boolean |
isDeleteAnyway()
Specify if the record should be deleted even if the change stamps are out-of-date. |
boolean |
isSlice()
Returns whether slicing is enabled. |
void |
setDeleteAnyway(boolean isDeleteAnyway)
Specify if the records should be deleted even if the change stamps are out-of-date (optional). |
void |
setSlice(boolean isSlice)
Enable slicing during record deletion. |
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 |
execute, getPassport, isCommandComplete, setPassport |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public DeleteRecordsCommand(ConnectionAccessor connection)
connection - a connection to the MDM server
public DeleteRecordsCommand(UserSessionContext ctx)
throws ConnectionException,
SessionException
ctx - the user session context.| Method Detail |
public TableId getTable()
public void setTable(TableId tableId)
tableId - the table Idpublic void addRecords(Record[] records)
records - array of recordpublic void addRecords(RecordId[] recordIds)
recordIds - array of record IDspublic void addRecord(Record record)
record - recordpublic void addRecord(RecordId recordId)
recordId - the record Idpublic void setDeleteAnyway(boolean isDeleteAnyway)
false.
isDeleteAnyway - specify if the record should be deleted anywaypublic boolean isDeleteAnyway()
public void setSlice(boolean isSlice)
isSlice - true to enable, false to disable- Since:
- 7.1 SP7
public boolean isSlice()
true to enable, false to disable- Since:
- 7.1 SP7
public RecordId[] getFailedRecords()
Note: When slicing is enabled, records are divided into subsets. For a given subset of records, if a record failed the operation, the whole subset of records are marked as failed. It is not possible to determine which record in the subset triggered the failure.
public RecordId[] getSucceededRecords()
public Integer getReturnCode(RecordId recordId)
recordId - a record Id
RC
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
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.