eTextReader.AnnotationListing
Interface NotationProvider

All Known Implementing Classes:

AllPagesProvider, CompoundNotationProvider, PageSetNotationProvider, TextbookProvider

public interface NotationProvider

A NotationProvider provides a set of pages that contain the notations to be displayed by a NotationListing window.

Author:

mcfall

Method Summary

java.util.Set<java.lang.String>	getCandidateURLs(java.lang.String userName) Determines a list of pages that contain may annotations for the specific user
java.lang.String	getDescription() Returns a description of this provider's scope.

Method Detail

getCandidateURLs

java.util.Set<java.lang.String> getCandidateURLs(java.lang.String userName)

Determines a list of pages that contain may annotations for the specific user

Parameters:

userName - the name of the user to check for annotations

Returns:

a (possibly empty) set containing String versions of URLs representing pages that contain annotations viewable by the specified user

getDescription

java.lang.String getDescription()

Returns a description of this provider's scope. Examples include

• all pages
• pages in the current book

Since this will usually be at the end of a phrase, the description should start with a lower case letter

Returns:

a string describing the provider's scope