@accordproject/concerto-core
Version:
Core Implementation for the Concerto Modeling Language
73 lines (72 loc) • 2.44 kB
TypeScript
declare const Typed: any;
/**
* Identifiable is an entity with a namespace, type and an identifier.
* Applications should retrieve instances from {@link Factory}
* This class is abstract.
* @extends Typed
* @abstract
* @class
* @memberof module:concerto-core
*/
declare class Identifiable extends Typed {
/**
* Create an instance.
* <p>
* <strong>Note: Only to be called by framework code. Applications should
* retrieve instances from {@link Factory}</strong>
* </p>
*
* @param {ModelManager} modelManager - The ModelManager for this instance
* @param {ClassDeclaration} classDeclaration - The class declaration for this instance.
* @param {string} ns - The namespace this instance.
* @param {string} type - The type this instance.
* @param {string} id - The identifier of this instance.
* @param {string} timestamp - The timestamp of this instance
* @protected
*/
constructor(modelManager: any, classDeclaration: any, ns: any, type: any, id: any, timestamp: any);
/**
* Get the timestamp of this instance
* @return {string} The timestamp for this object
*/
getTimestamp(): any;
/**
* Get the identifier of this instance
* @return {string} The identifier for this object
*/
getIdentifier(): any;
/**
* Set the identifier of this instance
* @param {string} id - the new identifier for this object
*/
setIdentifier(id: any): void;
/**
* Get the fully qualified identifier of this instance.
* (namespace '.' type '#' identifier).
* @return {string} the fully qualified identifier of this instance
*/
getFullyQualifiedIdentifier(): any;
/**
* Returns the string representation of this class
* @return {String} the string representation of the class
*/
toString(): string;
/**
* Determine if this identifiable is a relationship.
* @return {boolean} True if this identifiable is a relationship,
* false if not.
*/
isRelationship(): boolean;
/**
* Determine if this identifiable is a resource.
* @return {boolean} True if this identifiable is a resource,
* false if not.
*/
isResource(): boolean;
/**
* Returns a URI representation of a reference to this identifiable
* @return {String} the URI for the identifiable
*/
toURI(): any;
}
export = Identifiable;