Add a child object. Throw ArgErr if this child is already parented or has a duplicate name. Return this.
Remove all children objects. Return this.
Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:
this < that => <0
this == that => 0
this > that => >0
This method may also be accessed via the <
<=
<=>
>=
and >
shortcut operators. If not overridden the default
implementation compares the toStr
representations. Also see docLang.
Examples:
3.compare(8) => -1
8.compare(3) => 1
8.compare(8) => 0
3 <=> 8 => -1 // shortcut for 3.compare(8)
Localized human readable string summary of the object.
Localized human readable string summary of the object.
Localized human readable version of the name attribute.
Localized human readable version of the name attribute.
The XML element name to use for this object. If not one of the valid oBIX element names then throw ArgErr. Valid element names are:
obj, bool, int, real, str, enum, uri, abstime,
reltime, date, time, list, op, feed, ref, err
The XML element name to use for this object. If not one of the valid oBIX element names then throw ArgErr. Valid element names are:
obj, bool, int, real, str, enum, uri, abstime,
reltime, date, time, list, op, feed, ref, err
Compare this object to the specified for equality. This
method may be accessed via the == and != shortcut operators.
If not overridden the default implementation compares for
reference equality using the === operator. If this method
is overridden, then hash() must also be overridden such that
any two objects which return true for equals() must return
the same value for hash(). This method must accept null
and
return false.
Get a child by name. If not found and checked is true then throw NameErr, otherwise null.
Optional
checked: booleanReturn if there is child object by the specified name.
Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.
URI of this object. The root object of a document must have an absolute URI, other objects may have a URI relative to the document root. See normalizedHref to get this href normalized against the root object.
URI of this object. The root object of a document must have an absolute URI, other objects may have a URI relative to the document root. See normalizedHref to get this href normalized against the root object.
Reference to the graphical icon.
The in
contract for operations and feeds.
Return is size is zero.
The null flag indicates the absense of a value.
The null flag indicates the absense of a value.
Inclusive maximum for value.
Inclusive minium for value.
Programatic name of the object which defines role of this object in its parent. Throw UnsupportedErr if an attempt is made to set the name once mounted under a parent.
Programatic name of the object which defines role of this object in its parent. Throw UnsupportedErr if an attempt is made to set the name once mounted under a parent.
The of
contract for lists and feeds.
The out
contract for operations.
Parent object or null if unparented.
Number of decimal places to use for a real value.
Number of decimal places to use for a real value.
Reference to the range definition of an enum or bool value.
Remove the specified child object by reference. Throw ArgErr if not my child. Return this
Get the root ancestor of this object, or return this
if no
parent.
Return number of child objects.
Status facet indicates quality and state.
Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:
Return string representation.
Unit of measurement for int and real values. We only support units which are predefind in the oBIX unit database and specified using the URI "obix:units/". These units are mapped to the sys::Unit API. If an unknown unit URI is decoded, then it is silently ignored and this field will be null.
Unit of measurement for int and real values. We only support units which are predefind in the oBIX unit database and specified using the URI "obix:units/". These units are mapped to the sys::Unit API. If an unknown unit URI is decoded, then it is silently ignored and this field will be null.
Object value for value object types:
If the value is not one of the types listed above, then ArgErr is thrown. If the value is set to non-null, then the elemName is automatically updated.
Object value for value object types:
If the value is not one of the types listed above, then ArgErr is thrown. If the value is set to non-null, then the elemName is automatically updated.
Get the value encoded as a string. The string is not XML escaped. If value is null return "null".
Return this element type's Fantom value type or null if this
is a non-value type such as obj
.
This method called whenever an it-block is applied to an
object. The default implementation calls the function with this
,
and then returns this
.
Specifies is this object can be written, or false if readonly.
Specifies is this object can be written, or false if readonly.
Write this ObixObj as an XML document to the specified stream. No XML prolog is specified so that this method can used to write a snippet of the overall document.
Optional
indent: numberStatic
echoWrite x.toStr
to standard output followed by newline. If x
is null then print "null". If no argument is provided then
print an empty line.
Optional
x: JsObjStatic
makeStatic
read
ObixObj models an
obix:obj
element.