Difference between revisions of "DeleteRecord"
From LongJump Support Wiki
imported>Aeric |
imported>Aeric |
||
(2 intermediate revisions by the same user not shown) | |||
Line 4: | Line 4: | ||
'''Syntax''' | '''Syntax''' | ||
:<syntaxhighlight lang="java" enclose="div"> | :<syntaxhighlight lang="java" enclose="div"> | ||
Result result = Functions.deleteRecord(String | Result result = Functions.deleteRecord(String objectName, String recordID); | ||
Result result = Functions.deleteRecord(String | Result result = Functions.deleteRecord(String objectName, String recordID, Parameters params); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
:; | :;objectName:The object name or identifier | ||
:;recordID:The identifier of the record to delete. | :;recordID:The identifier of the record to delete. | ||
:;params: | :;params: | ||
::* | ::* Data policy override parameter: | ||
:::<syntaxhighlight lang="java" enclose="div"> | |||
params.add(PLATFORM.PARAMS.RECORD.DO_NOT_EXEC_DATA_POLICY,"1"); | |||
</syntaxhighlight> | |||
;Return:[[Result Class|<tt>Result</tt> object]] | ;Return:[[Result Class|<tt>Result</tt> object]] |
Latest revision as of 16:59, 27 September 2011
Delete a record.
Syntax
Result result = Functions.deleteRecord(String objectName, String recordID); Result result = Functions.deleteRecord(String objectName, String recordID, Parameters params);
Parameters
- objectName
- The object name or identifier
- recordID
- The identifier of the record to delete.
- params
-
- Data policy override parameter:
params.add(PLATFORM.PARAMS.RECORD.DO_NOT_EXEC_DATA_POLICY,"1");
- Return
- Result object
- Example
- This example calls deleteRecord, assigning the returned value to an instance of Result and calling Result.getCode to assign the error code to a variable which is then conditionally checked to determine the code to execute. If the call was not successful, the code calls throwError to display an error dialog.
String accountID = ""; // Some logic to populate accountID variable. Result result = Functions.deleteRecord("ACCOUNT", accountID); int resultCode = result.getCode(); if(resultCode < 0) { // Some error happened. String msg = "Account could not be deleted"; Functions.debug(msg + ":\n" + result.getMessage()); // Log details Functions.throwError(msg + "."); // Error dialog } else { // Take other actions on successful addition // of the account. }