javax.tv.service.SIRequest Maven / Gradle / Ivy
/**
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative use only. For example,
this file and any files generated from it may be used to generate other documentation,
such as a unified set of documents of API signatures for a platform
that includes technologies expressed as Java APIs.
This file may also be used to produce "compilation stubs,"
which allow applications to be compiled and validated for such platforms.
By contrast, no permission is given for you to incorporate this file,
in whole or in part, in an implementation of a Java specification.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 927: Java TV API 1.1.1.
In the event of a discrepency between this work and the JSR 927 specification,
which is available at http://www.jcp.org/en/jsr/detail?id=927, the latter takes precedence.
*/
package javax.tv.service;
/**
* 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 SIRequestor
*/
public interface SIRequest
{
/**
* 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.
*
* @return true if the request was pending and
* successfully canceled; false otherwise.
*
* @see SIRequestor#notifyFailure
* @see SIRequestFailureType#CANCELED
*/
public boolean cancel();
}