Typed (Common API)

Overview - Common API - Client API - Admin API - Runtime API

Typed

Object is an instance with a namespace and a type.

This class is abstract.

Details

  • Module common

Method Summary

Name Returns Description
addArrayValue void Adds a value to an array property on this Resource
getFullyQualifiedType string Get the fully-qualified type name of the instance (including namespace)
getNamespace string Get the namespace of the instance
getType string Get the type of the instance (a short name, not including namespace)
instanceOf boolean Check to see if this instance is an instance of the specified fully qualified type name
setPropertyValue void Sets a property on this Resource

Method Details

getType

string getType( )

Get the type of the instance (a short name, not including namespace).

Returns

string - The type of this object

Parameters

No parameters

getFullyQualifiedType

string getFullyQualifiedType( )

Get the fully-qualified type name of the instance (including namespace).

Returns

string - The fully-qualified type name of this object

Parameters

No parameters

getNamespace

string getNamespace( )

Get the namespace of the instance.

Returns

string - The namespace of this object

Parameters

No parameters

setPropertyValue

setPropertyValue( string propname, string value )

Sets a property on this Resource

Parameters

Name Type Mandatory Description
propName string Yes the name of the field
value string Yes the value of the property

addArrayValue

addArrayValue( string propname, string value )

Adds a value to an array property on this Resource

Parameters

Name Type Mandatory Description
propName string Yes the name of the field
value string Yes the value of the property

instanceOf

boolean instanceOf( String fqt )

Check to see if this instance is an instance of the specified fully qualified type name.

Returns

boolean - True if this instance is an instance of the specified fully qualified type name, false otherwise.

Parameters

Name Type Mandatory Description
fqt String Yes The fully qualified type name.

Inherited methods