Difference between revisions of "Activity:RegisterObjectForExport (Activity)"
(→Usage) |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | The RegisterObjectForExport Activity creates a new [[Proxy|proxy instance]] of a specified UBIK content object (target) and sets the export state to '''Queued for Export'''. | ||
| + | |||
| + | =Description= | ||
{{ActivityInfoBox | {{ActivityInfoBox | ||
| title = Register Object for Export | | title = Register Object for Export | ||
| Line 9: | Line 12: | ||
| version = 2.1+ | | version = 2.1+ | ||
}} | }} | ||
| − | |||
| − | ==Arguments== | + | ===Arguments=== |
{| class="wikitable sortable" | width = "50%" | {| class="wikitable sortable" | width = "50%" | ||
|- | |- | ||
! Argument !! Type !! Direction !! Purpose | ! Argument !! Type !! Direction !! Purpose | ||
|- align="left" | |- align="left" | ||
| − | | UBIKObject || | + | | UBIKObject || [[BaseClass]] || The target to create the proxy object for |
|- align="left" | |- align="left" | ||
| MetaProxy|| [[MetaProxy]] || In || The MetaProxy to create the proxy instance | | MetaProxy|| [[MetaProxy]] || In || The MetaProxy to create the proxy instance | ||
| Line 25: | Line 27: | ||
|} | |} | ||
| − | ==Usage== | + | ===Usage=== |
This activity creates a new proxy instance (of the given MetaProxy) for the specified target object. If created successfully, the [[Proxy#Export_states|export state]] is set to '''Queued for export'''. | This activity creates a new proxy instance (of the given MetaProxy) for the specified target object. If created successfully, the [[Proxy#Export_states|export state]] is set to '''Queued for export'''. | ||
{{Attention|This activity does not automatically save changes. If you want to persist the newly created proxy instance, you need i.e. a subsequent [[Activity:SaveObject_(Activity)|SaveObject activity]]!}} | {{Attention|This activity does not automatically save changes. If you want to persist the newly created proxy instance, you need i.e. a subsequent [[Activity:SaveObject_(Activity)|SaveObject activity]]!}} | ||
| − | + | =Example= | |
Register an UBIK object for interface: | Register an UBIK object for interface: | ||
{| class="wikitable" | width = "50%" | {| class="wikitable" | width = "50%" | ||
| Line 41: | Line 43: | ||
| Proxy || Connect this argument with a variable for a Proxy (out) | | Proxy || Connect this argument with a variable for a Proxy (out) | ||
|} | |} | ||
| + | |||
| + | <!-- DO NOT REMOVE THIS -->{{Activity/End}}<!-- DO NOT REMOVE THIS --> | ||
==See also== | ==See also== | ||
| Line 46: | Line 50: | ||
* [[Activity:SaveObject (Activity)]] | * [[Activity:SaveObject (Activity)]] | ||
| − | + | [[Category:Activities|RegisterObjectForExport (Activity)]] | |
| − | [[Category:Activities | + | |
| − | + | ||
Latest revision as of 10:05, 4 November 2015
The RegisterObjectForExport Activity creates a new proxy instance of a specified UBIK content object (target) and sets the export state to Queued for Export.
[edit]
Description
| Register Object for Export | |
|---|---|
| Name | RegisterObjectForExport |
| Purpose | Register an object for interface (create proxy object) |
| Category | Data Exchange |
| Returns | True if successfull |
| Version | 2.1+ |
Arguments
| Argument | Type | Direction | Purpose |
|---|---|---|---|
| UBIKObject | BaseClass | The target to create the proxy object for | |
| MetaProxy | MetaProxy | In | The MetaProxy to create the proxy instance |
| Proxy | Proxy | In | The created proxy instance |
| Result | Boolean | Out | True if proxy instance has been created |
Usage
This activity creates a new proxy instance (of the given MetaProxy) for the specified target object. If created successfully, the export state is set to Queued for export.
 | This activity does not automatically save changes. If you want to persist the newly created proxy instance, you need i.e. a subsequent SaveObject activity! |
Example
Register an UBIK object for interface:
| Argument | Value |
|---|---|
| UBIKObject | Connect this argument with a variable for an UBIK object |
| MetaProxy | Connect this argument with a variable for a MetaProxy |
| Proxy | Connect this argument with a variable for a Proxy (out) |
