com.bloomberglp.blpapi

Interface RequestTemplate

public interface RequestTemplate

This class provides a handle for a request template.

Request templates are obtained from a Session and should be always used with the session that creates the template. When a session is terminated, any request templates associated with that session become invalid. Results of sending or canceling of invalid requests templates is undefined.

In order to send a request represented by a template, the Session.sendRequest(com.bloomberglp.blpapi.RequestTemplate, com.bloomberglp.blpapi.CorrelationID) method should be called with the 'RequestTemplate' object passed as the first argument.

All handles should be closed by calling close() method for releasing resources when a request template is not longer needed.

Usage example: RequestTemplate requestTemplate = session.createSnapshotRequestTemplate( "//blp/mktdata/ticker/IBM US Equity, statusCorrelationId, identity); session.sendRequestTemplate(requestTemplate); requestTemplate.close();

Check Session.createSnapshotRequestTemplate(String, CorrelationID, Identity) for details about creation and management of snapshot request templates.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the request template handle and release resources when possible.

Method Detail

close

void close()

Close the request template handle and release resources when possible.