gov.nasa.arc.brahms.common.rt
Interface ICreateObjectActivityCtx

All Superinterfaces:

IActivityCtx, IBrahmsObjectCtx, IPrimitiveActivityCtx

All Known Implementing Classes:

CreateObjectActivityCtx, VMCreateObjectActivityCtx

public interface ICreateObjectActivityCtx
extends IPrimitiveActivityCtx

The ICreateObjectActivityCtx interface is the interface for create object activity contexts. A CreateObjectActivityCtx maintains the context of a create object activity being or to be executed by an active instance. The context maintains the start and end times for an activity, the duration, priority, status, randomness, duration, resources, source object, destination object, name and location of the destination object, aggregate conceptual instances, the action and when the action is to take place.

Version:

29 November 1999

Author:

Ron van Hoof

Method Summary

void	addBoundVariable(VariableCtx var) Adds the specified variable as a variable bound by this activity.
ParameterCtx	getAction() Returns the create object's action (NEW or COPY).
java.util.Enumeration	getBoundVariables() Returns a list of all the variables used by this activity.
ParameterCtx	getDestination() Returns the create object's destination object or class.
java.util.Enumeration	getDestinationAggregates() Returns a list of all the destination aggregates (ParameterCtx).
ParameterCtx	getDestinationLocation() Returns the location for the created object.
ParameterCtx	getDestinationName() Returns the name for the created object.
ParameterCtx	getSource() Returns the create object's source object or class.
ParameterCtx	getWhen() Returns when the create object action is to take place (start or end).
void	removeBoundVariable(VariableCtx var) Removes the specified variable as a variable bound by this activity.

Methods inherited from interface gov.nasa.arc.brahms.common.rt.IPrimitiveActivityCtx

addResource, getDuration, getElapsedTime, getMaxDuration, getMinDuration, getRandom, getResourceCount, getResources, removeResource, setElapsedTime

Methods inherited from interface gov.nasa.arc.brahms.common.rt.IActivityCtx

getCompletionCause, getDisplayText, getParentFrame, getPerformedBy, getPriority, getReferencedBy, getStatus, setCompletionCause, setDisplayText, setParentFrame, setPerformedBy, setReferencedBy, setStatus

Methods inherited from interface gov.nasa.arc.brahms.common.rt.IBrahmsObjectCtx

addNote, getContextFor, getEndTime, getID, getNote, getNotes, getStartTime, removeNote, setEndTime, setID, setStartTime

Method Detail

getAction

ParameterCtx getAction()
                       throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns the create object's action (NEW or COPY). The action is specified through a parameter context containing either the actual value (int) or a reference to a variable containing the value.

Returns:

ParameterCtx the action

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no action is specified

getWhen

ParameterCtx getWhen()
                     throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns when the create object action is to take place (start or end). The when value is set through a parameter context containing either the actual value (int) or a reference to a variable containing the when value.

Returns:

ParameterCtx the when value defining when the create object action is to occur

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if the when value is not defined

getSource

ParameterCtx getSource()
                       throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns the create object's source object or class. The source is specified through a parameter context containing either the actual value (ConceptCtx) or a reference to a variable containing the value.

Returns:

ParameterCtx the source

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no source is specified

getDestination

ParameterCtx getDestination()
                            throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns the create object's destination object or class. The destination is specified through a parameter context containing either the actual value (ConceptCtx) or a reference to a variable containing the value.

Returns:

ParameterCtx the destination

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no destination is specified

getDestinationName

ParameterCtx getDestinationName()
                                throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns the name for the created object. The destination name is specified through a parameter context containing either the actual value (String) or a reference to a variable containing the value.

Returns:

ParameterCtx the destination name

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no destination name is specified

getDestinationLocation

ParameterCtx getDestinationLocation()
                                    throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns the location for the created object. The destination location is specified through a parameter context containing either the actual value (AreaCtx) or a reference to a variable containing the value.

Returns:

ParameterCtx the destination location

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no destination location is specified

getDestinationAggregates

java.util.Enumeration getDestinationAggregates()
                                               throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns a list of all the destination aggregates (ParameterCtx).

Returns:

Enumeration an enumeration of ParameterCtx referencing ConceptualInstanceCtx's

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if there are no aggregates

addBoundVariable

void addBoundVariable(VariableCtx var)
                      throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Adds the specified variable as a variable bound by this activity.

Parameters:

var - the variable (VariableCtx) to be added

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if var is null

removeBoundVariable

void removeBoundVariable(VariableCtx var)
                         throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Removes the specified variable as a variable bound by this activity.

Parameters:

var - the variable (VariableCtx) to be removed

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if variable is null, no variables are present, or the variable is not found

getBoundVariables

java.util.Enumeration getBoundVariables()
                                        throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns a list of all the variables used by this activity.

Returns:

Enumeration an enumeration of VariableCtx

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if there are no variables