org.marketcetera.ors
Interface OrderInfo

All Known Implementing Classes:

OrderInfoBase, SimpleOrderInfo

public interface OrderInfo

An entry for order information in a OrderInfoCache cache.

Since:

2.1.0

Version:

$Id: OrderInfo.java 16154 2012-07-14 16:34:05Z colin $

Author:

tlerios@marketcetera.com

Method Summary

UserID	getActorID() Returns the actor ID of the receiver's order.
OrderID	getOrderID() Returns the ID of the receiver's order.
OrderID	getOrigOrderID() Returns the parent order ID of the receiver's order.
UserID	getViewerID() Returns the viewer ID of the receiver's order.
boolean	isViewerIDSet() Checks whether the viewer ID of the receiver's order has been set.
void	setAckExpected(boolean ackExpected) Sets to the given value a flag indicating whether the ORS is expected to issue an ack for the receiver's order.
void	setAckProcessed(boolean ackProcessed) Sets to the given value a flag indicating whether the ORS has retrieved the ack principals for the receiver's order.
void	setERPersisted(boolean erPersisted) Sets to the given value a flag indicating whether an execution report (ack, or broker response) for the receiver's order has been persisted.
void	setMessageProcessed(Message msg) Notifies the receiver that the given message has been processed.
void	setResponseExpected(boolean responseExpected) Sets to the given value a flag indicating whether the ORS is expected to receive a response to the receiver's order.
void	setResponseProcessed(boolean responseProcessed) Sets to the given value a flag indicating whether the ORS has retrieved the response principals for the receiver's order.
void	setViewerID(UserID viewerID) Sets the viewer ID of the receiver's order to the given one.

Method Detail

getOrderID

OrderID getOrderID()

Returns the ID of the receiver's order.

Returns:

The ID.

getOrigOrderID

OrderID getOrigOrderID()

Returns the parent order ID of the receiver's order.

Returns:

The ID. It may be null if the receiver's order is a chain root.

getActorID

UserID getActorID()

Returns the actor ID of the receiver's order.

Returns:

The ID.

isViewerIDSet

boolean isViewerIDSet()

Checks whether the viewer ID of the receiver's order has been set. Specifically, false indicates unknown-at-present (to be lazily researched when needed) and, until that time, getViewerID() should not be used; true indicates that getViewerID() can be used.

Returns:

True if so.

getViewerID

UserID getViewerID()

Returns the viewer ID of the receiver's order. It should only be called after a call to setViewerID(UserID) (which may take place implicitly, in the constructor); accordingly, it is best to guard calls to this method with a call to isViewerIDSet().

Returns:

The ID. It may be null if we could not deduce a viewer.

setViewerID

void setViewerID(UserID viewerID)

Sets the viewer ID of the receiver's order to the given one.

Parameters:

viewerID - The ID. It may be null if we could not deduce a viewer.

setERPersisted

void setERPersisted(boolean erPersisted)

Sets to the given value a flag indicating whether an execution report (ack, or broker response) for the receiver's order has been persisted.

Parameters:

persisted - The flag.

setAckExpected

void setAckExpected(boolean ackExpected)

Sets to the given value a flag indicating whether the ORS is expected to issue an ack for the receiver's order.

Parameters:

ackExpected - The flag.

setAckProcessed

void setAckProcessed(boolean ackProcessed)

Sets to the given value a flag indicating whether the ORS has retrieved the ack principals for the receiver's order.

Parameters:

ackProcessed - The flag.

setResponseExpected

void setResponseExpected(boolean responseExpected)

Sets to the given value a flag indicating whether the ORS is expected to receive a response to the receiver's order.

Parameters:

responseExpected - The flag.

setResponseProcessed

void setResponseProcessed(boolean responseProcessed)

Sets to the given value a flag indicating whether the ORS has retrieved the response principals for the receiver's order.

Parameters:

responseProcessed - The flag.

setMessageProcessed

void setMessageProcessed(Message msg)

Notifies the receiver that the given message has been processed.

Parameters:

msg - The message.