From 2d073129857a42ab4195cd433c8be152e357033f Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Mon, 21 Mar 2011 20:40:57 +0000 Subject: Documentation refresh; ResourceBundle in ShowUtils; probably some format pokery. --- doc/uk/org/ury/show/ShowUtils.html | 43 +++++++++++++++++--------------------- 1 file changed, 19 insertions(+), 24 deletions(-) (limited to 'doc/uk/org/ury/show/ShowUtils.html') diff --git a/doc/uk/org/ury/show/ShowUtils.html b/doc/uk/org/ury/show/ShowUtils.html index c4bd122..8fa89c4 100644 --- a/doc/uk/org/ury/show/ShowUtils.html +++ b/doc/uk/org/ury/show/ShowUtils.html @@ -2,12 +2,12 @@ - + ShowUtils - + @@ -101,8 +101,8 @@ java.lang.Object

-A set of common utility routines to facilitate the extraction of - show items from the show storage areas of the URY database. +A set of common utility routines to facilitate the extraction of show items + from the show storage areas of the URY database.

@@ -163,8 +163,8 @@ A set of common utility routines to facilitate the extraction of int channel)
-          Given a show and a channel, retrieve a list of all show items - bound to that channel for the show. +          Given a show and a channel, retrieve a list of all show items bound to + that channel for the show. @@ -247,15 +247,12 @@ public static java.util.List<java.lang.String> getPublicFolders(

Parameters:
db - The database to query. -
Returns:
a list of the public folder names. - The list may be empty. +
Returns:
a list of the public folder names. The list may be empty.
Throws: -
java.lang.IllegalArgumentException - if the database is - null, the show ID is negative or the - channel index falls out of bounds. -
QueryFailureException - if the database backend - yielded an error while executing the search - query.
+
java.lang.IllegalArgumentException - if the database is null, the show ID is negative or the + channel index falls out of bounds. +
QueryFailureException - if the database backend yielded an error while executing the + search query.
@@ -268,20 +265,18 @@ public static java.util.List<QueryFailureException
-
Given a show and a channel, retrieve a list of all show items - bound to that channel for the show. +
Given a show and a channel, retrieve a list of all show items bound to + that channel for the show.

Parameters:
db - The database to query.
showID - The unique number that identifies the show.
channel - The index of the channel to query. -
Returns:
a list of ShowItems extracted from the show and - channel. The list may be empty. +
Returns:
a list of ShowItems extracted from the show and channel. The list + may be empty.
Throws: -
java.lang.IllegalArgumentException - if the database is - null, the show ID is negative or the - channel index falls out of bounds. -
QueryFailureException - if the database backend - yielded an error while executing the search - query.
+
java.lang.IllegalArgumentException - if the database is null, the show ID is negative or the + channel index falls out of bounds. +
QueryFailureException - if the database backend yielded an error while executing the + search query.
-- cgit v1.2.3