Difference between revisions of "METACLASSSCOPE"

MetaClass Scope
Name	METACLASSSCOPE
Namespace	System.ACM.Scopes
Internal Name	SystemObjects.METACLASSSCOPE
TypeString	UBIK.Kernel.MetaClass
RuntimeType	UBIK.Content.ACM.MetaClassScope
Purpose	Configure context scopes for MetaClasses
Version	2.1.13+

Latest revision as of 12:17, 29 September 2015

A MetaClassScope specifies the published meta data (MetaClass and MetaProperties) which should be accessible on the mobile device. Further, it is possible to configure the permissions granted on those objects on the mobile.

If an object is published to the client the Web Service tries to load the most accurate MetaClassScope corresponding to the object's MetaClass. If no MetaClass scope for exactely that MetaClass can be located the system looks up the inheritance hierarchy (regarding the data model) if it can find a suitable one.

Own Properties

Name	Data type	Optional	Comment
METACLASS	Guid	no	Reference to the according MetaClass
DELETE_CONFIG	Integer	no	Possibility to configure the delete behavior when a instance of the defined MetaClass gets deleted via the ACM (Web Service)

Classifications

If a MetaClass implements a certain classification the MetaClassScope must publish all required MetaProperties as declared by the classification. Only then the classification is known on the mobile client.

Icons

For deploying MetaClass specific icons it is necessary to create an own MetaClassScope for each MetaClass. Otherwise, the system will always deliver the icon of the most suitable MetaClassScope fitting a parent's MetaClass.

Delete Configuration

The Delete Configuration gives the possibility to configure whether an instance of the configured MetaClass may be deleted via ACM.

Setting	Description
NotDeleteable	Deletion of an instance of the configured MetaClass via the WebService is not supported
RemoveFromOwner	Deletion of an instance is possible via the WebService. The instance will be removed from its owner (the relation/reference will be deleted) but the instance itself will not be deleted from the database.
Deleteable	Deletion of an instance of the configured MetaClass via the WebService is not supported and the deleted object will get totally be removed from Ubik (will get deleted in the database).

@@ Line 1: / Line 1: @@
+__NOTOC__
 {{MetaClassInfoBox
 | title = MetaClass Scope
 | name = METACLASSSCOPE
-| internalname = MetaClassScope
+| internalname = SystemObjects.{{PAGENAME}}
-| namespace = System.ACM.Scopes<br/>Custom.ACM.Scopes
+| namespace = System.ACM.Scopes
 | image = [[File:SY_METACLASSSCOPE.png|220px]]
 | imagecaption = MetaClass Scope
 | purpose = Configure context scopes for MetaClasses
 | version = 2.1.13+
+| typestring = UBIK.Kernel.MetaClass
+| runtimetype = UBIK.Content.ACM.MetaClassScope
 }}
 A MetaClassScope specifies the published meta data (MetaClass and MetaProperties) which should be accessible on the mobile device. Further, it is possible to configure the permissions granted on those objects on the mobile.
-The system tries to load the most accurate MetaClassScope object, where the MetaClass of the current object serves as filter criterion. If the system can not directly locate a proper MetaClassScope it searches up the inheritance hierarchy to find the most suitable.
+If an object is published to the client the {{Web Service}} tries to load the most accurate MetaClassScope corresponding to the object's MetaClass. If no MetaClass scope for exactely that MetaClass can be located the system looks up the inheritance hierarchy (regarding the data model) if it can find a suitable one.
-== Configuration ==
+== Own Properties ==
-=== MetaClassScope ===
-The '''Metaclass''' property of an instance references to the according MetaClass (see [[Create a new MetaClassScope]]).
-=== MetaProperties ===
-* '''Initial value''': configure specific [[MetaProperty#Initial_value|initial values]]
-* '''Priority''': set a priority value, e.g. used in combination with the Measurement Task Classification
-* '''Write enabled''': property value can be changed by the mobile user
-* '''Visibility''': set the [[visibility]] of the property
-* '''Sort order''': set how the property should be sorted
-==== Priority ====
 {| class="wikitable" width=50%
 |-
-! width=30% | Value !! Comment
+! width=30% | Name !! width=20% | Data type !! width=10% | Optional !! Comment
 |-
-| >120 || Property is shown in the pop-up dialog if the object is classified as [[SYSCLS_TASK]]
+| METACLASS || Guid || no || Reference to the according MetaClass
+|-
+| DELETE_CONFIG|| Integer || no || Possibility to configure the delete behavior when a instance of the defined MetaClass gets deleted via the ACM (Web Service)
 |}
-==== Visibility ====
+== Classifications ==
+If a MetaClass implements a certain classification the MetaClassScope must publish all required MetaProperties as declared by the classification. Only then the classification is known on the mobile client.
+== Icons ==
+For deploying MetaClass specific icons it is necessary to create an own MetaClassScope for each MetaClass. Otherwise, the system will always deliver the icon of the most suitable MetaClassScope fitting a parent's MetaClass.
+== Delete Configuration ==
+The Delete Configuration gives the possibility to configure whether an instance of the configured MetaClass may be deleted via ACM.
 {| class="wikitable" width=50%
 |-
-! width=30% | Value !! Comment
+! width=30% | Setting !! width=70% | Description
 |-
-| Visible || Property will always be shown on the mobile device
+| NotDeleteable || Deletion of an instance of the configured MetaClass via the WebService is not supported
 |-
-| Hidden || Property will only be shown on the mobile device if [[UBIK_Client_Basics#Options|ShowSystemProperties]] is set to true
+| RemoveFromOwner || Deletion of an instance is possible via the WebService. The instance will be removed from its owner (the relation/reference will be deleted) but the instance itself will not be deleted from the database.
+|-
+| Deleteable || Deletion of an instance of the configured MetaClass via the WebService is not supported and the deleted object will get totally be removed from Ubik  (will get deleted in the database).
 |}
-==== Classifications ====
-If a MetaClass implements a certain classification the MetaClassScope must publish all required MetaProperties as declared by the classification. Only then the classification is known on the mobile client.
+== See also ==
+* [[HowTo:Assign an Icon to a MetaClass]]
-=== Icons ===
+[[Category:Context scope|METACLASSSCOPE]]
-For deploying MetaClass specific icons it is necessary to create an own MetaClassScope for each MetaClass. Otherwise, the system will always deliver the icon of the most suitable MetaClassScope fitting a parent's MetaClass.
+[[Category:Metaclasses|METACLASSSCOPE]]
-[[Category:System MetaClasses]]
-[[Category:Context Scopes]]