Difference between revisions of "Activity:DeleteObject (Activity)"
| Line 1: | Line 1: | ||
| + | The DeleteObject Activity deletes a {{UBIK}} object from memory and the database. | ||
| + | |||
| + | = Description = | ||
{{ActivityInfoBox | {{ActivityInfoBox | ||
| title = Delete Object | | title = Delete Object | ||
| Line 9: | Line 12: | ||
| version = 2.1+ | | version = 2.1+ | ||
}} | }} | ||
| − | |||
| − | |||
| − | |||
==Arguments== | ==Arguments== | ||
Revision as of 09:05, 4 November 2015
The DeleteObject Activity deletes a UBIK® object from memory and the database.
[edit]
Description
| Delete Object | |
|---|---|
| Name | DeleteObject |
| Purpose | Delete an object from the database |
| Category | Object Primitives |
| Returns | True if successful |
| Version | 2.1+ |
Arguments
| Argument | Type | Direction | Purpose |
|---|---|---|---|
| UBIKObject | BaseClass | In | The object to delete |
| ShallowDelete | Boolean | In | If True, only the object itself will be deleted, if false it will try to also delete affected objects of the change ("Deep delete") |
| Result | Boolean | Out | True if successful, false if failed |
Usage
This activity is used to delete a previously created object (e.g. with the CreateInstance activity) from memory and the database.
 | The delete is permanent, the object can bot be restored! |
Example
Delete the given object shallow:
| Argument | Value |
|---|---|
| UBIKObject | Connect this argument with a variable |
| ShallowDelete | True |
