com.sdl.web.api.linking

Interface BatchLinkRetriever

public interface BatchLinkRetriever

The BatchLinkRetriever interface provides functionality to fetch multiple links in a single request.

Method Summary

Modifier and Type	Method and Description
String	addLinkRequest(BatchLinkRequest linkRequest) Add a link request to be executed in a batch.
void	clearRequestData() Clears all data held by the retriever.
void	executeRequest() Executes a batch link request by querying for all the link request objects added using addLinkRequest.
Link	getLink(String linkRequestId) Returns a link object (if present) from the result available from executing the query by passing unique identifier obtained when adding a link request.

Method Detail

addLinkRequest

String addLinkRequest(BatchLinkRequest linkRequest)

Add a link request to be executed in a batch.

Parameters:

linkRequest - A BatchLinkRequest object containing parameters required to fetch a link.

Returns:

An unique identifier to be used to get a link from the results of executing batch link request.

executeRequest

void executeRequest()

Executes a batch link request by querying for all the link request objects added using addLinkRequest.

getLink

Link getLink(String linkRequestId)

Returns a link object (if present) from the result available from executing the query by passing unique identifier obtained when adding a link request. This has to be called after execute request.

Parameters:

linkRequestId - An unique identifier obtained when adding a link request.

Returns:

A link object with a filled in URL if the link was resolved, or with a null-URL if the binary could not be found.

clearRequestData

void clearRequestData()

Clears all data held by the retriever.