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.


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.lang.String getName()
          Returns the fully qualified name of the concept
 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.
 boolean isLocal()
          Indicates whether the concept is loaded locally or remotely.
 
Methods inherited from interface gov.nasa.arc.brahms.vm.api.common.IType
getType
 

Method Detail

getName

java.lang.String getName()
                         throws ExternalException
Returns the fully qualified name of the concept

Returns:
String the fully qualified name of the concept
Throws:
ExternalException - if an internal error occurs

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.

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

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