Typedef for meta variable in afw_object interface. More...

#include <afw_common.h>

Data Fields
const afw_object_t *	meta_object
	Meta object. More...

const afw_object_t *	embedding_object
	Embedding object. More...

const afw_utf8_t *	id
	Object id or property name. More...

const afw_utf8_t *	object_type_uri
	Object type object URI or NULL. More...

const afw_utf8_t *	object_uri
	Object path or NULL. More...

Detailed Description

Typedef for meta variable in afw_object interface.

Information in this struct should be accessed using functions declared in afw_object_meta.h – do not access directly.

Definition at line 753 of file afw_common.h.

Field Documentation

◆ embedding_object

const afw_object_t* embedding_object

Embedding object.

Embedding object or NULL if this is an entity object.

Definition at line 768 of file afw_common.h.

◆ id

const afw_utf8_t* id

Object id or property name.

If embedding_object is NULL, this is the entity's objectId. If embedding_object is not NULL, this is the propertyName of this object in that object.

Use afw_object_meta_get_object_id() to access an entity's objectId, which will throw an error if the object is embedded. Use afw_object_meta_get_property_name() to access an object's property name, which will throw an error if this object is an entity.

Definition at line 782 of file afw_common.h.

◆ meta_object

const afw_object_t* meta_object

Meta object.

This is the meta object associated with this object. See afw_object_meta.h for more information.

Definition at line 761 of file afw_common.h.

◆ object_type_uri

const afw_utf8_t* object_type_uri

Object type object URI or NULL.

This is the URI of the object type object. If this is just an objectId, the URI is the object URI with the last two path segments replaced by /_AdaptiveObjectType_/ followed by this objectId.

Use these functions to access: . afw_object_meta_get_object_type_id() . afw_object_meta_get_object_type_path() . afw_object_meta_get_object_type_uri()

Definition at line 796 of file afw_common.h.

◆ object_uri

const afw_utf8_t* object_uri

Object path or NULL.

This is the URI of the object. At a minimum, this is the relative URI of the object within the current adaptive framework environment:

/<adaptor id>/<object type id>/<object id>

Use these functions to access: . afw_object_meta_get_id() . afw_object_meta_get_path() . afw_object_meta_get_uri()

Definition at line 811 of file afw_common.h.

The documentation for this struct was generated from the following file:

afw_common.h