org.marketcetera.trade.Report Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of trade-api Show documentation
The newest version!
package org.marketcetera.trade;

import java.util.Date;

import org.marketcetera.admin.User;

import quickfix.SessionID;

/* $License$ */

/**
 * Represents a report object received as part of a trade flow.
 *
 * @author Colin DuPlantis
 * @version $Id$
 * @since $Release$
 */
public interface Report
{
    /**
     * Gets the actor id of the report.
     *
     * @return a UserID value or null
     */
    UserID getActorID();
    /**
     * Gets the viewer id of the report.
     *
     * @return a UserID value or null
     */
    UserID getViewerID();
    /**
     * Get the orderID value.
     *
     * @return an OrderID value
     */
    OrderID getOrderID();
    /**
     * Get the actor value.
     *
     * @return a User value
     */
    User getActor();
    /**
     * Get the viewer value.
     *
     * @return a User value
     */
    User getViewer();
    /**
     * Get the fixMessage value.
     *
     * @return a String value
     */
    String getFixMessage();
    /**
     * Get the sessionId value.
     *
     * @return a SessionID value
     */
    SessionID getSessionId();
    /**
     * Get the msgSeqNum value.
     *
     * @return an int value
     */
    int getMsgSeqNum();
    /**
     * Get the sendingTime value.
     *
     * @return a Date value
     */
    Date getSendingTime();
    /**
     * Get the transactTime value.
     *
     * @return a Date value
     */
    Date getTransactTime();
    /**
     * Get the reportType value.
     *
     * @return a ReportType value
     */
    ReportType getReportType();
    /**
     * Get the brokerID value.
     *
     * @return a BrokerID value
     */
    BrokerID getBrokerID();
    /**
     * Get the reportID value.
     *
     * @return a ReportID value
     */
    ReportID getReportID();
    /**
     * Get the originator value.
     *
     * @return an Originator value
     */
    Originator getOriginator();
    /**
     * Get the hierarchy value.
     *
     * @return a Hierarchy value
     */
    Hierarchy getHierarchy();
    /**
     * Get the text value.
     *
     * @return a String value
     */
    String getText();
}