sage.api
Class SeriesInfoAPI

java.lang.Object
  sage.api.SeriesInfoAPI

public class SeriesInfoAPI
extends java.lang.Object

Constructor Summary

SeriesInfoAPI()

Method Summary

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
java.lang.String	GetSeriesActor(sage.SeriesInfo SeriesInfo, int Index) Returns the name of the actor/actress for the specfied index in the specified SeriesInfo.
java.lang.String	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
sage.MetaImage	GetSeriesImage(sage.SeriesInfo SeriesInfo) Returns the image that corresponds to this SeriesInfo if there is one
sage.SeriesInfo	GetSeriesInfoForID(java.lang.String SeriesID) Returns the SeriesInfo object for the specified Series ID
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	HasSeriesImage(sage.SeriesInfo SeriesInfo) Returns true if the specified SeriesInfo has a corresponding image for it

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

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 java.lang.String 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 name of the actor/actress for the specfied index in the specified SeriesInfo

Since:

5.1

GetSeriesActorList

public java.lang.String 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 names 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

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

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

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