com.caplin.motif.fx.blotter

Class ContainerAction

java.lang.Object

com.caplin.motif.fx.blotter.ContainerAction

public class ContainerAction
extends Object

Instances of this object represent the action to be performed on a container.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContainerAction.ContainerActionType Enumeration of the possible actions that can be performed on a blotter item.

Constructor Summary

Constructors

Constructor and Description
ContainerAction(ContainerAction.ContainerActionType actionType, String itemId, String subject) Used to create a stand-alone action that is not yet linked to a specific message.
ContainerAction(ContainerAction.ContainerActionType actionType, String itemId, String subject, FXBlotterItemMessage message) Used when we want to perform an action on a specific message.

Method Summary

Modifier and Type	Method and Description
ContainerAction	copyOf(com.caplin.datasource.messaging.MessageFactory factory) Creates a deep copy of this container action.
boolean	equals(Object obj)
ContainerAction.ContainerActionType	getActionType() Gets the action type.
String	getItemId() Gets the item ID.
String	getItemSubject() Gets the item subject.
FXBlotterItemMessage	getMessage() Gets the message this action relates to, or null if no message was passed.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ContainerAction

public ContainerAction(ContainerAction.ContainerActionType actionType,
                       String itemId,
                       String subject)

Used to create a stand-alone action that is not yet linked to a specific message. Typically this is used for removes.

Parameters:

actionType - The type of action.

itemId - The ID of the item to perform the action on.

subject - The subject of the item to perform the action on.

ContainerAction

public ContainerAction(ContainerAction.ContainerActionType actionType,
                       String itemId,
                       String subject,
                       FXBlotterItemMessage message)

Used when we want to perform an action on a specific message.

Parameters:

actionType - The type of action.

itemId - The ID of the item to perform the action on.

subject - The subject of the item to perform the action on.

message - The message that this container action relates to.

Method Detail

getActionType

public ContainerAction.ContainerActionType getActionType()

Gets the action type.

Returns:

The action type.

getItemId

public String getItemId()

Gets the item ID.

Returns:

The item ID.

getItemSubject

public String getItemSubject()

Gets the item subject.

Returns:

The item subject.

getMessage

public FXBlotterItemMessage getMessage()

Gets the message this action relates to, or null if no message was passed.

Returns:

The message.

copyOf

public ContainerAction copyOf(com.caplin.datasource.messaging.MessageFactory factory)

Creates a deep copy of this container action.

Parameters:

factory - The message factory to use to create a copy of the message this container action relates to. If this container action was not instantiated with a message, you can safely pass null.

Returns:

A deep copy of the container action.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object