Use is subject to License Terms. Your use of this web site or any of its content or software indicates your agreement to be bound by these License Terms.

Copyright © 2006 Sun Microsystems, Inc. All rights reserved.

javax.tv.service.transport
Interface BouquetCollection

All Superinterfaces:

Transport

public interface BouquetCollection

extends Transport

This interface represents a collection of bouquets on a Transport. In DVB SI, this information is contained in the BAT tables. BouquetCollection may be optionally implemented by Transport objects, depending on the SI data carried on that transport.

See Also:

Optionally implemented interfaces

Method Summary

void	addBouquetChangeListener(BouquetChangeListener listener) Registers a BouquetChangeListener to be notified of changes to a Bouquet that is part of this BouquetCollection.
void	removeBouquetChangeListener(BouquetChangeListener listener) Called to unregister an BouquetChangeListener.
SIRequest	retrieveBouquet(Locator locator, SIRequestor requestor) Retrieves the specified Bouquet from the collection.
SIRequest	retrieveBouquets(SIRequestor requestor) Retrieves an array of all the Bouquet objects in this BouquetCollection.

Methods inherited from interface javax.tv.service.transport.Transport

addServiceDetailsChangeListener, getDeliverySystemType, removeServiceDetailsChangeListener

Method Detail

retrieveBouquet

public SIRequest retrieveBouquet(Locator locator,
                                 SIRequestor requestor)
                          throws InvalidLocatorException,
                                 java.lang.SecurityException

Retrieves the specified Bouquet from the collection.

This method delivers its results asynchronously.

Parameters:

locator - A Locator referencing the Bouquet of interest.

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieval request.

Throws:

InvalidLocatorException - If locator does not reference a valid bouquet.

java.lang.SecurityException - If the caller does not have javax.tv.service.ReadPermission(locator).

See Also:

Bouquet, ReadPermission

retrieveBouquets

public SIRequest retrieveBouquets(SIRequestor requestor)

Retrieves an array of all the Bouquet objects in this BouquetCollection. This array will only contain Bouquet instances b for which the caller has javax.tv.service.ReadPermission(b.getLocator()). If no Bouquet instances meet this criteria, this method will result in an SIRequestFailureType of DATA_UNAVAILABLE.

This method delivers its results asynchronously.

Parameters:

requestor - The SIRequestor to be notified when this retrieval operation completes.

Returns:

An SIRequest object identifying this asynchronous retrieval request.

See Also:

Bouquet, ReadPermission

addBouquetChangeListener

public void addBouquetChangeListener(BouquetChangeListener listener)

Registers a BouquetChangeListener to be notified of changes to a Bouquet that is part of this BouquetCollection. Subsequent notification is made via BouquetChangeEvent with this BouquetCollection as the event source and an SIChangeType of ADD, REMOVE or MODIFY. Only changes to Bouquet instances b for which the caller has javax.tv.service.ReadPermission(b.getLocator()) will be reported.

This method is only a request for notification. No guarantee is provided that the SI database will detect all, or even any, SI changes or whether such changes will be detected in a timely fashion.

If the specified BouquetChangeListener is already registered, no action is performed.

Parameters:

listener - A BouquetChangeListener to be notified about changes related to Bouquet carried on this Transport.

See Also:

BouquetChangeEvent, ReadPermission

removeBouquetChangeListener

public void removeBouquetChangeListener(BouquetChangeListener listener)

Called to unregister an BouquetChangeListener. If the specified BouquetChangeListener is not registered, no action is performed.

Parameters:

listener - A previously registered listener.