Identifiable (Common API)

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

Identifiable

Identifiable is an entity with a namespace, type and an identifier.

This class is abstract.

Details

  • Module common

See also

Method Summary

Name Returns Description
getFullyQualifiedIdentifier string Get the fully qualified identifier of this instance. (namespace '.' type '#' identifier).
getIdentifier string Get the identifier of this instance
isRelationship boolean Determine if this identifiable is a relationship.
isResource boolean Determine if this identifiable is a resource.
setIdentifier void Set the identifier of this instance
toString String Returns the string representation of this class
toURI String Returns a URI representation of a reference to this identifiable

Method Details

getIdentifier

string getIdentifier( )

Get the identifier of this instance

Returns

string - The identifier for this object

Parameters

No parameters

setIdentifier

void setIdentifier( string id )

Set the identifier of this instance

Parameters

Name Type Optional Description
id string false the new identifier for this object

getFullyQualifiedIdentifier

string getFullyQualifiedIdentifier( )

Get the fully qualified identifier of this instance. (namespace '.' type '#' identifier).

Returns

string - the fully qualified identifier of this instance

Parameters

No parameters

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

isResource

boolean isResource( )

Determine if this identifiable is a resource.

Returns

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

Parameters

No parameters

toURI

String toURI( )

Returns a URI representation of a reference to this identifiable

Returns

String - the URI for the identifiable

Parameters

No parameters