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

All Superinterfaces:

IActivityCtx, IBrahmsObjectCtx, IPrimitiveActivityCtx

All Known Subinterfaces:

ICommunicateActivityCtx

All Known Implementing Classes:

BroadcastActivityCtx, CommunicateActivityCtx, VMBroadcastActivityCtx, VMCommunicateActivityCtx

public interface IBroadcastActivityCtx
extends IPrimitiveActivityCtx

The IBroadcastActivityCtx interface is the interface for broadcast activity contexts. A BroadcastActivityCtx maintains the context of a broadcast 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, with whom or what the broadcast is with, what the communication is about, the type of communication and when the communication is to occur during the activity. The virtual machine determines with whom or what the communication of the broadcast is with.

Version:

28 March 2000

Author:

Ron van Hoof

Method Summary

java.util.Enumeration	getAbout() Returns the transfer definitions specifying the information that was communicated in the activity.
ParameterCtx	getType() Returns the communication type (face 2 face, e-mail, etc).
ParameterCtx	getWhen() Returns when the communication is to take place (start or end).
java.util.Enumeration	getWith() Returns the active instances with which is to be communicated.

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

getType

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

Returns the communication type (face 2 face, e-mail, etc). The type is set through a parameter context containing either the actual value or a reference to a variable containing the type value.

Returns:

ParameterCtx the communication type

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no type is defined

getWhen

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

Returns when the communication 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 communication is to occur

Throws:

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

getWith

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

Returns the active instances with which is to be communicated.

Returns:

Enumeration the ParametersCtx's referencing the ActiveInstanceCtx to communicate with

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no active instances are specified

getAbout

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

Returns the transfer definitions specifying the information that was communicated in the activity.

Returns:

Enumeration the communicated TransferDefinitionCtx

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if no transfer definitions are specified