gov.nasa.arc.brahms.vm.data
Interface IVMInstance

All Known Implementing Classes:

VMAgent, VMArea, VMConceptualInstance, VMObjectInstance, VMPath

public interface IVMInstance

The IVMInstance interface tags a concept as being an instance like concept, an agent, object, area, or conceptual object.

Version:

$Revision: 1.1 $ $Date: 2009/11/23 18:41:02 $ $Author: rnado $

Author:

Ron van Hoof

Method Summary

IConceptCtx	getContext() Returns the concept's context used in a virtual machine.
java.lang.String	getFullyQualifiedName() Returns the instance's fully qualified name.
java.lang.String	getID() Returns the unique identifier of the BrahmsObject.
java.lang.String	getName() Returns the instance's name.
boolean	isDynamic() Indicates whether the Brahms model element was created dynamically at runtime or was created at design time.
boolean	isLocal() Returns whether the concept is loaded locally or remotely in another virtual machine.
boolean	isSerializable() Indicates whether this instance is serializable.
void	setDynamic(boolean dynamic) Sets whether the Brahms model element was created dynamically at runtime or was created at design time.
void	setSerializable(boolean serializable) Sets whether this instance is serializable.

Method Detail

getID

java.lang.String getID()

Returns the unique identifier of the BrahmsObject.

Returns:

String the unique identifier, null if no identifier is set.

getName

java.lang.String getName()

Returns the instance's name.

Returns:

String the name

getFullyQualifiedName

java.lang.String getFullyQualifiedName()

Returns the instance's fully qualified name.

Returns:

String the fully qualified name

setDynamic

void setDynamic(boolean dynamic)

Sets whether the Brahms model element was created dynamically at runtime or was created at design time.

Parameters:

dynamic - true if the object was created at runtime, false if it was created at design time.

isDynamic

boolean isDynamic()

Indicates whether the Brahms model element was created dynamically at runtime or was created at design time.

Returns:

boolean true if the object was created at runtime, false if it was created at design time.

isLocal

boolean isLocal()

Returns whether the concept is loaded locally or remotely in another virtual machine.

Returns:

boolean true if the concept is loaded locally, false if remotely

setSerializable

void setSerializable(boolean serializable)

Sets whether this instance is serializable.

Parameters:

serializable - true if serializable

isSerializable

boolean isSerializable()

Indicates whether this instance is serializable.

Returns:

boolean true if serializable

getContext

IConceptCtx getContext()

Returns the concept's context used in a virtual machine.

Returns:

IConceptCtx the concept's context