Olympe SDK Class: CloudObject

Class: CloudObject

olympe .dc. CloudObject

A CloudObject is the base class for all DataCloud object. In essence it represents a remote reference to an object in the data cloud. It is identified by its unique ID, or tag. From a CloudObject you can access related Objects, like its model or properties. A CloudObject can be instantiated via its Tag, unique ID from statically.

Example:

const dcObject = olympe.dc.CloudObject.get(tag);
const x = s.getPropertyAsNumber(xTag);

new CloudObject(manager, tag)

Creates an instance of a Sync.

Parameters:

Name	Type	Description
`manager`	olympe.dc.Manager \| undefined	Data cloud manager instance
`tag`	string	Instance tag

Implements:

olympe.dc.HasTag

Members

<static> containsRel

<static> extendedByRel

<static> extendRel

<static> instancesRel

<static> modelRel

<static> nameProp

<static> propertyRel

<protected, non-null> db :olympe.dc.DBView

Type:

olympe.dc.DBView

<protected> manager :olympe.dc.Manager

Type:

olympe.dc.Manager

<non-null> model :olympe.dc.CloudObject

Type:

olympe.dc.CloudObject

<protected> tag :string

Type:

string

Methods

<static> asInstance()

Return the class as instance of CloudObject

Returns:

Type: olympe.dc.CloudObject

<static> createInstance(transaction, model [, name], args)

Creates an instance for the specified model.

Parameters:

Name	Type	Argument	Description
`transaction`	olympe.dc.Transaction		The `Transaction` that will perform the creation.
`model`	olympe.dc.InstanceTag		The Model for the instance.
`name`	string \| olympe.df.POString	<optional>	The name to give that instance.
`args`	*	<repeatable>	Extra arguments passed to the factory method if any. If no factory is specified the default behavior is to treat the first args as the name of the created object.

Returns:

The ID of the created instance.

Type: string

<static> createWith(properties [, model] [, source])

Create an instance of this model class non persisted, in the local datacloud, based on the specified property values. Return the newly create cloud object.

Parameters:

Name	Type	Argument
`properties`	Map.<!olympe.dc.Tag, *>
`model`	olympe.dc.Tag	<optional>
`source`	string	<optional>

Returns:

Type: olympe.dc.CloudObject

<static> get(tag)

Return the CloudObject of the instance specified by the tag.

Parameters:

Name	Type	Description
`tag`	olympe.dc.Tag

Returns:

Type: olympe.dc.CloudObject

<static> getInstance(instance)

Return the Sync instance of the specified instance

Parameters:

Name	Type	Description
`instance`	olympe.dc.InstanceTag

Deprecated:

use olympe.dc.CloudObject#get instead

Returns:

Type: olympe.dc.CloudObject

<static> getInstancesOf(tagOrConstructor)

Return the listdef of all instances of the specified tagOrConstructor

Parameters:

Name	Type	Description
`tagOrConstructor`	olympe.dc.InstanceTag

Returns:

Type: olympe.dc.ListDef

<static> getProperties()

Return the list of properties defined on this model class.

Returns:

Type: Array.<!olympe.dc.registry.Property>

<static> getRelations()

Return the list of relations associated to that CloudObject model class, in both directions.

Returns:

Type: Array.<!olympe.dc.registry.Relation>

<static> instancesOf(model)

Returns a query of all instances of the specified model.

Parameters:

Name	Type	Description
`model`	function

Returns:

Type: olympe.dc.Query

detachDelete( [transaction])

Remove all relations linked to the current sync and then remove the sync itself.

Parameters:

Name	Type	Argument	Description
`transaction`	olympe.dc.Transaction	<optional>

equals(obj)

Checks whether 2 Syncs are equal.

Parameters:

Name	Type	Description
`obj`	*	The object to compare with.

Returns:

true if this Sync is the same as the obj

Type: boolean

follow(relation)

Return a query with this instance as root and following the specified relation.

Parameters:

Name	Type	Description
`relation`	olympe.dc.registry.Relation

Returns:

Type: olympe.dc.Query

followSingle(relation)

Return a query single which start from this instance and follow the specified relation to a unique other cloud object.

Parameters:

Name	Type	Description
`relation`	olympe.dc.registry.Relation

Returns:

Type: olympe.dc.QuerySingle

forEachRelated(relation, callback)

Note: If relations are already established at the time of calling, then the callback will be immediately invoked for each existing relation.

Parameters:

Name	Type	Description
`relation`	olympe.dc.registry.Relation	The relation to follow
`callback`	function	The function to invoke.

get(property)

Return the current value of the specified property of this object.

Parameters:

Name	Type	Description
`property`	olympe.dc.Tag

Returns:

Type: *

getContainer()

Gets the container of this instance.

Returns:

The container.

Type: olympe.dc.CloudObject | olympe.df.Proxy.<olympe.dc.CloudObject>

getContents()

Get the instances set as content by this instance.

Returns:

The set of instances.

Type: olympe.dc.ListDef.<!olympe.dc.CloudObject>

getDisplayName()

Gets the name of this Sync, defaulting to a string representation of this object.

Returns:

The display name of this Sync.

Type: olympe.df.POString

getFirstRelated(related [, valueType])

Gets the first object related to this one by the specified relation.

Parameters:

Name	Type	Argument	Description
`related`	olympe.dc.registry.Relation		The transformer specifying the type of relation.
`valueType`	function	<optional>	Type of the values, must be sub-class of `Sync`.

Returns:

The first object matching the request.

Type: olympe.dc.CloudObject | T | olympe.df.Proxy.<T>

getModel()

Gets the model of this CloudObject.

Returns:

The model of this CloudObject.

Type: olympe.dc.CloudObject

getModelTag()

Gets the tag of the model of this Sync.

Returns:

The tag of the model.

Type: string

getName()

Gets the name of this CloudObject.

Returns:

The name of this CloudObject.

Type: olympe.df.POString

getProperty(property)

Parameters:

Name	Type	Description
`property`	olympe.dc.Tag

Deprecated:

use olympe.dc.CloudObject#get instead

Returns:

Type: *

getPropertyAsBoolean(tag)

Gets a property value as an OBoolean.

Parameters:

Name	Type	Description
`tag`	olympe.dc.InstanceTag	The tag of the property.

Returns:

The value of the property.

Type: olympe.df.POBoolean

getPropertyAsColor(tag)

Gets a property value as a Color.

Parameters:

Name	Type	Description
`tag`	olympe.dc.InstanceTag	The tag of the property.

Returns:

The value of the property.

Type: olympe.df.PColor

getPropertyAsDateTime(tag)

Gets a property value as an ODateTime.

Parameters:

Name	Type	Description
`tag`	olympe.dc.InstanceTag	The tag of the property.

Returns:

The value of the property.

Type: olympe.df.PODateTime

getPropertyAsNumber(tag)

Gets a property value as an ONumber.

Parameters:

Name	Type	Description
`tag`	olympe.dc.InstanceTag	The tag of the property.

Returns:

The value of the property.

Type: olympe.df.PONumber

getPropertyAsString(tag)

Gets a property value as an OString.

Parameters:

Name	Type	Description
`tag`	olympe.dc.InstanceTag	The tag of the property.

Returns:

The value of the property.

Type: olympe.df.POString

getPropertyAsSync(tag)

Gets a property value as a Sync.

Parameters:

Name	Type	Description
`tag`	olympe.dc.InstanceTag	The tag of property.

Returns:

The value of the property.

Type: olympe.df.Proxy.<olympe.dc.CloudObject> | olympe.dc.CloudObject

getRawProperty(prop, valueCaster, valueType)

Gets a property raw value, optionally processing it with the specified callback.

Parameters:

Name	Type	Description
`prop`	olympe.dc.InstanceTag	Property.
`valueCaster`	olympe.dc.CloudObject.ValueCaster	Optional 'casting' function.
`valueType`	function	The Type for the property.

Returns:

The created node.

Type: olympe.df.Node.<T>

getRelated(relation [, valueType])

Gets all the objects related to this one by the specified relation.

Parameters:

Name	Type	Argument	Description
`relation`	olympe.dc.registry.Relation		The relation to follow.
`valueType`	function	<optional>	Type of the values, must be sub-class of `Sync`.

Returns:

A list of objects matching the request.

Type: olympe.dc.ListDef.<T>

getSource()

Gets the source of this Sync.

Returns:

The source.

Type: string

getTag()

Gets the unique tag of this CloudObject.

Implements:

olympe.dc.HasTag#getTag

Returns:

The tag.

Type: string

getVersion()

Gets the version of this Sync.

Returns:

The version.

Type: number

isPersisted()

Returns true if this instance is persisted in the datacloud and false if it is a local instance only.

Returns:

Type: boolean

name()

Return the name of this CloudObject.

Returns:

Type: string

observe(context, property)

Return an observable to the value of the specified property of this object. Stops listening to updates when the specified context is destroyed.

Parameters:

Name	Type	Description
`context`	olympe.sc.Context \| olympe.df.ExecutionContext
`property`	olympe.dc.Tag

Returns:

Type: rxjs.Observable.<?*>

observeProperty(property)

Parameters:

Name	Type	Description
`property`	olympe.dc.Tag

Deprecated:

use olympe.dc.CloudObject#observe instead

Returns:

Type: rxjs.Observable.<?*>

oEquals(otherSync)

Checks whether this olympe.dc.CloudObject is equal to another CloudObject.

Parameters:

Name	Type	Description
`otherSync`	*	The object to compare with.

Returns:

true if both syncs have the same tag, false otherwise

Type: olympe.df.POBoolean

query()

Returns a query with this instance as root.

Returns:

Type: olympe.dc.Query

toJSON()

toListDef()

Returns a ListDef whose query has only the current sync as start point.

Returns:

The created ListDef.

Type: olympe.dc.ListDef

toOString()

Convert current object to a string representation. By default, this function simply returns what getDisplayName() returns, but this simplistic behavior should typically overridden by sibling classes.

Returns:

The string representation.

Type: olympe.df.POString

toString()

transform(transformers)

Creates a ListDef representing a query which will apply the provided transformers to this Sync.

Parameters:

Name	Type	Argument	Description
`transformers`	olympe.dc.Transformer \| Array.<olympe.dc.Transformer>	<repeatable>	The transformers to apply. Note that an error is thrown if an array is passed as first argument, there is more than one arguments.

Returns:

The created ListDef.

Type: olympe.dc.ListDef

Type Definitions

ValueCaster(value)

A ValueCaster is a function performing the conversion (or 'casting') of a raw value into a typed value.

Parameters:

Name	Type	Description
`value`	*	Raw value from database.

Returns:

value Casted value.

Type: *