source: ccr/trunk/nhin-vista/projects/NHINC/Current/Product/Production/Gateway/AggregatorLib/src/gov/hhs/fha/nhinc/gateway/aggregator/model/AggMessageResult.java@ 507

package gov.hhs.fha.nhinc.gateway.aggregator.model;

import java.util.Date;

/**
 * This class represents one row of the AGGREGATOR.AGG_MESSAGE_RESULTS
 * SQL table.
 * 
 * @author Les Westberg
 */
public class AggMessageResult
{
    // Private member variables
    //--------------------------
    private String messageId;
    private String messageKey;
    private Date messageOutTime;
    private Date responseReceivedTime;
    private String responseMessageType;
    private String responseMessage;
    private AggTransaction aggTransaction;
    
    /**
     * Default constructor.
     */
    public AggMessageResult()
    {
        clear();
    }
    
    /**
     * Clear the contents of this object and set it to a default state.
     */
    private void clear()
    {
        messageId = "";
        messageKey = "";
        messageOutTime = null;
        responseReceivedTime = null;
        responseMessageType = "";
        responseMessage = "";
        aggTransaction = null;
    }

    /**
     * Returns the Message ID that uniquely identifies this row.  This is a UUID.
     * 
     * @return The message ID that uniquely identifies this row.
     */
    public String getMessageId()
    {
        return messageId;
    }

    /**
     * Sets the Message ID that uniquely identifies this row.  This is a UUID.
     * 
     * @param messageId The message ID that uniquely identifies this row.
     */
    public void setMessageId(String messageId)
    {
        this.messageId = messageId;
    }

    /**
     * Return the message key that we will use to match up the response that
     * is received.
     * 
     * @return The message key used to match up the response received.  This
     *         must be unique.   It is intended that this will be an XML string.
     */
    public String getMessageKey()
    {
        return messageKey;
    }

    /**
     * Sets the message key that we will use to match up the response that
     * is received.
     * 
     * @param messageKey  The message key used to match up the response received.  This
     *         must be unique.   It is intended that this will be an XML string.
     */
    public void setMessageKey(String messageKey)
    {
        this.messageKey = messageKey;
    }

    /**
     * Returns the date and time that the message went out.  This will be 
     * the same time as the TransactionStartTime in the agg_transaction table 
     * for this transaction.
     * 
     * @return The date and time that the message went out.
     */
    public Date getMessageOutTime()
    {
        return messageOutTime;
    }

    /**
     * Sets the date and time that the message went out.  This will be 
     * the same time as the TransactionStartTime in the agg_transaction table 
     * for this transaction.
     * 
     * @param messageOutTime  The date and time that the message went out.
     */
    public void setMessageOutTime(Date messageOutTime)
    {
        this.messageOutTime = messageOutTime;
    }

    /**
     * Returns the response message.  This will be the actual message that has
     * been marshalled to XML.  This is what will be aggregated.
     * 
     * @return The XML message that was received as a response to thie message
     *         that went out.
     */
    public String getResponseMessage()
    {
        return responseMessage;
    }

    /**
     * Sets the response message.  This will be the actual message that has
     * been marshalled to XML.  This is what will be aggregated.
     * 
     * @param responseMessage  The XML message that was received as a response to thie message
     *         that went out.
     */
    public void setResponseMessage(String responseMessage)
    {
        this.responseMessage = responseMessage;
    }

    /**
     * Returns the type of the response message.  This is the textual name of the
     * JAXB class that represents the XML string.
     * 
     * @return The type of the response message.
     */
    public String getResponseMessageType()
    {
        return responseMessageType;
    }

    /**
     * Sets the type of the response message.  This is the textual name of the
     * JAXB class that represents the XML string.
     * 
     * @param responseMessageType The type of the response message.
     */
    public void setResponseMessageType(String responseMessageType)
    {
        this.responseMessageType = responseMessageType;
    }

    /**
     * Returns the date and time that the response was received by the 
     * aggregator.
     * 
     * @return The date and time that the response was received by the
     *         aggregator.
     */
    public Date getResponseReceivedTime()
    {
        return responseReceivedTime;
    }

    /**
     * Sets the date and time that the response was received by the 
     * aggregator.
     * 
     * @param responseReceivedTime  The date and time that the response was received by the
     *         aggregator.
     */
    public void setResponseReceivedTime(Date responseReceivedTime)
    {
        this.responseReceivedTime = responseReceivedTime;
    }

    /**
     * Return the AggTransaction associated with the AggMessageResult.
     * 
     * @return The AggTransaction associated with the AggMessageResult.
     */
    public AggTransaction getAggTransaction()
    {
        return aggTransaction;
    }

    /**
     * Sets the AggTransaction associated with the AggMessageResult.
     * 
     * @param aggTransaction  The AggTransaction associated with the AggMessageResult.
     */
    public void setAggTransaction(AggTransaction aggTransaction)
    {
        this.aggTransaction = aggTransaction;
    }

    
}