Uses of Class
com.bloomberglp.blpapi.CorrelationID

Packages that use CorrelationID

Package	Description
com.bloomberglp.blpapi
com.bloomberglp.blpapi.test

Uses of CorrelationID in com.bloomberglp.blpapi

Fields in com.bloomberglp.blpapi declared as CorrelationID

Modifier and Type	Field	Description
final CorrelationID	SubscriptionPreprocessError.correlationId	The CorrelationID of the Subscription.

Methods in com.bloomberglp.blpapi that return CorrelationID

Modifier and Type	Method	Description
abstract CorrelationID	Message.correlationID()	Return the correlationId associated with this message.
abstract CorrelationID	Message.correlationID(int index)	Return the correlationId associated with this message at the specified index
CorrelationID	Subscription.correlationID()
CorrelationID	ResolutionList.correlationIdAt(int index)
CorrelationID	TopicList.correlationIdAt(int index)
abstract CorrelationID	Message.correlationIDAt(int index)	Deprecated. As of 3.2.1, use Message.correlationID(int)
CorrelationID	AbstractSession.generateAuthorizedIdentity(AuthOptions authOptions)	Generates an authorized Identity with an automatically generated CorrelationID.
CorrelationID	AbstractSession.generateToken()	Return a generated token to be used for authorization.
CorrelationID	AbstractSession.generateToken(CorrelationID correlationId)	Return a generated token to be used for authorization.
CorrelationID	AbstractSession.generateToken(CorrelationID correlationId, EventQueue eventQueue)	Return a generated token to be used for authorization.
CorrelationID	AbstractSession.generateToken(String userId, String ipAddress, CorrelationID correlationId, EventQueue eventQueue)	Return a generated token to be used for authorization.
CorrelationID	AbstractSession.openServiceAsync(String serviceIdentifier)	Issue an asynchronous request to open a service.
CorrelationID	ProviderSession.registerServiceAsync(String serviceName, Identity providerIdentity)	Begins the process of registering the service identified by the specified serviceName and returns immediately.
CorrelationID	ProviderSession.registerServiceAsync(String serviceName, Identity providerIdentity, CorrelationID correlationId)	Begins the process of registering the service identified by the specified serviceName and returns immediately.
CorrelationID	ProviderSession.registerServiceAsync(String serviceName, Identity providerIdentity, CorrelationID correlationId, ServiceRegistrationOptions registrationOptions)	Is registerServiceAsync extended.
CorrelationID	ProviderSession.registerServiceAsync(String serviceName, Identity providerIdentity, ServiceRegistrationOptions registrationOptions)	Is registerServiceAsync extended.
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, Identity identity, CorrelationID correlationId)	Send the specified authorizationRequest and update the specified identity with the results.
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, Identity identity, CorrelationID correlationId, String requestLabel)	Send the specified authorizationRequest and update the specified identity with the results.
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, Identity identity, EventQueue eventQueue, CorrelationID correlationId)	Send the specified authorizationRequest and update the specified identity with the results.
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, Identity identity, EventQueue eventQueue, CorrelationID correlationId, String requestLabel)	Send the specified authorizationRequest and update the specified identity with the results.
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, UserHandle identity, CorrelationID correlationId)	Deprecated. as of 3.3.0, use AbstractSession.sendAuthorizationRequest(Request, Identity, CorrelationID) instead
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, UserHandle identity, CorrelationID correlationId, String requestLabel)	Deprecated. as of 3.3.0, use AbstractSession.sendAuthorizationRequest(Request, Identity, CorrelationID, String) instead
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, UserHandle identity, EventQueue eventQueue, CorrelationID correlationId)	Deprecated. as of 3.3.0, use AbstractSession.sendAuthorizationRequest(Request, Identity, EventQueue, CorrelationID) instead
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, UserHandle identity, EventQueue eventQueue, CorrelationID correlationId, String requestLabel)	Deprecated. as of 3.3.0, use AbstractSession.sendAuthorizationRequest(Request, Identity, EventQueue, CorrelationID, String) instead
CorrelationID	Session.sendRequest(Request request, CorrelationID correlationId)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, CorrelationID correlationId, String requestLabel)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, EventQueue eventQueue, CorrelationID correlationId)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, EventQueue eventQueue, CorrelationID correlationId, String requestLabel)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, Identity identity, CorrelationID correlationId)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, Identity identity, CorrelationID correlationId, String requestLabel)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, Identity identity, EventQueue eventQueue, CorrelationID correlationId)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, Identity identity, EventQueue eventQueue, CorrelationID correlationId, String requestLabel)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, UserHandle identity, CorrelationID correlationId)	Deprecated. as of 3.3.0, use Session.sendRequest(Request, Identity, CorrelationID) instead
CorrelationID	Session.sendRequest(Request request, UserHandle identity, CorrelationID correlationId, String requestLabel)	Deprecated. as of 3.3.0, use Session.sendRequest(Request, Identity, CorrelationID, String) instead
CorrelationID	Session.sendRequest(Request request, UserHandle identity, EventQueue eventQueue, CorrelationID correlationId)	Deprecated. as of 3.3.0, use Session.sendRequest(Request, Identity, EventQueue, CorrelationID) instead
CorrelationID	Session.sendRequest(Request request, UserHandle identity, EventQueue eventQueue, CorrelationID correlationId, String requestLabel)	Deprecated. as of 3.3.0, use Session.sendRequest(Request, Identity, EventQueue, CorrelationID, String) instead
CorrelationID	Session.sendRequest(RequestTemplate requestTemplate)	Same as calling sendRequest(requestTemplate, null)
CorrelationID	Session.sendRequest(RequestTemplate requestTemplate, CorrelationID correlationId)	Send a request defined by the specified 'requestTemplate'.
CorrelationID	SessionOptions.setSessionIdentityOptions(AuthOptions authOptions)	Sets the specified authOptions as the AuthOptions for the session identity with an automatically generated CorrelationID.

Methods in com.bloomberglp.blpapi with parameters of type CorrelationID

Modifier and Type	Method	Description
void	ResolutionList.add(Message message, CorrelationID correlationId)
void	ResolutionList.add(String topic, CorrelationID correlationId)
void	TopicList.add(Message message, CorrelationID correlationId)
void	TopicList.add(String topic, CorrelationID correlationId)
void	EventFormatter.appendRecapMessage(Topic topic, CorrelationID cid)	Append a (empty) recap message that will be published under the specified 'topic' to the event referenced by this EventFormatter.
void	EventFormatter.appendRecapMessage(Topic topic, Integer sequenceNumber, CorrelationID cid)	Append a (empty) recap message that will be published under the specified 'topic' to the event referenced by this EventFormatter.
Element	ResolutionList.attribute(Name attributeName, CorrelationID correlationId)	Deprecated. Attributes are no longer supported.
void	AbstractSession.cancel(CorrelationID correlationId)	Cancel an outstanding request or a subscription represented by the specified correlationId
void	AbstractSession.cancel(CorrelationID correlationId, String requestLabel)	Cancel an outstanding request or a subscription represented by the specified correlationId
abstract Event	Service.createResponseEvent(CorrelationID correlationId)	Create a response Event to answer the request.
RequestTemplate	Session.createSnapshotRequestTemplate(String subscriptionString, CorrelationID statusCid)	Same as calling createSnapshotRequestTemplate(subscriptionString, statusCid, null)
RequestTemplate	Session.createSnapshotRequestTemplate(String subscriptionString, CorrelationID statusCid, Identity identity)	Create a snapshot request template for getting subscription data specified by the 'subscriptionString' using the optionally specified 'identity' if all the following conditions are met: the session is established, 'subscriptionString' is a valid subscription string and 'statusCid' is not used in this session.
void	AbstractSession.generateAuthorizedIdentity(AuthOptions authOptions, CorrelationID correlationId)	Generates an authorized Identity with the specified authOptions and correlationId.
CorrelationID	AbstractSession.generateToken(CorrelationID correlationId)	Return a generated token to be used for authorization.
CorrelationID	AbstractSession.generateToken(CorrelationID correlationId, EventQueue eventQueue)	Return a generated token to be used for authorization.
CorrelationID	AbstractSession.generateToken(String userId, String ipAddress, CorrelationID correlationId, EventQueue eventQueue)	Return a generated token to be used for authorization.
Identity	AbstractSession.getAuthorizedIdentity(CorrelationID correlationId)	Returns the authorized identity associated with correlationId.
Message	ResolutionList.message(CorrelationID correlationId)
Message	TopicList.message(CorrelationID correlationId)
void	AbstractSession.openServiceAsync(String serviceIdentifier, CorrelationID correlationId)	Initiate an asynchronous request to open a service.
CorrelationID	ProviderSession.registerServiceAsync(String serviceName, Identity providerIdentity, CorrelationID correlationId)	Begins the process of registering the service identified by the specified serviceName and returns immediately.
CorrelationID	ProviderSession.registerServiceAsync(String serviceName, Identity providerIdentity, CorrelationID correlationId, ServiceRegistrationOptions registrationOptions)	Is registerServiceAsync extended.
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, Identity identity, CorrelationID correlationId)	Send the specified authorizationRequest and update the specified identity with the results.
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, Identity identity, CorrelationID correlationId, String requestLabel)	Send the specified authorizationRequest and update the specified identity with the results.
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, Identity identity, EventQueue eventQueue, CorrelationID correlationId)	Send the specified authorizationRequest and update the specified identity with the results.
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, Identity identity, EventQueue eventQueue, CorrelationID correlationId, String requestLabel)	Send the specified authorizationRequest and update the specified identity with the results.
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, UserHandle identity, CorrelationID correlationId)	Deprecated. as of 3.3.0, use AbstractSession.sendAuthorizationRequest(Request, Identity, CorrelationID) instead
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, UserHandle identity, CorrelationID correlationId, String requestLabel)	Deprecated. as of 3.3.0, use AbstractSession.sendAuthorizationRequest(Request, Identity, CorrelationID, String) instead
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, UserHandle identity, EventQueue eventQueue, CorrelationID correlationId)	Deprecated. as of 3.3.0, use AbstractSession.sendAuthorizationRequest(Request, Identity, EventQueue, CorrelationID) instead
CorrelationID	AbstractSession.sendAuthorizationRequest(Request authorizationRequest, UserHandle identity, EventQueue eventQueue, CorrelationID correlationId, String requestLabel)	Deprecated. as of 3.3.0, use AbstractSession.sendAuthorizationRequest(Request, Identity, EventQueue, CorrelationID, String) instead
CorrelationID	Session.sendRequest(Request request, CorrelationID correlationId)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, CorrelationID correlationId, String requestLabel)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, EventQueue eventQueue, CorrelationID correlationId)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, EventQueue eventQueue, CorrelationID correlationId, String requestLabel)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, Identity identity, CorrelationID correlationId)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, Identity identity, CorrelationID correlationId, String requestLabel)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, Identity identity, EventQueue eventQueue, CorrelationID correlationId)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, Identity identity, EventQueue eventQueue, CorrelationID correlationId, String requestLabel)	Send the specified request to a service using this session
CorrelationID	Session.sendRequest(Request request, UserHandle identity, CorrelationID correlationId)	Deprecated. as of 3.3.0, use Session.sendRequest(Request, Identity, CorrelationID) instead
CorrelationID	Session.sendRequest(Request request, UserHandle identity, CorrelationID correlationId, String requestLabel)	Deprecated. as of 3.3.0, use Session.sendRequest(Request, Identity, CorrelationID, String) instead
CorrelationID	Session.sendRequest(Request request, UserHandle identity, EventQueue eventQueue, CorrelationID correlationId)	Deprecated. as of 3.3.0, use Session.sendRequest(Request, Identity, EventQueue, CorrelationID) instead
CorrelationID	Session.sendRequest(Request request, UserHandle identity, EventQueue eventQueue, CorrelationID correlationId, String requestLabel)	Deprecated. as of 3.3.0, use Session.sendRequest(Request, Identity, EventQueue, CorrelationID, String) instead
CorrelationID	Session.sendRequest(RequestTemplate requestTemplate, CorrelationID correlationId)	Send a request defined by the specified 'requestTemplate'.
void	Subscription.setCorrelationID(CorrelationID correlationId)
void	SessionOptions.setSessionIdentityOptions(AuthOptions authOptions, CorrelationID correlationId)	Sets the specified authOptions as the AuthOptions for the session identity, enabling automatic authorization of the session identity during startup.
ResolutionList.Status	ResolutionList.status(CorrelationID correlationId)
TopicList.Status	TopicList.status(CorrelationID correlationId)
int	Session.subscriptionStatus(CorrelationID correlationId)	Returns the subscription status for the specified correlationId
String	Session.subscriptionString(CorrelationID correlationId)	Returns the subscription string for the specified correlationId
String	ResolutionList.topicString(CorrelationID correlationId)
String	TopicList.topicString(CorrelationID correlationId)
void	Session.unsubscribe(CorrelationID correlationId)	Deprecated. as of 3.2.2 Use AbstractSession.cancel(CorrelationID) instead

Method parameters in com.bloomberglp.blpapi with type arguments of type CorrelationID

Modifier and Type	Method	Description
void	AbstractSession.cancel(List<CorrelationID> correlators)	Cancel outstanding requests or subscriptions represented by the specified list of correlationIds
void	AbstractSession.cancel(List<CorrelationID> correlators, String requestLabel)	Cancel outstanding requests or subscriptions represented by the specified list of correlationIds

Constructors in com.bloomberglp.blpapi with parameters of type CorrelationID

Modifier	Constructor	Description
	CorrelationID(CorrelationID from)
	Subscription(String subscriptionString, CorrelationID correlationID)	Construct a Subscription object with the specified subscription string and the specified correlationID for correlation.
	Subscription(String subscriptionString, CorrelationID correlationID, boolean isResolved)	Construct a Subscription object with the specified subscription string, the specified correlationID for correlation, and the specified isResolved flag.
	Subscription(String subscriptionString, String fields, CorrelationID correlationId)	Create a Subscription object with the specified subscriptionString and fields with no options and the specified correlationId
	Subscription(String subscriptionString, String fields, String options, CorrelationID correlationId)	Create a Subscription object with the specified subscriptionString, fields, options and correlationId
	Subscription(String security, List<String> fields, CorrelationID correlationId)
	Subscription(String security, List<String> fields, List<String> options, CorrelationID correlationId)
	SubscriptionPreprocessError(CorrelationID correlationId, String subscriptionString, SubscriptionPreprocessError.Code code, String description)	Creates a new SubscriptionPreprocessError.

Uses of CorrelationID in com.bloomberglp.blpapi.test

Methods in com.bloomberglp.blpapi.test with parameters of type CorrelationID

Modifier and Type	Method	Description
MessageProperties	MessageProperties.setCorrelationId(CorrelationID correlationId)	Equivalent to MessageProperties.setCorrelationIds(java.util.List<com.bloomberglp.blpapi.CorrelationID>) with one CorrelationID.

Method parameters in com.bloomberglp.blpapi.test with type arguments of type CorrelationID

Modifier and Type	Method	Description
MessageProperties	MessageProperties.setCorrelationIds(List<CorrelationID> correlationIds)	Sets the CorrelationID property.