Type | Vaticle

Retrieve playable roles

await thingType.asRemote(tx).getPlaysExplicit();

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

Returns

Retrieve attributes

await thingType.asRemote(tx).getOwns(keysOnly);

Retrieves attribute types that the instances of this type are allowed to own directly or via inheritance.

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.asRemote(tx).getOwnsExplicit(keysOnly);

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

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.asRemote(tx).getOwns(valueType, keysOnly);

Retrieves attribute types that the instances of this type are allowed to own directly or via inheritance.

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

Retrieve attributes

await thingType.asRemote(tx).getOwnsExplicit(valueType, keysOnly);

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

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.asRemote(tx).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.asRemote(tx).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 owned 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.as_remote(tx).get_supertype()

Retrieves the most immediate supertype of the ThingType.

Returns

ThingType

None

Retrieve all supertypes

thing_type.as_remote(tx).get_supertypes()

Retrieves all supertypes of the ThingType.

Returns

Iterator of ThingType

Retrieve all subtypes

thing_type.as_remote(tx).get_subtypes()

Retrieves all direct and indirect subtypes of the ThingType.

Returns

Iterator of ThingType

Retrieve instances

thing_type.as_remote(tx).get_instances()

Returns

Iterator of Thing

Set abstract

thing_type.as_remote(tx).set_abstract()

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

Returns

None

Unset abstract

thing_type.as_remote(tx).unset_abstract()

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

Returns

None

Add new playable role

thing_type.as_remote(tx).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.as_remote(tx).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.as_remote(tx).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 playable roles

thing_type.as_remote(tx).get_plays_explicit()

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

Returns

Iterator of RoleType

Retrieve attributes

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

Retrieves attribute types that the instances of this type are allowed to own directly or via inheritance.

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

Retrieve direct attributes

thing_type.as_remote(tx).get_owns_explicit(value_type=None, keys_only=False)

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

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.as_remote(tx).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.as_remote(tx).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 owned 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.asRemote(Transaction tx).create();

Creates and returns a new instance of this EntityType.

Returns

Entity

Set supertype

entityType.asRemote(Transaction tx).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.asRemote(Transaction tx).getSubtypes();

Retrieves all direct and indirect subtypes of the EntityType.

Returns

Stream<EntityType>

Retrieve all instances of this EntityType

type.asRemote(Transaction tx).getInstances();

Retrieves all direct and indirect 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.asRemote(tx).create();

Creates and returns a new instance of this EntityType.

Returns

Entity

Set supertype

entityType.asRemote(tx).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.asRemote(tx).getSubtypes()

Retrieves all direct and indirect subtypes of the EntityType.

Returns

Stream of EntityType

Retrieve all instances of this EntityType

type.asRemote(tx).getInstances()

Retrieves all direct and indirect Entity objects that are instances of this Type.

Returns

Stream of Entity

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.as_remote(tx).create()

Creates and returns a new instance of this EntityType.

Returns

Entity

Set supertype

entity_type.as_remote(tx).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.as_remote(tx).get_subtypes()

Retrieves all direct and indirect subtypes of the EntityType.

Returns

Iterator of EntityType

Retrieve all instances of this EntityType

type.as_remote(tx).get_instances()

Retrieves all direct and indirect 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.asRemote(Transaction tx).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

attributeType.asRemote(Transaction tx).getSubtypes();

Retrieves all direct and indirect subtypes of the AttributeType.

Returns

Stream<AttributeType>

Retrieve all instances of this AttributeType

attributeType.asRemote(Transaction tx).getInstances();

Retrieves all direct and indirect Attributes that are instances of this Type.

Returns

Stream<Attribute>

Retrieve direct and inherited owners of this Type of Attribute

attributeType.asRemote(Transaction tx).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>

Retrieve direct owners of this Type of Attribute

attributeType.asRemote(Transaction tx).getOwnersExplicit(boolean onlyKey);

Retrieve all Things that directly 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

attributeType.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

attributeType.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

attributeType.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

attributeType.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

attributeType.isDateTime();

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

[tab:end] [tab:Javascript]

Retrieve valuetype (Local)

attributeType.valueType;

Retrieves the valuetype of this AttributeType.

Returns

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

Set supertype

attributeType.asRemote(tx).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

attributeType.asRemote(tx).getSubtypes()

Retrieves all direct and indirect subtypes of the AttributeType.

Returns

Retrieve all instances of this AttributeType

attributeType.asRemote(tx).getInstances()

Retrieves all direct and indirect Attributes that are instances of this Type.

Returns

Stream of Attribute

Retrieve direct and inherited owners of this Type of Attribute

attributeType.asRemote(tx).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

Stream of Thing

Retrieve direct owners of this Type of Attribute

attributeType.asRemote(tx).getOwnersExplicit(onlyKey)

Retrieve all Things that directly 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 of Thing

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

attributeType.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

attributeType.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

attributeType.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

attributeType.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

attributeType.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.as_remote(tx).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

attributeType.as_remote(tx).get_subtypes()

Retrieves all direct and indirect subtypes of the AttributeType.

Returns

Iterator of AttributeType

Retrieve all instances of this AttributeType

attributeType.as_remote(tx).get_instances()

Retrieves all direct and indirect Attributes that are instances of this Type.

Returns

Iterator of Attribute

Retrieve direct and inherited owners of this Type of Attribute

attributeType.as_remote(tx).get_owners(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

Retrieve direct owners of this Type of Attribute

attribute_type.as_remote(tx).get_owners_explicit(only_key)

Retrieve all Things that directly 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

attributeType.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

attributeType.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

attributeType.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

attributeType.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

attributeType.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.asRemote(Transaction tx).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.asRemote(Transaction tx).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

booleanAttributeType.asRemote(Transaction tx).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

booleanAttributeType.asRemote(Transaction tx).getSubtypes();

Retrieves all direct and indirect subtypes of the BooleanAttributeType.

Returns

Stream<AttributeType.Boolean>

Retrieve all instances of this BooleanAttributeType

booleanAttributeType.asRemote(Transaction tx).getInstances();

Retrieves all direct and indirect BooleanAttributes that are instances of this Type.

Returns

Stream<BooleanAttribute>

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.asRemote(tx).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.asRemote(tx).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

booleanAttributeType.asRemote(tx).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

booleanAttributeType.asRemote(tx).getSubtypes()

Retrieves all direct and indirect subtypes of the BooleanAttributeType.

Returns

Stream of BooleanAttributeType>

Retrieve all instances of this BooleanAttributeType

booleanAttributeType.asRemote(tx).getInstances()

Retrieves all direct and indirect BooleanAttributes that are instances of this Type.

Returns

Stream of BooleanAttribute

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.as_remote(tx).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.as_remote(tx).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

booleanAttributeType.as_remote(tx).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

booleanAttributeType.as_remote(tx).get_subtypes()

Retrieves all direct and indirect subtypes of the BooleanAttributeType.

Returns

Iterator of BooleanAttributeType

Retrieve all instances of this BooleanAttributeType

booleanAttributeType.as_remote(tx).get_instances()

Retrieves all direct and indirect 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.asRemote(Transaction tx).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.asRemote(Transaction tx).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.asRemote(Transaction tx).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.asRemote(Transaction tx).getSubtypes();

Retrieves all direct and indirect subtypes of the LongAttributeType.

Returns

Stream<AttributeType.Long>

Retrieve all instances of this LongAttributeType

type.asRemote(Transaction tx).getInstances();

Retrieves all direct and indirect 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.asRemote(tx).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.asRemote(tx).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.asRemote(tx).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.asRemote(tx).getSubtypes()

Retrieves all direct and indirect subtypes of the LongAttributeType.

Returns

Stream of LongAttributeType

Retrieve all instances of this LongAttributeType

type.asRemote(tx).getInstances()

Retrieves all direct and indirect LongAttributes that are instances of this Type.

Returns

Stream of LongAttribute>

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.as_remote(tx).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.as_remote(tx).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.as_remote(tx).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.as_remote(tx).get_subtypes()

Retrieves all direct and indirect subtypes of the LongAttributeType.

Returns

Iterator of LongAttributeType

Retrieve all instances of this LongAttributeType

type.as_remote(tx).get_instances()

Retrieves all direct and indirect 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.asRemote(Transaction tx).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.asRemote(Transaction tx).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.asRemote(Transaction tx).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.asRemote(Transaction tx).getSubtypes();

Retrieves all direct and indirect subtypes of the DoubleAttributeType.

Returns

Stream<AttributeType.Double>

Retrieve all instances of this DoubleAttributeType

type.asRemote(Transaction tx).getInstances();

Retrieves all direct and indirect 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.asRemote(tx).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.asRemote(tx).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.asRemote(tx).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.asRemote(tx).getSubtypes()

Retrieves all direct and indirect subtypes of the DoubleAttributeType.

Returns

Stream of DoubleAttributeType>

Retrieve all instances of this DoubleAttributeType

type.asRemote(tx).getInstances()

Retrieves all direct and indirect DoubleAttributes that are instances of this Type.

Returns

Stream of DoubleAttribute>

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.as_remote(tx).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.as_remote(tx).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.as_remote(tx).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.as_remote(tx).get_subtypes()

Retrieves all direct and indirect subtypes of the DoubleAttributeType.

Returns

Iterator of DoubleAttributeType

Retrieve all instances of this DoubleAttributeType

type.as_remote(tx).get_instances()

Retrieves all direct and indirect 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.asRemote(Transaction tx).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.asRemote(Transaction tx).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.asRemote(Transaction tx).getRegex();

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

Returns

string

null

Set regex

stringAttributeType.asRemote(Transaction tx).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.asRemote(Transaction tx).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.asRemote(Transaction tx).getSubtypes();

Retrieves all direct and indirect subtypes of the StringAttributeType.

Returns

Stream<AttributeType.String>

Retrieve all instances of this StringAttributeType

type.asRemote(Transaction tx).getInstances();

Retrieves all direct and indirect 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.asRemote(tx).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.asRemote(tx).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.asRemote(tx).getRegex();

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

Returns

string

None

Set regex

await stringAttributeType.asRemote(tx).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.asRemote(tx).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.asRemote(tx).getSubtypes()

Retrieves all direct and indirect subtypes of the StringAttributeType.

Returns

Stream of StringAttributeType

Retrieve all instances of this StringAttributeType

type.asRemote(tx).getInstances()

Retrieves all direct and indirect StringAttributes that are instances of this Type.

Returns

Stream of StringAttribute

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.as_remote(tx).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.as_remote(tx).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.as_remote(tx).get_regex()

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

Returns

string

null

Set regex

string_attribute_type.as_remote(tx).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.as_remote(tx).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.as_remote(tx).get_subtypes()

Retrieves all direct and indirect subtypes of the StringAttributeType.

Returns

Iterator of StringAttributeType

Retrieve all instances of this StringAttributeType

type.as_remote(tx).get_instances()

Retrieves all direct and indirect 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.asRemote(Transaction tx).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.asRemote(Transaction tx).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.asRemote(Transaction tx).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.asRemote(Transaction tx).getSubtypes();

Retrieves all direct and indirect subtypes of the DateTimeAttributeType.

Returns

Stream<AttributeType.DateTime>

Retrieve all instances of this DateTimeAttributeType

type.asRemote(Transaction tx).getInstances();

Retrieves all direct and indirect DateTimeAttributes that are instances of this Type.

Returns

Stream<DateTimeAttribute>

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.asRemote(tx).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.asRemote(tx).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.asRemote(tx).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.asRemote(tx).getSubtypes()

Retrieves all direct and indirect subtypes of the DateTimeAttributeType.

Returns

Stream of DateTimeAttributeType

Retrieve all instances of this DateTimeAttributeType

type.asRemote(tx).getInstances()

Retrieves all direct and indirect DateTimeAttributes that are instances of this Type.

Returns

Stream of DateTimeAttribute>

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.as_remote(tx).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.as_remote(tx).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.as_remote(tx).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.as_remote(tx).get_subtypes()

Retrieves all direct and indirect subtypes of the DateTimeAttributeType.

Returns

Iterator of DateTimeAttributeType

Retrieve all instances of this DateTimeAttributeType

type.as_remote(tx).get_instances()

Retrieves all direct and indirect 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.asRemote(Transaction tx).create();

Creates and returns an instance of this RelationType.

Returns

Relation

Retrieve roles

relationType.asRemote(Transaction tx).getRelates();

Retrieve roles that this RelationType relates to directly or via inheritance.

Returns

Stream<RoleType>

Retrieve direct roles

relationType.asRemote(Transaction tx).getRelatesExplicit();

Retrieve roles that this RelationType relates to directly.

Returns

Stream<RoleType>

Retrieve specific role

relationType.asRemote(Transaction tx).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.asRemote(Transaction tx).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.asRemote(Transaction tx).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.asRemote(Transaction tx).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.asRemote(Transaction tx).getSubtypes();

Retrieves all direct and indirect subtypes of the RelationType.

Returns

Stream<RelationType>

Retrieve all instances of this RelationType

type.asRemote(Transaction tx).getInstances();

Retrieves all direct and indirect 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.asRemote(tx).create();

Creates and returns an instance of this RelationType.

Returns

Relation

Retrieve roles

relationType.asRemote(tx).getRelates();

Retrieve roles that this RelationType relates to directly or via inheritance.

Returns

Stream of RoleType

Retrieve direct roles

relationType.asRemote(tx).getRelatesExplicit();

Retrieve roles that this RelationType relates to directly.

Returns

Stream of RoleType

Retrieve specific role

await relationType.asRemote(tx).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.asRemote(tx).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.asRemote(tx).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.asRemote(tx).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.asRemote(tx).getSubtypes()

Retrieves all direct and indirect subtypes of the RelationType.

Returns

Stream<RelationType>

Retrieve all instances of this RelationType

type.asRemote(tx).getInstances()

Retrieves all direct and indirect Relations that are instances of this Type.

Returns

Stream of Relation>

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.as_remote(tx).create()

Creates and returns an instance of this RelationType.

Returns

Relation

Retrieve roles

relation_type.as_remote(tx).get_relates()

Retrieve roles that this RelationType relates to directly or via inheritance.

Returns

Iterator of RoleType

Retrieve direct roles

relation_type.as_remote(tx).get_relates_explicit()

Retrieve roles that this RelationType relates to directly.

Returns

Iterator of RoleType

Retrieve specific role

relation_type.as_remote(tx).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.as_remote(tx).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.as_remote(tx).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.as_remote(tx).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.as_remote(tx).get_subtypes()

Retrieves all direct and indirect subtypes of the RelationType.

Returns

Iterator of RelationType

Retrieve all instances of this RelationType

type.as_remote(tx).get_instances()

Retrieves all direct and indirect 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.asRemote(Transaction tx).getSupertype();

Retrieves the most immediate supertype of the role type.

Returns

null

Retrieve all supertypes

type.asRemote(Transaction tx).getSupertypes();

Retrieves all supertypes of the role type.

Returns

Stream<RoleType>

Retrieve all subtypes

type.asRemote(Transaction tx).getSubtypes();

Retrieves all direct and indirect subtypes of the type.

Returns

Stream<RoleType>

Retrieve relation

role.asRemote(Transaction tx).getRelationType();

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

Returns

RelationType>

Retrieve relation types

role.asRemote(Transaction tx).getRelationTypes();

Retrieves the RelationTypes that this role is related to.

Returns

Stream<RelationType>

Retrieve role players

role.asRemote(Transaction tx).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.label.scope;

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

Returns

String

Retrieve scoped label (Local)

roleType.label.scopedName;

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

Returns

String

Retrieve direct supertype

await type.asRemote(tx).getSupertype();

Retrieves the most immediate supertype of the role type.

Returns

null

Retrieve all supertypes

type.asRemote(tx).getSupertypes()

Retrieves all supertypes of the role type.

Returns

Retrieve all subtypes

type.asRemote(tx).getSubtypes()

Retrieves all direct and indirect subtypes of the type.

Returns

Retrieve relation

await role.asRemote(tx).getRelationType();

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

Returns

RelationType

Retrieve relation types

await role.asRemote(tx).getRelationTypes();

Retrieves the RelationTypes that this role is related to.

Returns

Stream of RelationType

Retrieve role players

await role.asRemote(tx).getPlayers();

Retrieves the ThingTypes whose instances play this role.

Returns

Stream of ThingType

[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.as_remote(tx).get_supertype()

Retrieves the most immediate supertype of the role type.

Returns