com.sun.tv.si

Class SIRequestImpl

java.lang.Object

com.sun.tv.si.SIRequestImpl

All Implemented Interfaces:

SIRequest

public class SIRequestImpl
extends Object
implements SIRequest

This interface is implemented by application classes in order to receive the results of asynchronous SI retrieval requests. The SIRequestImpl registers itself at the time of the asynchronous call for a single request and is automatically unregistered when the request is completed. Applications may identify individual requests when the methods of this interface are called by registering a unique SIRequestImpl for each simultaneous asynchronous 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.

Constructor Summary

Constructors

Constructor and Description
SIRequestImpl(SIRequestor requestor, Locator locator)
SIRequestImpl(SIRequestor requestor, Locator locator, int requestKind)
SIRequestImpl(SIRequestor requestor, Locator locator, int requestKind, Object userData)
SIRequestImpl(SIRequestor requestor, Locator locator, int requestKind, Object[] userData)
SIRequestImpl(SIRequestor requestor, Locator locator, int requestKind, Object userData1, Object userData2)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel() Cancels a pending request.
boolean	equals(SIElement element)
Locator	getLocator()
int	getRequestKind()
Object	getUserData(int slot)
boolean	isExpired()
void	notifyFailure(SIRequestFailureType reason) Notifies the SIRequestImpl of unsuccessful asynchronous SI retrieval.
void	notifySuccess(SIRetrievable[] result) Notifies the SIRequestImpl of successful asynchronous SI retrieval.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SIRequestImpl

public SIRequestImpl(SIRequestor requestor,
             Locator locator)

SIRequestImpl

public SIRequestImpl(SIRequestor requestor,
             Locator locator,
             int requestKind)

SIRequestImpl

public SIRequestImpl(SIRequestor requestor,
             Locator locator,
             int requestKind,
             Object userData)

SIRequestImpl

public SIRequestImpl(SIRequestor requestor,
             Locator locator,
             int requestKind,
             Object userData1,
             Object userData2)

SIRequestImpl

public SIRequestImpl(SIRequestor requestor,
             Locator locator,
             int requestKind,
             Object[] userData)

Method Detail

getLocator

public Locator getLocator()

getRequestKind

public int getRequestKind()

getUserData

public Object getUserData(int slot)

isExpired

public boolean isExpired()

notifySuccess

public void notifySuccess(SIRetrievable[] result)

Notifies the SIRequestImpl of successful asynchronous SI retrieval.

Parameters:

result - The previously requested data.

notifyFailure

public void notifyFailure(SIRequestFailureType reason)

Notifies the SIRequestImpl of unsuccessful asynchronous SI retrieval.

Parameters:

reason - The reason why the asynchronous request failed.

cancel

public boolean cancel()

Cancels a pending request. If the request is still pending and can be canceled then the notifyFailture 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.

Specified by:

cancel in interface SIRequest

Returns:

True if the request was pending and successfully canceled; false otherwise.

See Also:

SIRequestor.notifyFailure(javax.tv.service.SIRequestFailureType), SIRequestFailureType.CANCELED

equals

public boolean equals(SIElement element)