Difference between revisions of "Activity:GetObjectsFromNamedRelation (Activity)"

Get Objects From Named Relation
Name	GetObjectsFromNamedRelation
Purpose	Return child objects of parent object
Category	Relations
Returns	List of child objects
Version	2.2.3

Latest revision as of 09:59, 4 November 2015

The GetObjectsFromNamedRelation activity returns a list of child objects and its relation data via the name of an existing Relation of a given parent object.

[edit]

Description

Description

Arguments

Argument	Type	Direction	Purpose
Parent	RelationalObject	In	The parent object
RelationName	String	In	The name of the relation to be searched for at the parent object
RelationData	UBIKClassList<RelationData>	Out	The list of relation data objects
Result	UBIKClassList<RelationalObject>	Out	The list of child objects

Usage

This activity is used to get a list of child objects of the parent object via the relation name. Optional the relation data is returned.

@@ Line 1: / Line 1: @@
 The GetObjectsFromNamedRelation activity returns a list of child objects and its [[RelationData|relation data]] via the name of an existing [[Relation|relation]] of a given parent object.
+=Description=
 {{ActivityInfoBox
 | title = Get Objects From Named Relation
@@ Line 12: / Line 13: @@
 }}
-==Arguments==
+===Arguments===
 {| class="wikitable sortable" | width = "50%"
 |-
 ! Argument !! Type !! Direction !! Purpose
 |- align="left"
-| Parent || RelationalObject || In || The parent object
+| Parent || [[RelationalObject]] || In || The parent object
 |- align="left"
-| RelationName || String|| In || The name of the relation to be searched for at the parent object
+| RelationName || {{String_MSDN}}|| In || The name of the relation to be searched for at the parent object
 |- align="left"
-| RelationData || UBIKClassList<RelationData>|| Out || The list of relation data objects
+| RelationData || [[UBIKClassList]]<[[RelationData]]>|| Out || The list of relation data objects
 |- align="left"
-| Result || UBIKClassList<Relationalobject>|| Out || The list of child objects
+| Result || [[UBIKClassList]]<[[RelationalObject]]>|| Out || The list of child objects
 |}
-==Usage==
+===Usage===
+This activity is used to get a list of child objects of the parent object via the relation name. Optional the relation data is returned.
-This activity is used to find a certain relation at the parent object via the name and then relate the child object to it.
+<!-- DO NOT REMOVE THIS -->{{Activity/End}}<!-- DO NOT REMOVE THIS -->
-==Example==
-Load the MetaClass named ''PUMP'', also load the MetaProperty ''NOMINALPOWER'' from the property pool and then add it to the MetaClasses' properties:
-{| class="wikitable" | width = "50%"
-|-
-! Argument!! Value
-|- align="left"
-| Parent || <source lang = "vbnet">UBIKObject.Environment _
-.GetSystemMetaClass(SystemObjects.METACLASS) _
-.AllInstances("PUMP")</source>
-|- align="left"
-| RelationName || <source lang = "vbnet">"SYSREL_METAPROPERTY"</source>
-|- align="left"
-| Child || <source lang = "vbnet">UBIKObject.Environment _
-.GetSystemMetaClass(SystemObjects.POOL_METAPROPERTY) _
-.GetMetaProperty("NOMINALPOWER")</source>
-|}
 ==See also==
 * [[Workflow Designer]]
-* [[RemoveFromNamedRelation (Activity)]]
+* [[Activity:GetObjectsFromSystemRelation (Activity)]]
-[[Category:Workflows]] [[Category:Activities]]
+[[Category:Activities]]