com.bloomberglp.blpapi.test

Class MessageProperties

java.lang.Object

com.bloomberglp.blpapi.test.MessageProperties

public final class MessageProperties
extends Object

This class represents properties of a message that are not part of the message contents, for example the CorrelationID, or timestamp.

Constructor Summary

Constructors

Constructor and Description
MessageProperties() Creates a MessageProperties with default values.

Method Summary

Modifier and Type	Method and Description
MessageProperties	setCorrelationId(CorrelationID correlationId) Equivalent to setCorrelationIds(java.util.List<com.bloomberglp.blpapi.CorrelationID>) with one CorrelationID.
MessageProperties	setCorrelationIds(List<CorrelationID> correlationIds) Sets the CorrelationID property.
MessageProperties	setRecapType(Message.Recap recapType, Message.Fragment fragmentType) Sets the Message.Recap and Message.Fragment properties.
MessageProperties	setRequestId(String requestId) Sets the requestId property.
MessageProperties	setService(Service service) Sets the service property.
MessageProperties	setTimeReceived(Datetime timeReceived) Sets the time received property.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageProperties

public MessageProperties()

Creates a MessageProperties with default values. Default value for CorrelationID property is an empty list. Default value for Message.Recap property is Message.Recap.NONE. Default value for Message.Fragment property is Message.Fragment.NONE. Default Value for Service, timeReceived or requestId is null.

Method Detail

setCorrelationIds

public MessageProperties setCorrelationIds(List<CorrelationID> correlationIds)
                                    throws IllegalArgumentException

Sets the CorrelationID property.

Parameters:

correlationIds - the CorrelationIDs to be added.

Returns:

this

Throws:

IllegalArgumentException

setCorrelationId

public MessageProperties setCorrelationId(CorrelationID correlationId)
                                   throws IllegalArgumentException

Equivalent to setCorrelationIds(java.util.List<com.bloomberglp.blpapi.CorrelationID>) with one CorrelationID.

Parameters:

correlationId -

Returns:

this

Throws:

IllegalArgumentException

setRecapType

public MessageProperties setRecapType(Message.Recap recapType,
                                      Message.Fragment fragmentType)
                               throws IllegalArgumentException

Sets the Message.Recap and Message.Fragment properties.

Parameters:

recapType -

fragmentType -

Returns:

this

Throws:

IllegalArgumentException

setTimeReceived

public MessageProperties setTimeReceived(Datetime timeReceived)
                                  throws IllegalArgumentException

Sets the time received property. The default timestamp is "unset", so attempting to retrieve the timestamp of a message with default properties will throw an exception.

Parameters:

timeReceived - represents the timestamp of the received message.

Returns:

this

Throws:

IllegalArgumentException

setService

public MessageProperties setService(Service service)
                             throws IllegalArgumentException

Sets the service property.

Parameters:

service -

Returns:

this

Throws:

IllegalArgumentException

setRequestId

public MessageProperties setRequestId(String requestId)
                               throws IllegalArgumentException

Sets the requestId property.

Parameters:

requestId -

Returns:

this

Throws:

IllegalArgumentException