Edit on Github

Type Methods

Type has all the Concept methods plus what follows.

[tab:Java]

Get a Remote version of the type.

type.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

tx

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

Type.Remote

Retrieve label (Local)

type.getLabel().name();

Retrieves the unique label of the type.

Returns

String

Check if type is a root type (Local)

type.isRoot();

Checks if the type is a root type.

Returns

boolean

Rename label

type.setLabel(String label);

Renames the label of the type. The new label must remain unqiue.

Accepts

Param Description Type Required Default

label

The new label to be given to the type.

String

true

N/A

Returns

void

Check if type is abstract

type.isAbstract();

Checks if the type is prevented from having data instances (i.e. abstract).

Returns

boolean

Retrieve direct supertype

type.getSupertype();

Retrieves the most immediate supertype of the type.

Returns

Type

|

null

Retrieve all supertypes

type.getSupertypes();

Retrieves all supertypes of the type.

Returns

Stream<Type>

Retrieve all subtypes

type.getSubtypes();

Retrieves all direct and indirect subtypes of the type.

Returns

Stream<Type>

[tab:end] [tab:Javascript]

Get a Remote version of the type.

type.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

tx

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteType

Retrieve label (Local)

type.getLabel().name();

Retrieves the unique label of the type.

Returns

String

Check if type is a root type (Local)

type.isRoot();

Checks if the type is a root type.

Returns

boolean

Rename label

await type.setLabel(label);

Renames the label of the type. The new label must remain unqiue.

Accepts

Param Description Type Required Default

label

The new label to be given to the type.

String

true

N/A

Returns

void

Check if type is abstract

await type.isAbstract();

Checks if the type is prevented from having data instances (i.e. abstract).

Returns

boolean

Retrieve direct supertype

await type.getSupertype();

Retrieves the most immediate supertype of the type.

Returns

Type

|

null

Retrieve all supertypes

type.getSupertypes()

Retrieves all supertypes of the type.

Returns

Retrieve all subtypes

type.getSubtypes()

Retrieves all direct and indirect subtypes of the type.

Returns

[tab:end] [tab:Python]

Get a Remote version of the type.

type.as_remote(tx)

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

tx

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteType

Retrieve label (Local)

type.get_label().name()

Retrieves the unique label of the type.

Returns

String

Check if type is a root type (Local)

type.is_root()

Checks if the type is a root type.

Returns

boolean

Rename label

type.set_label(label)

Renames the label of the type. The new label must remain unqiue.

Accepts

Param Description Type Required Default

label

The new label to be given to the type.

String

true

N/A

Returns

None

Check if type is abstract

type.is_abstract()

Checks if the type is prevented from having data instances (i.e. abstract).

Returns

boolean

Retrieve direct supertype

type.get_supertype()

Retrieves the most immediate supertype of the type.

Returns

Type

|

None

Retrieve all supertypes

type.get_supertypes()

Retrieves all supertypes of the type.

Returns

Iterator of Type

Retrieve all subtypes

type.get_subtypes()

Retrieves all direct and indirect subtypes of the type.

Returns

Iterator of Type

[tab:end]

ThingType Methods

ThingType has all the Type methods plus what follows.

[tab:Java]

Get a Remote version of the ThingType.

thingType.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

tx

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

ThingType.Remote

Retrieve direct supertype

thingType.getSupertype();

Retrieves the most immediate supertype of the ThingType.

Returns

ThingType

|

null

Retrieve all supertypes

thingType.getSupertypes();

Retrieves all supertypes of the ThingType.

Returns

Stream<ThingType>

Retrieve all subtypes

thingType.getSubtypes();

Retrieves all direct and indirect subtypes of the ThingType.

Returns

Stream<ThingType>

Retrieve instances

thingType.getInstances();

Returns

Stream<Thing>

Set abstract

thingType.setAbstract();

Set a ThingType to be abstract, meaning it cannot have instances.

Returns

void

Unset abstract

thingType.unsetAbstract();

Set a ThingType to be non-abstract, meaning it can have instances.

Returns

void

Add new playable role

thingType.setPlays(RoleType roleType, RoleType overriddenType);

Allows the instances of this type to play the given role.

Accepts

Param Description Type Required Default

roleType

The role to be played by the instances of this type.

RoleType

true

N/A

overriddenType

The role type that this role overrides, if applicable.

RoleType

false

Returns

void

Add attribute ownership

thingType.setOwns(AttributeType attributeType, boolean isKey);

Allows the instances of this type to own the given AttributeType.

Accepts

Param Description Type Required Default

attributeType

The AttributeType to be owned by the instances of this type.

AttributeType

true

N/A

isKey

Whether this AttributeType is to be owned as a unique key.

boolean

false

false

Returns

void

Add attribute ownership

thingType.setOwns(AttributeType attributeType, AttributeType overriddenType, boolean isKey);

Allows the instances of this type to own the given AttributeType.

Accepts

Param Description Type Required Default

attributeType

The AttributeType to be owned by the instances of this type.

AttributeType

true

N/A

overriddenType

The AttributeType that this attribute ownership overrides, if applicable.

AttributeType

false

isKey

Whether this AttributeType is to be owned as a unique key.

boolean

false

false

Returns

void

Retrieve playable roles

thingType.getPlays();

Retrieves all direct and inherited roles that are allowed to be played by the instances of this type.

Returns

Stream<RoleType>

Retrieve attributes

thingType.getOwns(boolean keysOnly);

Retrieves attribute types that the instances of this type are allowed to own.

Accepts

Param Description Type Required Default

keysOnly

If set to true, then only attribute types owned as keys will be retrieved.

boolean

false

false

Returns

Stream<AttributeType>

Retrieve attributes

thingType.getOwns(AttributeType.ValueType valueType, boolean keysOnly);

Retrieves attribute types that the instances of this type are allowed to own.

Accepts

Param Description Type Required Default

valueType

If specified, only attribute types of this ValueType will be retrieved.

AttributeType.ValueType

false

keysOnly

If set to true, then only attribute types owned as keys will be retrieved.

boolean

false

false

Returns

Stream<AttributeType>

Remove role

thingType.unsetPlays(RoleType role);

Disallows the instances of this type from playing the given role.

Accepts

Param Description Type Required Default

role

The role to not be played by the instances of this type.

RoleType

true

N/A

Returns

void

Remove attribute

thingType.unsetOwns(AttributeType attributeType);

Disallows the instances of this type from owning the given AttributeType.

Accepts

Param Description Type Required Default

attributeType

The AttributeType to not be owend by the type.

AttributeType

true

N/A

Returns

void

[tab:end] [tab:Javascript]

Get a Remote version of the ThingType.

thingType.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

tx

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteThingType

Retrieve direct supertype

await thingType.getSupertype();

Retrieves the most immediate supertype of the ThingType.

Returns

ThingType

|

null

Retrieve all supertypes

thingType.getSupertypes()

Retrieves all supertypes of the ThingType.

Returns

Retrieve all subtypes

thingType.getSubtypes()

Retrieves all direct and indirect subtypes of the ThingType.

Returns

Retrieve instances

thingType.getInstances();

Returns

Set abstract

await thingType.setAbstract();

Set a ThingType to be abstract, meaning it cannot have instances.

Returns

void

Unset abstract

await thingType.unsetAbstract();

Set a ThingType to be non-abstract, meaning it can have instances.

Returns

void

Add new playable role

await thingType.setPlays(roleType, overriddenType);

Allows the instances of this type to play the given role.

Accepts

Param Description Type Required Default

roleType

The role to be played by the instances of this type.

RoleType

true

N/A

overriddenType

The role type that this role overrides, if applicable.

RoleType

false

undefined

Returns

void

Add attribute ownership

await thingType.setOwns(attributeType, isKey);

Allows the instances of this type to own the given AttributeType.

Accepts

Param Description Type Required Default

attributeType

The AttributeType to be owned by the instances of this type.

AttributeType

true

N/A

isKey

Whether this AttributeType is to be owned as a unique key.

boolean

false

false

Returns

void

Add attribute ownership

await thingType.setOwns(attributeType, overriddenType, isKey);

Allows the instances of this type to own the given AttributeType.

Accepts

Param Description Type Required Default

attributeType

The AttributeType to be owned by the instances of this type.

AttributeType

true

N/A

overriddenType

The AttributeType that this attribute ownership overrides, if applicable.

AttributeType

false

isKey

Whether this AttributeType is to be owned as a unique key.

boolean

false

false

Returns

void

Retrieve playable roles

await thingType.getPlays();

Retrieves all direct and inherited roles that are allowed to be played by the instances of this type.

Returns

Retrieve attributes

await thingType.getOwns(keysOnly);

Retrieves attribute types that the instances of this type are allowed to own.

Accepts

Param Description Type Required Default

keysOnly

If set to true, then only attribute types owned as keys will be retrieved.

boolean

false

false

Returns

Retrieve attributes

await thingType.getOwns(valueType, keysOnly);

Retrieves attribute types that the instances of this type are allowed to own.

Accepts

Param Description Type Required Default

valueType

If specified, only attribute types of this ValueType will be retrieved.

AttributeType.ValueType

false

keysOnly

If set to true, then only attribute types owned as keys will be retrieved.

boolean

false

false

Returns

Remove role

await thingType.unsetPlays(role);

Disallows the instances of this type from playing the given role.

Accepts

Param Description Type Required Default

role

The role to not be played by the instances of this type.

RoleType

true

N/A

Returns

void

Remove attribute

await thingType.unsetOwns(attributeType);

Disallows the instances of this type from owning the given AttributeType.

Accepts

Param Description Type Required Default

attributeType

The AttributeType to not be owend by the type.

AttributeType

true

N/A

Returns

void

[tab:end] [tab:Python]

Get a Remote version of the ThingType.

thing_type.as_remote(tx)

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

tx

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteThingType

Retrieve direct supertype

thing_type.get_supertype()

Retrieves the most immediate supertype of the ThingType.

Returns

ThingType

|

None

Retrieve all supertypes

thing_type.get_supertypes()

Retrieves all supertypes of the ThingType.

Returns

Iterator of ThingType

Retrieve all subtypes

thing_type.get_subtypes()

Retrieves all direct and indirect subtypes of the ThingType.

Returns

Iterator of ThingType

Retrieve instances

thing_type.get_instances()

Returns

Iterator of Thing

Set abstract

thing_type.set_abstract()

Set a ThingType to be abstract, meaning it cannot have instances.

Returns

None

Unset abstract

thing_type.unset_abstract()

Set a ThingType to be non-abstract, meaning it can have instances.

Returns

None

Add new playable role

thing_type.set_plays(role_type, overridden_type=None)

Allows the instances of this type to play the given role.

Accepts

Param Description Type Required Default

role_type

The role to be played by the instances of this type.

RoleType

true

N/A

overridden_type

The role type that this role overrides, if applicable.

RoleType

false

None

Returns

None

Add attribute ownership

thing_type.set_owns(attribute_type, overridden_type=None, is_key=False);

Allows the instances of this type to own the given AttributeType.

Accepts

Param Description Type Required Default

attributeType

The AttributeType to be owned by the instances of this type.

AttributeType

true

N/A

overriddenType

The AttributeType that this attribute ownership overrides, if applicable.

AttributeType

false

None

isKey

Whether this AttributeType is to be owned as a unique key.

bool

false

false

Returns

None

Retrieve playable roles

thing_type.get_plays()

Retrieves all direct and inherited roles that are allowed to be played by the instances of this type.

Returns

Iterator of RoleType

Retrieve attributes

thing_type.get_owns(value_type=None, keys_only=False)

Retrieves attribute types that the instances of this type are allowed to own.

Accepts

Param Description Type Required Default

value_type

If specified, only attribute types of this ValueType will be retrieved.

ValueType

false

None

keys_only

If set to True, then only attribute types owned as keys will be retrieved.

bool

false

false

Returns

Iterator of AttributeType

Remove role

thing_type.unset_plays(role)

Disallows the instances of this type from playing the given role.

Accepts

Param Description Type Required Default

role

The role to not be played by the instances of this type.

RoleType

true

N/A

Returns

None

Remove attribute

thing_type.unset_owns(attribute_type)

Disallows the instances of this type from owning the given AttributeType.

Accepts

Param Description Type Required Default

attribute_type

The AttributeType to not be owend by the type.

AttributeType

true

N/A

Returns

None

[tab:end]

EntityType Methods

EntityType has all the ThingType methods plus what follows.

[tab:Java]

Create instance

entityType.create();

Creates and returns a new instance of this EntityType.

Returns

Set supertype

entityType.setSupertype(EntityType entityType);

Sets the supplied EntityType as the supertype of the current EntityType

Accepts

Param Description Type Required Default

entityType

The EntityType to set as the supertype of this EntityType

EntityType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes();

Retrieves all direct and indirect subtypes of the EntityType.

Returns

Stream<EntityType>

Retrieve all instances of this EntityType

type.getInstances();

Retrieves all Entity objects that are instances of this Type.

Returns

Stream<Entity>

Get a Remote version of the EntityType.

entityType.asRemote(Transaction tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

EntityType.Remote

[tab:end] [tab:Javascript]

Create instance

await entityType.create();

Creates and returns a new instance of this EntityType.

Returns

Set supertype

entityType.setSupertype(entityType);

Sets the supplied EntityType as the supertype of the current EntityType

Accepts

Param Description Type Required Default

entityType

The EntityType to set as the supertype of this EntityType

EntityType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes()

Retrieves all direct and indirect subtypes of the EntityType.

Returns

Retrieve all instances of this EntityType

type.getInstances()

Retrieves all Entity objects that are instances of this Type.

Returns

Get a Remote version of the EntityType.

entityType.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteEntityType

[tab:end] [tab:Python]

Create instance

entity_type.create()

Creates and returns a new instance of this EntityType.

Returns

Set supertype

entity_type.set_supertype(entity_type)

Sets the supplied EntityType as the supertype of the current EntityType

Accepts

Param Description Type Required Default

entityType

The EntityType to set as the supertype of this EntityType

EntityType

true

N/A

Returns

None

Retrieve all subtypes

type.get_subtypes()

Retrieves all direct and indirect subtypes of the EntityType.

Returns

Iterator of EntityType

Retrieve all instances of this EntityType

type.get_instances()

Retrieves all Entity objects that are instances of this Type.

Returns

Iterator of Entity

Get a Remote version of the EntityType.

entity_type.as_remote(tx)

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteEntityType

[tab:end]

AttributeType Methods

AttributeType has all the ThingType methods plus what follows.

[tab:Java]

Retrieve valuetype (Local)

attributeType.getValueType();

Retrieves the valuetype of this AttributeType.

Returns

AttributeType.ValueType (STRING | DATETIME | LONG | DOUBLE | BOOLEAN)

Set supertype

attributeType.setSupertype(AttributeType attributeType);

Sets the supplied AttributeType as the supertype of the current AttributeType

Accepts

Param Description Type Required Default

attributeType

The AttributeType to set as the supertype of this AttributeType

AttributeType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes();

Retrieves all direct and indirect subtypes of the AttributeType.

Returns

Stream<AttributeType>

Retrieve all instances of this AttributeType

type.getInstances();

Retrieves all Attributes that are instances of this Type.

Returns

Stream<Attribute>

Retrieve owners of this Type of Attribute

type.getOwners(boolean onlyKey);

Retrieve all Things that own an attribute of this type. Optionally, only fetches Things that own an attribute of this type as a key.

Accepts

Param Description Type Required Default

onlyKey

If true, only retrieve things that have an attribute of this type as a key.

boolean

false

false

Returns

Stream<Thing>

Get a Remote version of the AttributeType.

attributeType.asRemote(Transaction tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

AttributeType.Remote

Check if value is of type boolean

attribute.isBoolean();

Returns true if the value for attributes of this type is of type boolean. Otherwise, returns false.

Check if value is of type long

attribute.isLong();

Returns true if the value for attributes of this type is of type long. Otherwise, returns false.

Check if value is of type double

attribute.isDouble();

Returns true if the value for attributes of this type is of type double. Otherwise, returns false.

Check if value is of type string

attribute.isString();

Returns true if the value for attributes of this type is of type string. Otherwise, returns false.

Check if value is of type datetime

attribute.isDateTime();

Returns true if the value for attributes of this type datetime. Otherwise, returns false.

[tab:end] [tab:Javascript]

Retrieve valuetype (Local)

attributeType.getValueType();

Retrieves the valuetype of this AttributeType.

Returns

AttributeType.ValueType (STRING | DATETIME | LONG | DOUBLE | BOOLEAN)

Set supertype

attributeType.setSupertype(attributeType);

Sets the supplied AttributeType as the supertype of the current AttributeType

Accepts

Param Description Type Required Default

attributeType

The AttributeType to set as the supertype of this AttributeType

AttributeType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes()

Retrieves all direct and indirect subtypes of the AttributeType.

Returns

Retrieve all instances of this AttributeType

type.getInstances()

Retrieves all Attributes that are instances of this Type.

Returns

Retrieve owners of this Type of Attribute

type.getOwners(onlyKey)

Retrieve all Things that own an attribute of this type. Optionally, only fetches Things that own an attribute of this type as a key.

Accepts

Param Description Type Required Default

onlyKey

If true, only retrieve things that have an attribute of this type as a key.

boolean

false

false

Returns

Get a Remote version of the AttributeType.

attributeType.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteAttributeType

Check if value is of type boolean

attribute.isBoolean();

Returns true if the value for attributes of this type is of type boolean. Otherwise, returns false.

Check if value is of type long

attribute.isLong();

Returns true if the value for attributes of this type is of type long. Otherwise, returns false.

Check if value is of type double

attribute.isDouble();

Returns true if the value for attributes of this type is of type double. Otherwise, returns false.

Check if value is of type string

attribute.isString();

Returns true if the value for attributes of this type is of type string. Otherwise, returns false.

Check if value is of type datetime

attribute.isDateTime();

Returns true if the value for attributes of this type datetime. Otherwise, returns false.

[tab:end] [tab:Python]

Retrieve valuetype (Local)

attributeType.get_value_type()

Retrieves the valuetype of this AttributeType.

Returns

AttributeType.ValueType (STRING | DATETIME | LONG | DOUBLE | BOOLEAN)

Set supertype

attributeType.set_supertype(attribute_type)

Sets the supplied AttributeType as the supertype of the current AttributeType

Accepts

Param Description Type Required Default

attribute_type

The AttributeType to set as the supertype of this AttributeType

AttributeType

true

N/A

Returns

None

Retrieve all subtypes

type.get_subtypes()

Retrieves all direct and indirect subtypes of the AttributeType.

Returns

Iterator of AttributeType

Retrieve all instances of this AttributeType

type.get_instances()

Retrieves all Attributes that are instances of this Type.

Returns

Iterator of Attribute

Retrieve owners of this Type of Attribute

type.getOwners(onlyKey)

Retrieve all Things that own an attribute of this type. Optionally, only fetches Things that own an attribute of this type as a key.

Accepts

Param Description Type Required Default

onlyKey

If true, only retrieve things that have an attribute of this type as a key.

boolean

false

false

Returns

Iterator of Thing

Get a Remote version of the AttributeType.

attributeType.as_remote(tx)

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteAttributeType

Check if value is of type boolean

attribute.is_boolean()

Returns true if the value for attributes of this type is of type boolean. Otherwise, returns false.

Check if value is of type long

attribute.is_long()

Returns true if the value for attributes of this type is of type long. Otherwise, returns false.

Check if value is of type double

attribute.is_double()

Returns true if the value for attributes of this type is of type double. Otherwise, returns false.

Check if value is of type string

attribute.is_string()

Returns true if the value for attributes of this type is of type string. Otherwise, returns false.

Check if value is of type datetime

attribute.is_datetime()

Returns true if the value for attributes of this type datetime. Otherwise, returns false.

[tab:end]

BooleanAttributeType Methods

BooleanAttributeType has all the AttributeType methods plus what follows.

[tab:Java]

Put instance

booleanAttributeType.put(boolean value);

Puts and returns a new instance of this BooleanAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

boolean

true

N/A

Returns

BooleanAttribute object

Get instance

booleanAttributeType.get(Boolean value);

Returns the instance, if it exists, of this BooleanAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

boolean

true

N/A

Returns

BooleanAttribute object

Set supertype

attributeType.setSupertype(AttributeType.Boolean booleanAttributeType);

Sets the supplied BooleanAttributeType as the supertype of the current BooleanAttributeType

Accepts

Param Description Type Required Default

booleanAttributeType

The AttributeType to set as the supertype of this BooleanAttributeType

BooleanAttributeType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes();

Retrieves all direct and indirect subtypes of the BooleanAttributeType.

Returns

Retrieve all instances of this BooleanAttributeType

type.getInstances();

Retrieves all BooleanAttributes that are instances of this Type.

Returns

Get a Remote version of the BooleanAttributeType.

booleanAttributeType.asRemote(Transaction tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

BooleanAttributeType.Remote

[tab:end] [tab:Javascript]

Put instance

await booleanAttributeType.put(value);

Puts and returns a new instance of this BooleanAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

boolean

true

N/A

Returns

BooleanAttribute object

Get instance

await booleanAttributeType.get(value);

Returns the instance, if it exists, of this BooleanAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

boolean

true

N/A

Returns

BooleanAttribute object

Set supertype

attributeType.setSupertype(booleanAttributeType);

Sets the supplied BooleanAttributeType as the supertype of the current BooleanAttributeType

Accepts

Param Description Type Required Default

booleanAttributeType

The AttributeType to set as the supertype of this BooleanAttributeType

BooleanAttributeType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes()

Retrieves all direct and indirect subtypes of the BooleanAttributeType.

Returns

Retrieve all instances of this BooleanAttributeType

type.getInstances()

Retrieves all BooleanAttributes that are instances of this Type.

Returns

Get a Remote version of the BooleanAttributeType.

booleanAttributeType.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteBooleanAttributeType

[tab:end] [tab:Python]

Put instance

booleanAttributeType.put(value)

Puts and returns a new instance of this BooleanAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

boolean

true

N/A

Returns

BooleanAttribute object

Get instance

booleanAttributeType.get(value)

Returns the instance, if it exists, of this BooleanAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

boolean

true

N/A

Returns

BooleanAttribute object

Set supertype

attributeType.set_supertype(boolean_attribute_type)

Sets the supplied BooleanAttributeType as the supertype of the current BooleanAttributeType

Accepts

Param Description Type Required Default

_type

The AttributeType to set as the supertype of this BooleanAttributeType

BooleanAttributeType

true

N/A

Returns

None

Retrieve all subtypes

type.get_subtypes()

Retrieves all direct and indirect subtypes of the BooleanAttributeType.

Returns

Iterator of BooleanAttributeType

Retrieve all instances of this BooleanAttributeType

type.get_instances()

Retrieves all BooleanAttributes that are instances of this Type.

Returns

Iterator of BooleanAttribute

Get a Remote version of the BooleanAttributeType.

booleanAttributeType.as_remote(tx)

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteBooleanAttributeType

[tab:end]

LongAttributeType Methods

LongAttributeType has all the AttributeType methods plus what follows.

[tab:Java]

Put instance

longAttributeType.put(long value);

Puts and returns a new instance of this LongAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

long

true

N/A

Returns

LongAttribute

Get instance

longAttributeType.get(long value);

Returns the instance, if it exists, of this LongAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

long

true

N/A

Returns

LongAttribute

Set Supertype

attributeType.setSupertype(AttributeType.Long longAttributeType);

Sets the supplied LongAttributeType as the supertype of the current LongAttributeType

Accepts

Param Description Type Required Default

longAttributeType

The AttributeType to set as the supertype of this LongAttributeType

LongAttributeType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes();

Retrieves all direct and indirect subtypes of the LongAttributeType.

Returns

Retrieve all instances of this LongAttributeType

type.getInstances();

Retrieves all LongAttributes that are instances of this Type.

Returns

Stream<LongAttribute>

Get a Remote version of the LongAttributeType.

longAttributeType.asRemote(Transaction tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

LongAttributeType.Remote

[tab:end] [tab:Javascript]

Put instance

await longAttributeType.put(value);

Puts and returns a new instance of this LongAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

number

true

N/A

Returns

LongAttribute

Get instance

await longAttributeType.get(value);

Returns the instance, if it exists, of this LongAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

number

true

N/A

Returns

LongAttribute

Set Supertype

attributeType.setSupertype(longAttributeType);

Sets the supplied LongAttributeType as the supertype of the current LongAttributeType

Accepts

Param Description Type Required Default

longAttributeType

The AttributeType to set as the supertype of this LongAttributeType

LongAttributeType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes()

Retrieves all direct and indirect subtypes of the LongAttributeType.

Returns

Retrieve all instances of this LongAttributeType

type.getInstances()

Retrieves all LongAttributes that are instances of this Type.

Returns

Get a Remote version of the LongAttributeType.

longAttributeType.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteLongAttributeType

[tab:end] [tab:Python]

Put instance

longAttributeType.put(value)

Puts and returns a new instance of this LongAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

int

true

N/A

Returns

LongAttribute

Get instance

longAttributeType.get(value)

Returns the instance, if it exists, of this LongAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

int

true

N/A

Returns

LongAttribute

Set Supertype

attributeType.set_supertype(longAttributeType)

Sets the supplied LongAttributeType as the supertype of the current LongAttributeType

Accepts

Param Description Type Required Default

_type

The AttributeType to set as the supertype of this LongAttributeType

LongAttributeType

true

N/A

Returns

None

Retrieve all subtypes

type.get_subtypes()

Retrieves all direct and indirect subtypes of the LongAttributeType.

Returns

Iterator of LongAttributeType

Retrieve all instances of this LongAttributeType

type.get_instances()

Retrieves all LongAttributes that are instances of this Type.

Returns

Iterator of LongAttribute

Get a Remote version of the LongAttributeType.

longAttributeType.as_remote(tx)

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteLongAttributeType

[tab:end]

DoubleAttributeType Methods

DoubleAttributeType has all the AttributeType methods plus what follows.

[tab:Java]

Put instance

doubleAttributeType.put(double value);

Puts and returns a new instance of this DoubleAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

double

true

N/A

Returns

DoubleAttribute

Get instance

doubleAttributeType.get(double value);

Returns the instance, if it exists, of this DoubleAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

long

true

N/A

Returns

DoubleAttribute

Set Supertype

attributeType.setSupertype(AttributeType.Double doubleAttributeType);

Sets the supplied DoubleAttributeType as the supertype of the current DoubleAttributeType

Accepts

Param Description Type Required Default

doubleAttributeType

The AttributeType to set as the supertype of this DoubleAttributeType

DoubleAttributeType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes();

Retrieves all direct and indirect subtypes of the DoubleAttributeType.

Returns

Retrieve all instances of this DoubleAttributeType

type.getInstances();

Retrieves all DoubleAttributes that are instances of this Type.

Returns

Stream<DoubleAttribute>

Get a Remote version of the DoubleAttributeType.

doubleAttributeType.asRemote(Transaction tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

DoubleAttributeType.Remote

[tab:end] [tab:Javascript]

Put instance

await doubleAttributeType.put(value);

Puts and returns a new instance of this DoubleAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

number

true

N/A

Returns

DoubleAttribute

Get instance

await doubleAttributeType.get(value);

Returns the instance, if it exists, of this DoubleAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

number

true

N/A

Returns

DoubleAttribute

Set Supertype

attributeType.setSupertype(doubleAttributeType);

Sets the supplied DoubleAttributeType as the supertype of the current DoubleAttributeType

Accepts

Param Description Type Required Default

doubleAttributeType

The AttributeType to set as the supertype of this DoubleAttributeType

DoubleAttributeType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes()

Retrieves all direct and indirect subtypes of the DoubleAttributeType.

Returns

Retrieve all instances of this DoubleAttributeType

type.getInstances()

Retrieves all DoubleAttributes that are instances of this Type.

Returns

Get a Remote version of the DoubleAttributeType.

doubleAttributeType.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteDoubleAttributeType

[tab:end] [tab:Python]

Put instance

doubleAttributeType.put(value)

Puts and returns a new instance of this DoubleAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

float

true

N/A

Returns

DoubleAttribute

Get instance

doubleAttributeType.get(value)

Returns the instance, if it exists, of this DoubleAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

float

true

N/A

Returns

DoubleAttribute

Set Supertype

attributeType.set_supertype(doubleAttributeType)

Sets the supplied DoubleAttributeType as the supertype of the current DoubleAttributeType

Accepts

Param Description Type Required Default

_type

The AttributeType to set as the supertype of this DoubleAttributeType

DoubleAttributeType

true

N/A

Returns

None

Retrieve all subtypes

type.get_subtypes()

Retrieves all direct and indirect subtypes of the DoubleAttributeType.

Returns

Iterator of DoubleAttributeType

Retrieve all instances of this DoubleAttributeType

type.get_instances()

Retrieves all DoubleAttributes that are instances of this Type.

Returns

Iterator of DoubleAttribute

Get a Remote version of the DoubleAttributeType.

doubleAttributeType.as_remote(tx)

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteDoubleAttributeType

[tab:end]

StringAttributeType Methods

StringAttributeType has all the AttributeType methods plus what follows.

[tab:Java]

Put instance

stringAttributeType.put(String value);

Puts and returns a new instance of this StringAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

string

true

N/A

Returns

StringAttribute

Get instance

stringAttributeType.get(String value);

Returns the instance, if it exists, of this StringAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

string

true

N/A

Returns

StringAttribute

Retrieve regex

stringAttributeType.getRegex();

Retrieves the regex that all instances of this StringAttributeType must conform to.

Returns

string

|

null

Set regex

stringAttributeType.setRegex(String regex);

Set the regex that all instances of this StringAttributeType must conform to.

Accepts

Param Description Type Required Default

regex

The regex that all instances of this StringAttributeType must conform to.

string

true

N/A

Returns

void

Set Supertype

attributeType.setSupertype(AttributeType.String stringAttributeType);

Sets the supplied StringAttributeType as the supertype of the current StringAttributeType

Accepts

Param Description Type Required Default

stringAttributeType

The AttributeType to set as the supertype of this StringAttributeType

StringAttributeType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes();

Retrieves all direct and indirect subtypes of the StringAttributeType.

Returns

Retrieve all instances of this StringAttributeType

type.getInstances();

Retrieves all StringAttributes that are instances of this Type.

Returns

Stream<StringAttribute>

Get a Remote version of the StringAttributeType.

stringAttributeType.asRemote(Transaction tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

StringAttributeType.Remote

[tab:end] [tab:Javascript]

Put instance

await stringAttributeType.put(value);

Puts and returns a new instance of this StringAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

string

true

N/A

Returns

StringAttribute

Get instance

await stringAttributeType.get(value);

Returns the instance, if it exists, of this StringAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

string

true

N/A

Returns

StringAttribute

Retrieve regex

await stringAttributeType.getRegex();

Retrieves the regex that all instances of this StringAttributeType must conform to.

Returns

string

|

None

Set regex

await stringAttributeType.setRegex(regex);

Set the regex that all instances of this StringAttributeType must conform to.

Accepts

Param Description Type Required Default

regex

The regex that all instances of this StringAttributeType must conform to.

string

true

N/A

Returns

void

Set Supertype

attributeType.setSupertype(stringAttributeType);

Sets the supplied StringAttributeType as the supertype of the current StringAttributeType

Accepts

Param Description Type Required Default

stringAttributeType

The AttributeType to set as the supertype of this StringAttributeType

StringAttributeType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes()

Retrieves all direct and indirect subtypes of the StringAttributeType.

Returns

Retrieve all instances of this StringAttributeType

type.getInstances()

Retrieves all StringAttributes that are instances of this Type.

Returns

Get a Remote version of the StringAttributeType.

stringAttributeType.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteStringAttributeType

[tab:end] [tab:Python]

Put instance

string_attribute_type.put(value)

Puts and returns a new instance of this StringAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

string

true

N/A

Returns

StringAttribute

Get instance

stringAttributeType.get(value)

Returns the instance, if it exists, of this StringAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

string

true

N/A

Returns

StringAttribute

Retrieve regex

string_attribute_type.get_regex()

Retrieves the regex that all instances of this StringAttributeType must conform to.

Returns

string

|

null

Set regex

string_attribute_type.set_regex(regex)

Set the regex that all instances of this StringAttributeType must conform to.

Accepts

Param Description Type Required Default

regex

The regex that all instances of this StringAttributeType must conform to.

string

true

N/A

Returns

void

Set Supertype

attributeType.set_supertype(string_attribute_type)

Sets the supplied StringAttributeType as the supertype of the current StringAttributeType

Accepts

Param Description Type Required Default

_type

The AttributeType to set as the supertype of this StringAttributeType

StringAttributeType

true

N/A

Returns

None

Retrieve all subtypes

type.get_subtypes()

Retrieves all direct and indirect subtypes of the StringAttributeType.

Returns

Iterator of StringAttributeType

Retrieve all instances of this StringAttributeType

type.get_instances()

Retrieves all StringAttributes that are instances of this Type.

Returns

Iterator of StringAttribute

Get a Remote version of the StringAttributeType.

stringAttributeType.as_remote(tx)

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteStringAttributeType

[tab:end]

DateTimeAttributeType Methods

DateTimeAttributeType has all the AttributeType methods plus what follows.

[tab:Java]

Put instance

datetimeAttributeType.put(LocalDateTime value);

Puts and returns a new instance of this DateTimeAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

LocalDateTime

true

N/A

Returns

DateTimeAttribute object

Get instance

datetimeAttributeType.get(LocalDateTime value);

Returns the instance, if it exists, of this DateTimeAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

LocalDateTime

true

N/A

Returns

DateTimeAttribute object

Set Supertype

attributeType.setSupertype(AttributeType.DateTime datetimeAttributeType);

Sets the supplied DateTimeAttributeType as the supertype of the current DateTimeAttributeType

Accepts

Param Description Type Required Default

dateTimeAttributeType

The AttributeType to set as the supertype of this DateTimeAttributeType

DateTimeAttributeType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes();

Retrieves all direct and indirect subtypes of the DateTimeAttributeType.

Returns

Retrieve all instances of this DateTimeAttributeType

type.getInstances();

Retrieves all DateTimeAttributes that are instances of this Type.

Returns

Get a Remote version of the DateTimeAttributeType.

dateTimeAttributeType.asRemote(Transaction tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

DateTimeAttributeType.Remote

[tab:end] [tab:Javascript]

Put instance

await dateTimeAttributeType.put(value);

Puts and returns a new instance of this DateTimeAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

Date

true

N/A

Returns

DateTimeAttribute object

Get instance

await dateTimeAttributeType.get(value);

Returns the instance, if it exists, of this DateTimeAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

number

true

N/A

Returns

DateTimeAttribute object

Set Supertype

attributeType.setSupertype(datetimeAttributeType);

Sets the supplied DateTimeAttributeType as the supertype of the current DateTimeAttributeType

Accepts

Param Description Type Required Default

dateTimeAttributeType

The AttributeType to set as the supertype of this DateTimeAttributeType

DateTimeAttributeType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes()

Retrieves all direct and indirect subtypes of the DateTimeAttributeType.

Returns

Retrieve all instances of this DateTimeAttributeType

type.getInstances()

Retrieves all DateTimeAttributes that are instances of this Type.

Returns

Get a Remote version of the DateTimeAttributeType.

dateTimeAttributeType.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteDateTimeAttributeType

[tab:end] [tab:Python]

Put instance

dateTimeAttributeType.put(value)

Puts and returns a new instance of this DateTimeAttributeType with the specified value. If an attribute with this value does not yet exist, it will be created.

Accepts

Param Description Type Required Default

value

The value of the instance to be put

datetime

true

N/A

Returns

DateTimeAttribute object

Get instance

dateTimeAttributeType.get(value)

Returns the instance, if it exists, of this DateTimeAttributeType with the specified value.

Accepts

Param Description Type Required Default

value

The value of the instance to be retrieved

datetime

true

N/A

Returns

DateTimeAttribute object

Set Supertype

attributeType.set_supertype(datetime_attribute_type)

Sets the supplied DateTimeAttributeType as the supertype of the current DateTimeAttributeType

Accepts

Param Description Type Required Default

_type

The AttributeType to set as the supertype of this DateTimeAttributeType

DateTimeAttributeType

true

N/A

Returns

None

Retrieve all subtypes

type.get_subtypes()

Retrieves all direct and indirect subtypes of the DateTimeAttributeType.

Returns

Iterator of DateTimeAttributeType

Retrieve all instances of this DateTimeAttributeType

type.get_instances()

Retrieves all DateTimeAttributes that are instances of this Type.

Returns

Iterator of DateTimeAttribute

Get a Remote version of the DateTimeAttributeType.

dateTimeAttributeType.as_remote(tx)

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteDateTimeAttributeType

[tab:end]

RelationType Methods

RelationType has all the ThingType methods plus what follows.

[tab:Java]

Create instance

relationType.create();

Creates and returns an instance of this RelationType.

Returns

Retrieve roles

relationType.getRelates();

Retrieve roles that this RelationType relates to.

Returns

Retrieve specific role

relationType.getRelates(String label);

Retrieve the role that this RelationType relates to, if it exists, with the specified label.

Accepts

Param Description Type Required Default

label

Label of the role we wish to retrieve.

string

true

Returns

Set new role

relationType.setRelates(String label, String overriddenRoleLabel);

Sets the new role that this RelationType relates to. If you are setting an overriding type this way, you have to also pass the overridden type as a second argument.

Accepts

Param Description Type Required Default

label

The new role for the RelationType to relate to.

string

true

N/A

overriddenRoleLabel

The label being overridden, if applicable

string

false

N/A

Returns

void

Remove role

relationType.unsetRelates(RoleType role);

Disallows this RelationType from relating to the given role.

Accepts

Param Description Type Required Default

role

The role to not relate to the relation type.

RoleType

true

N/A

Returns

void

Set supertype

relationType.setSupertype(RelationType relationType);

Sets the supplied RelationType as the supertype of the current RelationType

Accepts

Param Description Type Required Default

relationType

The RelationType to set as the supertype of this RelationType

RelationType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes();

Retrieves all direct and indirect subtypes of the RelationType.

Returns

Stream<RelationType>

Retrieve all instances of this RelationType

type.getInstances();

Retrieves all Relations that are instances of this Type.

Returns

Stream<Relation>

Get a Remote version of the RelationType.

relationType.asRemote(Transaction tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RelationType.Remote

[tab:end] [tab:Javascript]

Create instance

await relationType.create();

Creates and returns an instance of this RelationType.

Returns

Retrieve roles

relationType.getRelates();

Retrieve roles that this RelationType relates to.

Returns

Retrieve specific role

await relationType.getRelates(label);

Retrieve the role that this RelationType relates to, if it exists, with the specified label.

Accepts

Param Description Type Required Default

label

Label of the role we wish to retrieve.

string

true

Returns

Set new role

await relationType.setRelates(label, overriddenRoleLabel);

Sets the new role that this RelationType relates to. If you are setting an overriding type this way, you have to also pass the overridden type as a second argument.

Accepts

Param Description Type Required Default

label

The new role for the RelationType to relate to.

string

true

N/A

overriddenRoleLabel

The label being overridden, if applicable

string

false

N/A

Returns

void

Remove role

await relationType.unsetRelates(role);

Disallows this RelationType from relating to the given role.

Accepts

Param Description Type Required Default

role

The role to not relate to the relation type.

RoleType

true

N/A

Returns

void

Set supertype

relationType.setSupertype(relationType);

Sets the supplied RelationType as the supertype of the current RelationType

Accepts

Param Description Type Required Default

relationType

The RelationType to set as the supertype of this RelationType

RelationType

true

N/A

Returns

void

Retrieve all subtypes

type.getSubtypes()

Retrieves all direct and indirect subtypes of the RelationType.

Returns

Retrieve all instances of this RelationType

type.getInstances()

Retrieves all Relations that are instances of this Type.

Returns

Get a Remote version of the RelationType.

relationType.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteRelationType

[tab:end] [tab:Python]

Create instance

relation_type.create()

Creates and returns an instance of this RelationType.

Returns

Retrieve roles

relation_type.get_relates()

Retrieve roles that this RelationType relates to.

Returns

Iterator of RoleType

Retrieve specific role

relation_type.get_relates(label)

Retrieve the role that this RelationType relates to, if it exists, with the specified label.

Accepts

Param Description Type Required Default

label

Label of the role we wish to retrieve.

string

true

Returns

Set new role

relation_type.set_relates(label, overriddenRoleLabel)

Sets the new role that this RelationType relates to. If you are setting an overriding type this way, you have to also pass the overridden type as a second argument.

Accepts

Param Description Type Required Default

label

The new role for the RelationType to relate to.

string

true

N/A

overriddenRoleLabel

The label being overridden, if applicable

string

false

N/A

Returns

None

Remove role

relation_type.unset_relates(role)

Disallows this RelationType from relating to the given role.

Accepts

Param Description Type Required Default

role

The role to not relate to the relation type.

RoleType

true

N/A

Returns

None

Set supertype

relation_type.set_supertype(relation_type)

Sets the supplied RelationType as the supertype of the current RelationType

Accepts

Param Description Type Required Default

_type

The RelationType to set as the supertype of this RelationType

RelationType

true

N/A

Returns

None

Retrieve all subtypes

type.get_subtypes()

Retrieves all direct and indirect subtypes of the RelationType.

Returns

Iterator of RelationType

Retrieve all instances of this RelationType

type.get_instances()

Retrieves all Relations that are instances of this Type.

Returns

Iterator of Relation

Get a Remote version of the RelationType.

relationType.as_remote(tx)

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

transaction

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteRelationType

[tab:end]

RoleType Methods

RoleType has all the Type methods plus what follows.

[tab:Java]

Get a Remote version of the role type.

roleType.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

tx

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RoleType.Remote

Retrieve scope (Local)

roleType.getLabel().scope();

Retrieves the scope (defined relation label) of the role type.

Returns

String

Retrieve scoped label (Local)

roleType.getLabel().scopedName();

Retrieves the scoped label (relation:role) of the role type.

Returns

String

Retrieve direct supertype

type.getSupertype();

Retrieves the most immediate supertype of the role type.

Returns

RoleType

|

null

Retrieve all supertypes

type.getSupertypes();

Retrieves all supertypes of the role type.

Returns

Stream<RoleType>

Retrieve all subtypes

type.getSubtypes();

Retrieves all direct and indirect subtypes of the type.

Returns

Stream<RoleType>

Retrieve relation

role.getRelationType();

Retrieves the Relation instance that this role is directly related to.

Returns

Stream<RelationType>

Retrieve relation types

role.getRelationTypes();

Retrieves the RelationTypes that this role is related to.

Returns

Stream<RelationType>

Retrieve role players

role.getPlayers();

Retrieves the ThingTypes whose instances play this role.

Returns

Stream<ThingType>

[tab:end] [tab:Javascript]

Get a Remote version of the role type.

roleType.asRemote(tx);

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

tx

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteRoleType

Retrieve scope (Local)

roleType.getLabel().scope();

Retrieves the scope (defined relation label) of the role type.

Returns

String

Retrieve scoped label (Local)

roleType.getLabel().scopedName();

Retrieves the scoped label (relation:role) of the role type.

Returns

String

Retrieve direct supertype

await type.getSupertype();

Retrieves the most immediate supertype of the role type.

Returns

RoleType

|

null

Retrieve all supertypes

type.getSupertypes()

Retrieves all supertypes of the role type.

Returns

Retrieve all subtypes

type.getSubtypes()

Retrieves all direct and indirect subtypes of the type.

Returns

Retrieve relation

await role.getRelationType();

Retrieves the Relation instance that this role is directly related to.

Returns

Retrieve relation types

await role.getRelationTypes();

Retrieves the RelationTypes that this role is related to.

Returns

Retrieve role players

await role.getPlayers();

Retrieves the ThingTypes whose instances play this role.

Returns

[tab:end] [tab:Python]

Get a Remote version of the role type.

role_type.as_remote(tx)

The remote version uses the given transaction to execute every method call.

Accepts

Param Description Type Required Default

tx

The transaction to be used to make method calls.

Transaction

true

N/A

Returns

RemoteRoleType

Retrieve scope (Local)

role_type.get_label().scope()

Retrieves the scope (defined relation label) of the role type.

Returns

String

Retrieve scoped label (Local)

role_type.get_label().scoped_name()

Retrieves the scoped label (relation:role) of the role type.

Returns

String

Retrieve direct supertype

type.get_supertype()

Retrieves the most immediate supertype of the role type.

Returns

RoleType

|

None

Retrieve all supertypes

type.get_supertypes()

Retrieves all supertypes of the role type.

Returns

Iterator of RoleType

Retrieve all subtypes

type.get_subtypes()

Retrieves all direct and indirect subtypes of the type.

Returns

Iterator of RoleType

Retrieve relation

role.get_relation_type()

Retrieves the Relation instance that this role is directly related to.

Returns

Iterator of RelationType

Retrieve relation types

role.get_relation_types()

Retrieves the RelationTypes that this role is related to.

Returns

Iterator of RelationType

Retrieve role players

role.get_players()

Retrieves the ThingTypes whose instances play this role.

Returns

Iterator of ThingType

[tab:end]