org.lsst.ccs.subsystem.common.actions

Class MpmAction

java.lang.Object

org.lsst.ccs.subsystem.common.actions.MpmAction

All Implemented Interfaces:

Serializable

public class MpmAction
extends Object
implements Serializable

Manages the MPM alert action payload

Author:

saxton

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MpmAction.Action

Constructor Summary

Constructors

Constructor and Description
MpmAction(MpmAction.Action action) Constructor.

Method Summary

Modifier and Type	Method and Description
static void	addData(org.lsst.ccs.bus.data.Alert alert, MpmAction.Action action) Adds data to an alert
static String	getClientName() Gets the name of the client property.
static MpmAction.Action	getData(org.lsst.ccs.bus.data.Alert alert) Gets data from an alert.
static String	getManagerName() Gets the name of the manager property.
static String	getName() Gets the simple name of this class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MpmAction

public MpmAction(MpmAction.Action action)

Constructor.

Parameters:

action - The action to perform

Method Detail

getName

public static String getName()

Gets the simple name of this class.

Returns:

The name

getClientName

public static String getClientName()

Gets the name of the client property.

Returns:

The name

getManagerName

public static String getManagerName()

Gets the name of the manager property.

Returns:

The name

addData

public static void addData(org.lsst.ccs.bus.data.Alert alert,
                           MpmAction.Action action)

Adds data to an alert

Parameters:

alert - The alert

action - The action to perform

getData

public static MpmAction.Action getData(org.lsst.ccs.bus.data.Alert alert)

Gets data from an alert.

Parameters:

alert - The alert

Returns:

The action, or null if the alert doesn't contain MPM data