gov.nasa.arc.brahms.vm.api.common
Interface IConcept

All Superinterfaces:

IType, IUserDefinedType

All Known Subinterfaces:

IActiveClass, IActiveConcept, IActiveInstance, IAgent, IArea, IAreaDef, IClass, IConceptualClass, IConceptualConcept, IConceptualObject, ICurrent, IGeographyConcept, IGroup, IObject, IPath

public interface IConcept
extends IUserDefinedType

The IConcept interface is an interface to a concept loaded in the virtual machine. This interface is only a high level interface for the actual concepts. Check the sub interfaces of this interface to find out the interfaces for the various types of concepts.

Version:

$Revision: 1.1 $ $Date: 2009/11/23 18:38:30 $ $Author: rnado $

Author:

Ron van Hoof

Field Summary

Fields inherited from interface gov.nasa.arc.brahms.vm.api.common.IUserDefinedType

UDT

Method Summary

IAttribute	getAttribute(java.lang.String name) Returns the attribute with the specified name if it is defined for this concept or any of its parent concepts in the concept inheritance hierarchy.
java.util.List<IAttribute>	getAttributes() Returns the attributes declared for this concept including the attributes declared in the parent concepts in the concept inheritance hierarchy.
IRelation	getRelation(java.lang.String name) Returns the relation with the specified nameif it is defined for this concept or any of its parent concepts in the concept inheritance hierarchy.
java.util.List<IRelation>	getRelations() Returns the relations declared for this concept including the relations declared in the parent concepts in the concept inheritance hierarchy.
boolean	isLocal() Indicates whether the concept is loaded locally or remotely.

Methods inherited from interface gov.nasa.arc.brahms.vm.api.common.IType

getName, getType

Method Detail

isLocal

boolean isLocal()
                throws ExternalException

Indicates whether the concept is loaded locally or remotely.

Returns:

true if the concept is local, false it it is remote

Throws:

ExternalException - if an internal error occurs.

getAttributes

java.util.List<IAttribute> getAttributes()
                                         throws ExternalException

Returns the attributes declared for this concept including the attributes declared in the parent concepts in the concept inheritance hierarchy.

Returns:

List the attributes

Throws:

ExternalException - if there was a problem obtaining the list of attributes

getAttribute

IAttribute getAttribute(java.lang.String name)
                        throws ExternalException

Returns the attribute with the specified name if it is defined for this concept or any of its parent concepts in the concept inheritance hierarchy.

Parameters:

name - the name of the requested attribute

Returns:

IAttribute the attribute

Throws:

ExternalException - if no attribute with the specified name is defined for this concept

getRelations

java.util.List<IRelation> getRelations()
                                       throws ExternalException

Returns the relations declared for this concept including the relations declared in the parent concepts in the concept inheritance hierarchy.

Returns:

List the relations

Throws:

ExternalException - if there was a problem obtaining the list of relations

getRelation

IRelation getRelation(java.lang.String name)
                      throws ExternalException

Returns the relation with the specified nameif it is defined for this concept or any of its parent concepts in the concept inheritance hierarchy.

Parameters:

name - the name of the requested attribute

Returns:

IAttribute the attribute

Throws:

ExternalException - if no attribute with the specified name is defined for this concept