TV-Browser 3.3.3 API

tvdataservice
Class MarkedProgramsList

java.lang.Object
  extended by tvdataservice.MarkedProgramsList

public class MarkedProgramsList
extends java.lang.Object

A class that contains all marked programs.

Since:
2.2
Author:
René Mach

Method Summary
protected  void addProgram(MutableProgram p)
           
static MarkedProgramsList getInstance()
           
 Program[] getMarkedPrograms()
           
 Program[] getTimeSortedProgramsForTray(ProgramFilter filter, int markPriority, int numberOfPrograms, boolean includeOnAirPrograms)
           
 Program[] getTimeSortedProgramsForTray(ProgramFilter filter, int markPriority, int numberOfPrograms, boolean includeOnAirPrograms, boolean useTrayFilterSettings, java.util.ArrayList<Program> excludePrograms)
           
protected  void removeProgram(MutableProgram p)
           
 void revalidatePrograms()
          Revalidate program markings
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static MarkedProgramsList getInstance()
Returns:
The instance of this class.

addProgram

protected void addProgram(MutableProgram p)

removeProgram

protected void removeProgram(MutableProgram p)

getMarkedPrograms

public Program[] getMarkedPrograms()
Returns:
The marked programs.

getTimeSortedProgramsForTray

public Program[] getTimeSortedProgramsForTray(ProgramFilter filter,
                                              int markPriority,
                                              int numberOfPrograms,
                                              boolean includeOnAirPrograms)
Parameters:
filter - The filter to use for program filtering
markPriority - The minimum mark priority of programs to find.
numberOfPrograms - The number of programs to show. Use a value of 0 or below for all important programs.
includeOnAirPrograms - If the marked programs array should contain running programs.
Returns:
The time sorted programs for the tray.

getTimeSortedProgramsForTray

public Program[] getTimeSortedProgramsForTray(ProgramFilter filter,
                                              int markPriority,
                                              int numberOfPrograms,
                                              boolean includeOnAirPrograms,
                                              boolean useTrayFilterSettings,
                                              java.util.ArrayList<Program> excludePrograms)
Parameters:
filter - The filter to use for program filtering
markPriority - The minimum mark priority of programs to find.
numberOfPrograms - The number of programs to show. Use a value of 0 or below for all important programs.
includeOnAirPrograms - If the marked programs array should contain running programs.If the tray filter settings should be used for filtering.
useTrayFilterSettings - If the tray filter settings should be used for filtering.
excludePrograms -
Returns:
The time sorted programs for the tray.

revalidatePrograms

public void revalidatePrograms()
Revalidate program markings


TV-Browser 3.3.3 API

TV-Browser 3.3.3, Copyright (C) 2004-2008 TV-Browser Team (dev@tvbrowser.org)