SageTV Platform
V9.0

sage.api
Class SeriesInfoAPI

java.lang.Object
  extended by sage.api.SeriesInfoAPI

public class SeriesInfoAPI
extends java.lang.Object


Constructor Summary
SeriesInfoAPI()
           
 
Method Summary
 sage.SeriesInfo AddSeriesInfo(int SeriesID, java.lang.String Title, java.lang.String Network, java.lang.String Description, java.lang.String History, java.lang.String PremiereDate, java.lang.String FinaleDate, java.lang.String AirDOW, java.lang.String AirHrMin, java.lang.String ImageURL, java.lang.String[] People, java.lang.String[] Characters)
          Call this to add a SeriesInfo object to the database.
 sage.SeriesInfo[] GetAllSeriesInfo()
          Returns a list of all of the SeriesInfo which is information about television series
 int GetNumberOfCharactersInSeries(sage.SeriesInfo SeriesInfo)
          Returns the number of characters that we have information on for the specified series
 sage.Person GetSeriesActor(sage.SeriesInfo SeriesInfo, int Index)
          Returns the name of the actor/actress for the specfied index in the specified SeriesInfo.
 sage.MetaImage GetSeriesActorImage(sage.SeriesInfo SeriesInfo, sage.Person Person, boolean Thumb)
          Returns an image of the specified Person in their role in the specified Series
 java.lang.String GetSeriesActorImageURL(sage.SeriesInfo SeriesInfo, sage.Person Person, boolean Thumb)
          Returns an image URL of the specified Person in their role in the specified Series
 sage.Person[] GetSeriesActorList(sage.SeriesInfo SeriesInfo)
          Returns a list of the names of the actors/actresses in the specified SeriesInfo.
 java.lang.String GetSeriesCategory(sage.SeriesInfo SeriesInfo)
          Returns the category for the specified SeriesInfo
 java.lang.String GetSeriesCharacter(sage.SeriesInfo SeriesInfo, int Index)
          Returns the name of the character for the specfied index in the specified SeriesInfo.
 java.lang.String GetSeriesCharacterForActor(sage.SeriesInfo SeriesInfo, java.lang.String Actor)
          Returns the name of the character that the corresponding actor plays in this series
 java.lang.String[] GetSeriesCharacterList(sage.SeriesInfo SeriesInfo)
          Returns a list of the names of the characters in the specified SeriesInfo.
 java.lang.String GetSeriesDayOfWeek(sage.SeriesInfo SeriesInfo)
          Returns the name of the day of the week the specified SeriesInfo airs on
 java.lang.String GetSeriesDescription(sage.SeriesInfo SeriesInfo)
          Returns the description for the specified SeriesInfo
 java.lang.String GetSeriesFinaleDate(sage.SeriesInfo SeriesInfo)
          Returns a String describing the finale date for the specified SeriesInfo
 java.lang.String GetSeriesHistory(sage.SeriesInfo SeriesInfo)
          Returns the history description for the specified SeriesInfo
 java.lang.String GetSeriesHourAndMinuteTimeslot(sage.SeriesInfo SeriesInfo)
          Returns the hour/minute timeslot that the specified SeriesInfo airs at
 java.lang.String GetSeriesID(sage.SeriesInfo SeriesInfo)
          Returns the Series ID of the specified SeriesInfo NOTE: V8.0 IDs are not backwards compatible with prior versions
 sage.MetaImage GetSeriesImage(sage.SeriesInfo SeriesInfo)
          Returns the image that corresponds to this SeriesInfo if there is one
 sage.MetaImage GetSeriesImage(sage.SeriesInfo SeriesInfo, boolean Thumb)
          Returns the image that corresponds to this SeriesInfo if there is one
 sage.MetaImage GetSeriesImageAtIndex(sage.SeriesInfo SeriesInfo, int Index, boolean Thumb)
          Returns the image that corresponds to this SeriesInfo at the specified index (when there are multiple images)
 int GetSeriesImageCount(sage.SeriesInfo SeriesInfo)
          Returns the number of images available that correspond to this SeriesInfo
 java.lang.String GetSeriesImageURL(sage.SeriesInfo SeriesInfo)
          Returns the URL of the image that corresponds to this SeriesInfo if there is one
 java.lang.String GetSeriesImageURL(sage.SeriesInfo SeriesInfo, boolean Thumb)
          Returns the image URL that corresponds to this SeriesInfo if there is one
 java.lang.String GetSeriesImageURLAtIndex(sage.SeriesInfo SeriesInfo, int Index, boolean Thumb)
          Returns the image URL that corresponds to this SeriesInfo at the specified index (when there are multiple images)
 sage.SeriesInfo GetSeriesInfoForID(java.lang.String SeriesID)
          Returns the SeriesInfo object for the specified Series ID NOTE: V8.0 IDs are not backwards compatible with prior versions
 java.lang.String GetSeriesInfoProperty(sage.SeriesInfo SeriesInfo, java.lang.String PropertyName)
          Returns a property value for a specified SeriesInfo object.
 java.lang.String GetSeriesNetwork(sage.SeriesInfo SeriesInfo)
          Returns the name of the network the specified SeriesInfo airs on
 java.lang.String GetSeriesPremiereDate(sage.SeriesInfo SeriesInfo)
          Returns a String describing the premiere date for the specified SeriesInfo
 java.lang.String GetSeriesSubCategory(sage.SeriesInfo SeriesInfo)
          Returns the subcategory for the specified SeriesInfo
 java.lang.String GetSeriesTitle(sage.SeriesInfo SeriesInfo)
          Returns the title for the specified SeriesInfo
 boolean HasSeriesActorImage(sage.SeriesInfo SeriesInfo, sage.Person Person)
          Returns true if the specified SeriesInfo has a corresponding image for it for the specified Person in it
 boolean HasSeriesImage(sage.SeriesInfo SeriesInfo)
          Returns true if the specified SeriesInfo has a corresponding image for it
 boolean IsSeriesInfoObject(java.lang.Object SeriesInfo)
          Returns true if the argument is a SeriesInfo object.
 void SetSeriesInfoProperty(sage.SeriesInfo SeriesInfo, java.lang.String PropertyName, java.lang.String PropertyValue)
          Sets a property for this SeriesInfo object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SeriesInfoAPI

public SeriesInfoAPI()
Method Detail

GetAllSeriesInfo

public sage.SeriesInfo[] GetAllSeriesInfo()
Returns a list of all of the SeriesInfo which is information about television series

Returns:
a list of all of the SeriesInfo
Since:
5.1

GetSeriesTitle

public java.lang.String GetSeriesTitle(sage.SeriesInfo SeriesInfo)
Returns the title for the specified SeriesInfo

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
the title for the specified SeriesInfo
Since:
5.1

GetSeriesDescription

public java.lang.String GetSeriesDescription(sage.SeriesInfo SeriesInfo)
Returns the description for the specified SeriesInfo

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
the description for the specified SeriesInfo
Since:
5.1

GetSeriesCategory

public java.lang.String GetSeriesCategory(sage.SeriesInfo SeriesInfo)
Returns the category for the specified SeriesInfo

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
the category for the SeriesInfo
Since:
V7.0

GetSeriesSubCategory

public java.lang.String GetSeriesSubCategory(sage.SeriesInfo SeriesInfo)
Returns the subcategory for the specified SeriesInfo

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
the subcategory for the SeriesInfo
Since:
V7.0

GetSeriesHistory

public java.lang.String GetSeriesHistory(sage.SeriesInfo SeriesInfo)
Returns the history description for the specified SeriesInfo

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
the history description for the specified SeriesInfo
Since:
5.1

GetSeriesPremiereDate

public java.lang.String GetSeriesPremiereDate(sage.SeriesInfo SeriesInfo)
Returns a String describing the premiere date for the specified SeriesInfo

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
a String describing the premiere date for the specified SeriesInfo
Since:
5.1

GetSeriesFinaleDate

public java.lang.String GetSeriesFinaleDate(sage.SeriesInfo SeriesInfo)
Returns a String describing the finale date for the specified SeriesInfo

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
a String describing the finale date for the specified SeriesInfo
Since:
5.1

GetSeriesNetwork

public java.lang.String GetSeriesNetwork(sage.SeriesInfo SeriesInfo)
Returns the name of the network the specified SeriesInfo airs on

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
the name of the network the specified SeriesInfo airs on
Since:
5.1

GetSeriesDayOfWeek

public java.lang.String GetSeriesDayOfWeek(sage.SeriesInfo SeriesInfo)
Returns the name of the day of the week the specified SeriesInfo airs on

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
the name of the day of the week the specified SeriesInfo airs on
Since:
5.1

GetSeriesHourAndMinuteTimeslot

public java.lang.String GetSeriesHourAndMinuteTimeslot(sage.SeriesInfo SeriesInfo)
Returns the hour/minute timeslot that the specified SeriesInfo airs at

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
the hour/minute timeslot that the specified SeriesInfo airs at
Since:
5.1

HasSeriesImage

public boolean HasSeriesImage(sage.SeriesInfo SeriesInfo)
Returns true if the specified SeriesInfo has a corresponding image for it

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
true if the specified SeriesInfo has a corresponding image for it
Since:
5.1

GetSeriesImage

public sage.MetaImage GetSeriesImage(sage.SeriesInfo SeriesInfo)
Returns the image that corresponds to this SeriesInfo if there is one

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
the image that corresponds to this SeriesInfo if there is one
Since:
5.1

GetSeriesImage

public sage.MetaImage GetSeriesImage(sage.SeriesInfo SeriesInfo,
                                     boolean Thumb)
Returns the image that corresponds to this SeriesInfo if there is one

Parameters:
SeriesInfo - the SeriesInfo object
Thumb - true if a thumbnail is preferred, false if a full size image is
Returns:
the image that corresponds to this SeriesInfo if there is one
Since:
8.0

GetSeriesImageURL

public java.lang.String GetSeriesImageURL(sage.SeriesInfo SeriesInfo)
Returns the URL of the image that corresponds to this SeriesInfo if there is one

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
the URL of the image that corresponds to this SeriesInfo if there is one
Since:
8.0

GetSeriesImageURL

public java.lang.String GetSeriesImageURL(sage.SeriesInfo SeriesInfo,
                                          boolean Thumb)
Returns the image URL that corresponds to this SeriesInfo if there is one

Parameters:
SeriesInfo - the SeriesInfo object
Thumb - true if a thumbnail is preferred, false if a full size image is
Returns:
the image URL that corresponds to this SeriesInfo if there is one
Since:
8.0

GetSeriesImageCount

public int GetSeriesImageCount(sage.SeriesInfo SeriesInfo)
Returns the number of images available that correspond to this SeriesInfo

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
the number of images available that correspond to this SeriesInfo
Since:
8.0

GetSeriesImageAtIndex

public sage.MetaImage GetSeriesImageAtIndex(sage.SeriesInfo SeriesInfo,
                                            int Index,
                                            boolean Thumb)
Returns the image that corresponds to this SeriesInfo at the specified index (when there are multiple images)

Parameters:
SeriesInfo - the SeriesInfo object
Index - the 0-based index of which image to return
Thumb - true if a thumbnail is preferred, false if a full size image is
Returns:
the image that corresponds to this SeriesInfo at the specified index
Since:
8.0

GetSeriesImageURLAtIndex

public java.lang.String GetSeriesImageURLAtIndex(sage.SeriesInfo SeriesInfo,
                                                 int Index,
                                                 boolean Thumb)
Returns the image URL that corresponds to this SeriesInfo at the specified index (when there are multiple images)

Parameters:
SeriesInfo - the SeriesInfo object
Index - the 0-based index of which image to return
Thumb - true if a thumbnail is preferred, false if a full size image is
Returns:
the image URL that corresponds to this SeriesInfo at the specified index
Since:
8.0

HasSeriesActorImage

public boolean HasSeriesActorImage(sage.SeriesInfo SeriesInfo,
                                   sage.Person Person)
Returns true if the specified SeriesInfo has a corresponding image for it for the specified Person in it

Parameters:
SeriesInfo - the SeriesInfo object
Person - the Person to check for an image
Returns:
true if the specified SeriesInfo has a corresponding image for it for the specified Person in it
Since:
8.0

GetSeriesActorImage

public sage.MetaImage GetSeriesActorImage(sage.SeriesInfo SeriesInfo,
                                          sage.Person Person,
                                          boolean Thumb)
Returns an image of the specified Person in their role in the specified Series

Parameters:
SeriesInfo - the SeriesInfo object
Person - the Person to check for an image
Thumb - true if a thumbnail is preferred, false if a full size image is
Returns:
an image of the specified Person in their role in the specified Series
Since:
8.0

GetSeriesActorImageURL

public java.lang.String GetSeriesActorImageURL(sage.SeriesInfo SeriesInfo,
                                               sage.Person Person,
                                               boolean Thumb)
Returns an image URL of the specified Person in their role in the specified Series

Parameters:
SeriesInfo - the SeriesInfo object
Person - the Person to check for an image
Thumb - true if a thumbnail is preferred, false if a full size image is
Returns:
an image URL of the specified Person in their role in the specified Series
Since:
8.0

GetNumberOfCharactersInSeries

public int GetNumberOfCharactersInSeries(sage.SeriesInfo SeriesInfo)
Returns the number of characters that we have information on for the specified series

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
the number of characters that we have information on for the specified series
Since:
5.1

GetSeriesActor

public sage.Person GetSeriesActor(sage.SeriesInfo SeriesInfo,
                                  int Index)
Returns the name of the actor/actress for the specfied index in the specified SeriesInfo. The range for the index is from 0 to one less than the value of GetNumberOfCharactersInSeries()

Parameters:
SeriesInfo - the SeriesInfo object
Index - the 0-based index of the actor to retrieve
Returns:
the Person object of the actor/actress for the specfied index in the specified SeriesInfo
Since:
5.1

GetSeriesActorList

public sage.Person[] GetSeriesActorList(sage.SeriesInfo SeriesInfo)
Returns a list of the names of the actors/actresses in the specified SeriesInfo.

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
a list of the Persons of the actors/actresses in the specified SeriesInfo
Since:
5.1

GetSeriesCharacter

public java.lang.String GetSeriesCharacter(sage.SeriesInfo SeriesInfo,
                                           int Index)
Returns the name of the character for the specfied index in the specified SeriesInfo. The range for the index is from 0 to one less than the value of GetNumberOfCharactersInSeries()

Parameters:
SeriesInfo - the SeriesInfo object
Index - the 0-based index of the actor to retrieve
Returns:
the name of the character for the specfied index in the specified SeriesInfo
Since:
5.1

GetSeriesCharacterList

public java.lang.String[] GetSeriesCharacterList(sage.SeriesInfo SeriesInfo)
Returns a list of the names of the characters in the specified SeriesInfo.

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
a list of the names of the characters in the specified SeriesInfo
Since:
5.1

GetSeriesCharacterForActor

public java.lang.String GetSeriesCharacterForActor(sage.SeriesInfo SeriesInfo,
                                                   java.lang.String Actor)
Returns the name of the character that the corresponding actor plays in this series

Parameters:
SeriesInfo - the SeriesInfo object
Actor - the actor
Returns:
the name of the character that the corresponding actor plays in this series, the empty string if there's no correlation
Since:
7.0

GetSeriesID

public java.lang.String GetSeriesID(sage.SeriesInfo SeriesInfo)
Returns the Series ID of the specified SeriesInfo NOTE: V8.0 IDs are not backwards compatible with prior versions

Parameters:
SeriesInfo - the SeriesInfo object
Returns:
the Series ID of the specified SeriesInfo object (currently an integer, represented as a String for future expansion)
Since:
7.0

GetSeriesInfoForID

public sage.SeriesInfo GetSeriesInfoForID(java.lang.String SeriesID)
Returns the SeriesInfo object for the specified Series ID NOTE: V8.0 IDs are not backwards compatible with prior versions

Parameters:
SeriesID - the ID of the desired SeriesInfo object
Returns:
the SeriesInfo object with the specified ID, or null if it does not exist
Since:
7.0

AddSeriesInfo

public sage.SeriesInfo AddSeriesInfo(int SeriesID,
                                     java.lang.String Title,
                                     java.lang.String Network,
                                     java.lang.String Description,
                                     java.lang.String History,
                                     java.lang.String PremiereDate,
                                     java.lang.String FinaleDate,
                                     java.lang.String AirDOW,
                                     java.lang.String AirHrMin,
                                     java.lang.String ImageURL,
                                     java.lang.String[] People,
                                     java.lang.String[] Characters)
Call this to add a SeriesInfo object to the database. If a SeriesInfo with this seriesID is already present, it will be updated to this information. You can use null or String[0] for any fields you don't want to specify.

Parameters:
SeriesID - the ID of the series, this should match the prefix of corresponding ShowIDs w/out the last 4 digits for proper linkage (i.e. the SeriesID for EP1234567890 would be 123456)
Title - the title of the series
Network - the network that airs the series
Description - a description of this series
History - a historical description of the series
PremiereDate - a String representation of the date the series premiered
FinaleDate - a String representation of the date the series ended
AirDOW - a String representation of the day of the week the series airs
AirHrMin - a String representation of the time the series airs
ImageURL - a URL that links to an image for this series
People - names of people/actors in this show
Characters - must be same length as people array, should give the character names the corresponding people have in the series
Returns:
the newly added SeriesInfo object, or the updated object if another SeriesInfo object already existed with the same SeriesID
Since:
7.0

GetSeriesInfoProperty

public java.lang.String GetSeriesInfoProperty(sage.SeriesInfo SeriesInfo,
                                              java.lang.String PropertyName)
Returns a property value for a specified SeriesInfo object. This must have been set using SetSeriesInfoProperty. Returns the empty string when the property is undefined.

Parameters:
SeriesInfo - the SeriesInfo object
PropertyName - the name of the property
Returns:
the property value for the specified SeriesInfo, or the empty string if it is not defined
Since:
7.0

SetSeriesInfoProperty

public void SetSeriesInfoProperty(sage.SeriesInfo SeriesInfo,
                                  java.lang.String PropertyName,
                                  java.lang.String PropertyValue)
Sets a property for this SeriesInfo object. This can be any name/value combination (but the name cannot be null). If the value is null; then the specified property will be removed from this SeriesInfo object. This only impacts the return values from GetSeriesInfoProperty and has no other side effects.

Parameters:
SeriesInfo - the SeriesInfo object
PropertyName - the name of the property
PropertyValue - the value of the property
Since:
7.0

IsSeriesInfoObject

public boolean IsSeriesInfoObject(java.lang.Object SeriesInfo)
Returns true if the argument is a SeriesInfo object. Automatic type conversion is NOT done in this call.

Parameters:
SeriesInfo - the object to test
Returns:
true if the argument is an SeriesInfo object
Since:
7.1

SageTV Platform
V9.0

SageTV is a trademark or registered trademark of Google, Inc. in the US and other countries.
Copyright 2000-2015 The SageTV Authors. All Rights Reserved.