SIRequest

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.tv.service
Interface SIRequest

    public interface SIRequest

An `SIRequest` object is used to cancel a pending asynchronous SI retrieval operation. Individual asynchronous SI retrieval operations are identified by unique `SIRequest` objects generated at the time the operation is initiated.

See Also:
  `SIRequestor`

Method Summary
`boolean` | `cancel()` Cancels a pending SI retrieval request.

Method Detail

### cancel

    boolean cancel()

  Cancels a pending SI retrieval request. If the request is still pending and can be canceled then the `notifyFailure()` method of the `SIRequestor` that initiated the asynchronous retrieval will be called with the `SIRequestFailureType` code of `CANCELED`. If the request is no longer pending then no action is performed.

  Returns:
    `true` if the request was pending and successfully canceled; `false` otherwise.
  See Also:
    `SIRequestor.notifyFailure(javax.tv.service.SIRequestFailureType)`, `SIRequestFailureType.CANCELED`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD