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

All Superinterfaces:

IActivityCtx, IBrahmsObjectCtx, IPrimitiveActivityCtx

All Known Subinterfaces:

IGetActivityCtx, IPutActivityCtx

All Known Implementing Classes:

ContainmentActivityCtx, GetActivityCtx, PutActivityCtx, VMContainmentActivityCtx, VMGetActivityCtx, VMPutActivityCtx

public interface IContainmentActivityCtx
extends IPrimitiveActivityCtx

The IContainmentActivityCtx interface is the generic interface for the IGetActivityCtx and IPutActivityCtx interfaces.

Version:

29 May 2001

Author:

Ron van Hoof

Method Summary

void	addItem(ParameterCtx item) Adds the specified item as an item picked up or dropped off through this activity.
int	getItemCount() Return the number of items associated with the activity.
java.util.Enumeration	getItems() Returns a list of all the items (ParameterCtx).
ParameterCtx	getWhen() Returns when the pick-up or drop off of items specified in the activity is to take place (start or end).
void	removeItem(ParameterCtx item) Removes the specified item as an item picked up or dropped off through 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

addItem

void addItem(ParameterCtx item)
             throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Adds the specified item as an item picked up or dropped off through this activity. The actual item is the agent or object referenced by the parameter context where the parameter context specifies when the item was associated with the activity.

Parameters:

item - the item (ParameterCtx) to be added

Throws:

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

removeItem

void removeItem(ParameterCtx item)
                throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Removes the specified item as an item picked up or dropped off through this activity. The actual item is the agent or object referenced by the parameter context where the parameter context specifies when the item was (dis)associated with the activity.

Parameters:

item - the item (ParameterCtx) to be removed

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if item is null, no items are available, or the item is not found

getItems

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

Returns a list of all the items (ParameterCtx).

Returns:

Enumeration an enumeration of ParameterCtx

Throws:

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

getItemCount

int getItemCount()

Return the number of items associated with the activity.

Returns:

int the number of items

getWhen

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

Returns when the pick-up or drop off of items specified in the activity is to take place (start or end). The when value is set through a parameter context containing either the actual value or a reference to a variable containing the when value.

Returns:

ParameterCtx the when value defining when the activity's action is to take place

Throws:

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