javax.tv.service.SIRequestor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ocap Show documentation
There is a newer version: 1.3.1
/**
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;

/** 
 * This interface is implemented by application classes to receive the
 * results of asynchronous SI retrieval requests. The
 * SIRequestor registers itself at the time of the
 * asynchronous call for a single request and is automatically
 * unregistered when the request is completed.  Applications can
 * disambiguate retrieval operations by registering a unique
 * SIRequestor for each retrieval request.
 *
 * The asynchronous SI retrieval mechanisms invoke the methods of this
 * interface using system threads that are guaranteed to not hold
 * locks on application objects.
 * 
 */
public interface SIRequestor
{

    /** 
     * Notifies the SIRequestor of successful asynchronous
     * SI retrieval.
     * 
     * @param result The previously requested data.
     */
    public void notifySuccess(SIRetrievable[] result);

    /** 
     * Notifies the SIRequestor of unsuccessful asynchronous
     * SI retrieval.
     * 
     * @param reason The reason why the asynchronous request failed.
     */
    public void notifyFailure(SIRequestFailureType reason);
}