VOS Object Type Definition

object-core

OTD #000; Revision 1.

Group: core.

All objects in VOS implicitly support this type.

Authors

Peter Amstutz, Interreality (http://interreality.org)

Child Objects

this type expects no child objects.

Messages

 

find-child []

Find a child object, returning name, position and full URI.

Fields:

path (optional)

relative path of child to find

Replies:

 

set-child-update []

Indicates existence of a child

Fields:

error (optional)

If present, this field indicates an error occured while processing the message to which this is a reply (see nonce).

pos (optional)

position of object. 0 is first position.

name (optional)

contextual name

path (optional)

full path (URI)

Replies:

 

get-types []

Get types for an object.

Fields:

Replies:

 

type-add-update []

Notification of object's types

Fields:

type (optional)

Name of type

Replies:

 

get-parents []

Get parents of an object.

Fields:

Replies:

 

insert-parent-update []

notification of parents.

Fields:

error (optional)

If present, this field indicates an error occured while processing the message to which this is a reply (see nonce).

pos (optional)

position of object. 0 is first position.

name (optional)

contextual name

path (optional)

full path (URI)

Replies:

 

set-child []

replace or insert child object

Fields:

Replies:

 

insert-child []

Insert child (path) with (name) at (pos).

Fields:

pos (optional)

position of object. 0 is first position.

name (optional)

contextual name

path (optional)

full path (URI)

Replies:

 

insert-child-update []

Notification of child objects

Fields:

error (optional)

If present, this field indicates an error occured while processing the message to which this is a reply (see nonce).

pos (optional)

position of object. 0 is first position. Negative positions count from end of list (e.g. -1 means last, -2 is second-to-last, etc)

name (optional)

contextual name

path (optional)

full path (URI)

Replies:

 

remove-child []

Remove child at (pos).

Fields:

pos (optional)

position of object. 0 is first position. Negative positions count from end of list (e.g. -1 means last, -2 is second-to-last, etc)

Replies:

 

remove-child-update []

Notification of child removal

Fields:

error (optional)

If present, this field indicates an error occured while processing the message to which this is a reply (see nonce).

pos (optional)

position of object. 0 is first position. Negative positions count from end of list (e.g. -1 means last, -2 is second-to-last, etc)

Replies:

 

start-listening []

Register as a type, child, or parent listener, to get updates when these things change.

Fields:

listen (optional)

What aspect of the object to listen to. One of: "type", "children" or "parents".

Replies:

 

stop-listening []

Un-register as a type, child or parent listener, to stop updates.

Fields:

listen (optional)

What aspect of the object to stop listening to. One of: "type", "children" or "parents".

Replies:

 

type-add []

Notification of sending object's type(s)

Fields:

type (optional)

Name of new type

Replies:

 

remove-parent-update []

Notification of parent removal

Fields:

pos (optional)

position of object. 0 is first position.

name (optional)

contextual name

path (optional)

full path (URI)

Replies:

History of this document

Revision 0 (Thu Dec 6 11:16:42 EST 2001):
OTD started (rh)
Revision 1 (Wed Mar 13 12:52:30 EST 2002):
Updated to new DTD [rh]