Relationship (Common API)

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

Relationship

A Relationship is a typed pointer to an instance. I.e the relationship with namespace = 'org.acme', type = 'Vehicle' and id = 'ABC' creates a pointer that points at an instance of org.acme.Vehicle with the id ABC.

Details

  • Extends Identifiable

  • Module common

See also

  • See (see {@link identifiable)

Method Summary

Name Returns Description
fromURI Relationship Contructs a Relationship instance from a URI representation (created using toURI).
isRelationship boolean Determine if this identifiable is a relationship.
toString String Returns the string representation of this class

Method Details

toString

String toString( )

Returns the string representation of this class

Returns

String - the string representation of the class

Parameters

No parameters

isRelationship

boolean isRelationship( )

Determine if this identifiable is a relationship.

Returns

boolean - True if this identifiable is a relationship, false if not.

Parameters

No parameters

fromURI

Relationship fromURI( ModelManager modelmanager, String uriasstring, [String defaultnamespace], [String defaulttype] )

Contructs a Relationship instance from a URI representation (created using toURI).

Returns

Relationship - the relationship

Parameters

Name Type Optional Description
modelManager ModelManager false the model manager to bind the relationship to
uriAsString String false the URI as a string, generated using Identifiable.toURI()
defaultNamespace String true default namespace to use for backwards compatability (optional)
defaultType String true default type to use for backwards compatability (optional)