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

All Superinterfaces:

IBrahmsObjectCtx

All Known Implementing Classes:

DeleteCtx, VMDeleteCtx

public interface IDeleteCtx
extends IBrahmsObjectCtx

The IDeleteCtx is the interface for delete contexts defining the context for an executed delete operation. It defines the delete operation that was executed, what frame executed the operation and defines what element(s) was/were marked for deletion.

Version:

$Revision: 1.2 $ $Date: 2009/11/23 19:12:22 $ $Author: rnado $

Author:

Ron van Hoof

Method Summary

void	addDeletedElement(java.lang.Object elm) Adds the specified element (agent, object, conceptual object, or monitored Java object) as an element marked for deletion.
java.util.List<java.lang.Object>	getDeletedElements() Returns a list of all the elements deleted by this delete operation.
IFrameCtx	getParent() Returns the parent frame context in which this delete operation was executed.
IVariableCtx	getUsedVariable() Returns the variable used by this delete operation.
boolean	hasDeletedElements() Indicates whether the context has any deleted elements in its list.
void	removeDeletedElement(java.lang.Object elm) Removes the specified element (agent, object, conceptual object, or monitored Java object) as an element marked for deletion.
void	setParent(IFrameCtx parent) Sets the parent frame context in which this delete operation was executed.
void	setUsedVariable(IVariableCtx var) Sets the specified variable as a variable used by this delete operation.

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

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

Method Detail

setParent

void setParent(IFrameCtx parent)
               throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Sets the parent frame context in which this delete operation was executed.

Parameters:

parent - the IFrameCtx

Throws:

gov.nasa.arc.brahms.common.exceptions.BrahmsException - if a null parent is specified

getParent

IFrameCtx getParent()
                    throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns the parent frame context in which this delete operation was executed.

Returns:

IFrameCtx the parent frame

Throws:

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

addDeletedElement

void addDeletedElement(java.lang.Object elm)
                       throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Adds the specified element (agent, object, conceptual object, or monitored Java object) as an element marked for deletion.

Parameters:

elm - the element to be added

Throws:

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

removeDeletedElement

void removeDeletedElement(java.lang.Object elm)
                          throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Removes the specified element (agent, object, conceptual object, or monitored Java object) as an element marked for deletion.

Parameters:

elm - the element to be removed

Throws:

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

getDeletedElements

java.util.List<java.lang.Object> getDeletedElements()
                                                    throws gov.nasa.arc.brahms.common.exceptions.BrahmsException

Returns a list of all the elements deleted by this delete operation.

Returns:

List