Galactix Home | Main Page | Class Hierarchy | Data Structures | Function List

IMasterSchedule Interface Reference

The IMasterSchedule object. More...

#include <tsssx.idl>

Inherits IDispatch.


Public Methods

HRESULT ToString ([out, retval] BSTR *pVal)
 Get a String representation of this object. More...

HRESULT Name ([out, retval] BSTR *pVal)
 Get the Name property of this object as a String. More...

HRESULT ID ([out, retval] long *pVal)
 Get the ID property of this object as a long. More...

HRESULT Comment ([out, retval] BSTR *pVal)
 Get the Comment property of this object as a String. More...

HRESULT getNumOfGames ([out, retval] long *pINum)
 Get the total number of IGame's in the schedule. More...

HRESULT getNumOfSeasonGames ([out, retval] long *pINum)
 Get the number of season (round-robin) IGame's in the schedule. More...

HRESULT getNumOfPracticeGames ([out, retval] long *pINum)
 Get the number of practice IGame's in the schedule. More...

HRESULT getNumOfTournamentGames ([out, retval] long *pINum)
 Get the number of tournament IGame's in the schedule. More...

HRESULT getNumOfLeagueGames ([in] long lLeagueID,[out, retval] long *pINum)
 Get the number of league IGame's in the schedule. More...

HRESULT getNumOfVenueGames ([in] long lVenueID,[out, retval] long *pINum)
 Get the number of venue IGame's in the schedule. More...

HRESULT getNumOfTeamGames ([in] long lTeamID,[out, retval] long *pINum)
 Get the number of team IGame's in the schedule. More...

HRESULT getNumOfOfficialGames ([in] long lOfficialID,[out, retval] long *pINum)
 Get the number of official IGame's in the schedule. More...

HRESULT getGames ([out, retval] IGameCollection **ppIGameCollection)
 Get a collection of all the IGame's in the schedule. More...

HRESULT getSeasonGames ([out, retval] IGameCollection **ppIGameCollection)
 Get a collection of all the season (round-robin) IGame's in the schedule. More...

HRESULT getPracticeGames ([out, retval] IGameCollection **ppIGameCollection)
 Get a collection of all the practice IGame's in the schedule. More...

HRESULT getTournamentGames ([out, retval] IGameCollection **ppIGameCollection)
 Get a collection of all the tournament IGame's in the schedule. More...

HRESULT getLeagueGames ([in] long lID,[out, retval] IGameCollection **ppIGameCollection)
 Get a collection of all the league's IGame's in the schedule. More...

HRESULT getVenueGames ([in] long lID,[out, retval] IGameCollection **ppIGameCollection)
 Get a collection of all the venue's IGame's in the schedule. More...

HRESULT getTeamGames ([in] long lID,[out, retval] IGameCollection **ppIGameCollection)
 Get a collection of all the team's IGame's in the schedule. More...

HRESULT getOfficialGames ([in] long lID,[out, retval] IGameCollection **ppIGameCollection)
 Get a collection of all the official's IGame's in the schedule. More...

HRESULT queryEvents ([in] int iGameType,[in] DATE dtStartTime,[in] DATE dtEndTime,[in] long lLeagueID,[in] long lDivisionID,[in] long lTeamID,[in] long lVenueID,[in] long lOfficialID,[in] int iSortType,[in] BOOL fInclusive,[out, retval] IGameCollection **ppIGameCollection)
 Get a collection of IGame's that match the query in the schedule. More...

HRESULT getHaveGame ([in] long lID,[out, retval] BOOL *fVal)
 Find out whether or not the specified game belongs to this schedule. More...

Detailed Description

The IMasterSchedule object.

The IMasterSchedule can be thought of as the central list of games in the project. This is where all the ISeasonSchedule, IPracticeSchedule, and ITournamentSchedule games are stored. Usually a project only has one IMasterSchedule, but the Team Sports Scheduling System supports more.

See also:
ISeasonSchedule, IPracticeSchedule, ITournamentSchedule, IGame

Member Function Documentation

HRESULT IMasterSchedule::Comment (  [out, retval] BSTR *    pVal ) 
 

Get the Comment property of this object as a String.

Example: 

    var sComment = obj.Comment;

HRESULT IMasterSchedule::ID (  [out, retval] long *    pVal ) 
 

Get the ID property of this object as a long.

Example: 

    var iID = obj.ID;

HRESULT IMasterSchedule::Name (  [out, retval] BSTR *    pVal ) 
 

Get the Name property of this object as a String.

Example: 

    var sName = obj.Name;

HRESULT IMasterSchedule::ToString (  [out, retval] BSTR *    pVal ) 
 

Get a String representation of this object.

Example: 

    var sImplicit = "The object '" + obj + "' ToString property was called implicitly.";
    var sDirect = "The object '" + obj.ToString + "' ToString property was called directly.";

HRESULT IMasterSchedule::getGames (  [out,retval] IGameCollection **    ppIGameCollection ) 
 

Get a collection of all the IGame's in the schedule.

Returns:
Returns a IGameCollection of all the IGame's in the schedule.
Example: 
    var obj;
    var eItems = new Enumerator(masterschedule.getGames());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
IGame, IGameCollection

HRESULT IMasterSchedule::getHaveGame (  [in] long    lID,
[out,retval] BOOL *    fVal
) 
 

Find out whether or not the specified game belongs to this schedule.

Parameters:
lID  The ID of the game to look up.
Returns:
Returns true if the event is in this schedule, false otherwise.
Example: 
    var game;
    var eItems = new Enumerator(Project.getGames());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        game = eItems.item();
        if (schedule.getHaveGame(game.ID) == true)
        {
            Response.WriteLine("The schedule '" + schedule + "' has the game '" + game + "'");
        }
    }
See also:
IGame

HRESULT IMasterSchedule::getLeagueGames (  [in] long    lID,
[out,retval] IGameCollection **    ppIGameCollection
) 
 

Get a collection of all the league's IGame's in the schedule.

Parameters:
lID  The ILeague's ID
Returns:
Returns a IGameCollection of all the league's IGame's in the schedule.
Example: 
    var oGame;
    var eGames = new Enumerator(schedule.getLeagueGames(league.ID));
    for (; !eGames.atEnd(); eGames.moveNext())
    {
        oGame = eGames.item();
        // do something with the IGame object
    }
See also:
IGame, IGameCollection, ILeague

HRESULT IMasterSchedule::getNumOfGames (  [out,retval] long *    pINum ) 
 

Get the total number of IGame's in the schedule.

Returns:
Returns the number of IGame's in the IMasterSchedule.
Example: 
    var iNum = masterschedule.getNumOfGames();

HRESULT IMasterSchedule::getNumOfLeagueGames (  [in] long    lLeagueID,
[out,retval] long *    pINum
) 
 

Get the number of league IGame's in the schedule.

That is, the number of games contained in the ISeasonSchedule's and IPracticeSchedule's that the ILeague owns, which are scheduled on this IMasterSchedule.

Parameters:
lLeagueID  The ILeague's ID
Returns:
Returns the number of league IGame's in the IMasterSchedule.
Example: 
    var iNum = masterschedule.getNumOfLeagueGames(iLeagueID);

HRESULT IMasterSchedule::getNumOfOfficialGames (  [in] long    lOfficialID,
[out,retval] long *    pINum
) 
 

Get the number of official IGame's in the schedule.

Parameters:
lOfficialID  The IOfficial's ID.
Returns:
Returns the number of official IGame's in the schedule.
Example: 
    var iNum = schedule.getNumOfOfficialGames(official.ID);

HRESULT IMasterSchedule::getNumOfPracticeGames (  [out,retval] long *    pINum ) 
 

Get the number of practice IGame's in the schedule.

Returns:
Returns the number of practice IGame's in the IMasterSchedule.
Example: 
    var iNum = masterschedule.getNumOfPracticeGames();

HRESULT IMasterSchedule::getNumOfSeasonGames (  [out,retval] long *    pINum ) 
 

Get the number of season (round-robin) IGame's in the schedule.

Returns:
Returns the number of season IGame's in the IMasterSchedule.
Example: 
    var iNum = masterschedule.getNumOfSeasonGames();

HRESULT IMasterSchedule::getNumOfTeamGames (  [in] long    lTeamID,
[out,retval] long *    pINum
) 
 

Get the number of team IGame's in the schedule.

Parameters:
lTeamID  The ID of the team you wish to get the number of games for.
Returns:
Returns the number of team IGame's in the schedule.
Example: 
    var iNum = schedule.getNumOfTeamGames(team.ID);

HRESULT IMasterSchedule::getNumOfTournamentGames (  [out,retval] long *    pINum ) 
 

Get the number of tournament IGame's in the schedule.

Returns:
Returns the number of tournament IGame's in the IMasterSchedule.
Example: 
    var iNum = masterschedule.getNumOfTournamentGames();

HRESULT IMasterSchedule::getNumOfVenueGames (  [in] long    lVenueID,
[out,retval] long *    pINum
) 
 

Get the number of venue IGame's in the schedule.

Parameters:
lVenueID  The ID of the venue you wish to get the number of games for.
Returns:
Returns the number of venue IGame's in the schedule.
Example: 
    var iNum = schedule.getNumOfVenueGames(venue.ID);

HRESULT IMasterSchedule::getOfficialGames (  [in] long    lID,
[out,retval] IGameCollection **    ppIGameCollection
) 
 

Get a collection of all the official's IGame's in the schedule.

Parameters:
lID  The IOfficial's ID
Returns:
Returns a IGameCollection of all the official's IGame's in the schedule.
Example: 
    var oGame;
    var eGames = new Enumerator(schedule.getOfficialGames(official.ID));
    for (; !eGames.atEnd(); eGames.moveNext())
    {
        oGame = eGames.item();
        // do something with the IGame object
    }
See also:
IGame, IGameCollection, IOfficial

HRESULT IMasterSchedule::getPracticeGames (  [out,retval] IGameCollection **    ppIGameCollection ) 
 

Get a collection of all the practice IGame's in the schedule.

Returns:
Returns a IGameCollection of all the practice IGame's in the schedule.
Example: 
    var obj;
    var eItems = new Enumerator(schedule.getPracticeGames());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
IGame, IGameCollection

HRESULT IMasterSchedule::getSeasonGames (  [out,retval] IGameCollection **    ppIGameCollection ) 
 

Get a collection of all the season (round-robin) IGame's in the schedule.

Returns:
Returns a IGameCollection of all the season IGame's in the schedule.
Example: 
    var obj;
    var eItems = new Enumerator(masterschedule.getSeasonGames());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
IGame, IGameCollection

HRESULT IMasterSchedule::getTeamGames (  [in] long    lID,
[out,retval] IGameCollection **    ppIGameCollection
) 
 

Get a collection of all the team's IGame's in the schedule.

Parameters:
lID  The ITeam's ID
Returns:
Returns a IGameCollection of all the team's IGame's in the schedule.
Example: 
    var oGame;
    var eGames = new Enumerator(schedule.getTeamGames(team.ID));
    for (; !eGames.atEnd(); eGames.moveNext())
    {
        oGame = eGames.item();
        // do something with the IGame object
    }
See also:
IGame, IGameCollection, ITeam

HRESULT IMasterSchedule::getTournamentGames (  [out,retval] IGameCollection **    ppIGameCollection ) 
 

Get a collection of all the tournament IGame's in the schedule.

Returns:
Returns a IGameCollection of all the tournament IGame's in the schedule.
Example: 
    var obj;
    var eItems = new Enumerator(schedule.getTournamentGames());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
IGame, IGameCollection

HRESULT IMasterSchedule::getVenueGames (  [in] long    lID,
[out,retval] IGameCollection **    ppIGameCollection
) 
 

Get a collection of all the venue's IGame's in the schedule.

Parameters:
lID  The IVenue's ID
Returns:
Returns a IGameCollection of all the venue's IGame's in the schedule.
Example: 
    var oGame;
    var eGames = new Enumerator(schedule.getVenueGames(venue.ID));
    for (; !eGames.atEnd(); eGames.moveNext())
    {
        oGame = eGames.item();
        // do something with the IGame object
    }
See also:
IGame, IGameCollection, IVenue

HRESULT IMasterSchedule::queryEvents (  [in] int    iGameType,
[in] DATE    dtStartTime,
[in] DATE    dtEndTime,
[in] long    lLeagueID,
[in] long    lDivisionID,
[in] long    lTeamID,
[in] long    lVenueID,
[in] long    lOfficialID,
[in] int    iSortType,
[in] BOOL    fInclusive,
[out,retval] IGameCollection **    ppIGameCollection
) 
 

Get a collection of IGame's that match the query in the schedule.

Parameters:
iGameType  The type of game this represents. This can be one of the following values:
1Season Games
2Practice Games
4Tournament Games
8Any type of game
dtStartTime  The first date to start looking for games. Only games starting on or after this date and time will be returned. If the fInclusive parameter is set to false, only games starting AFTER the specified dtStartTime will be returned.
dtEndTime  The last date to look for matching games.
lLeagueID  Specify a valid ILeague ID to only return games associated with the league, or set to -1 to match any league.
lDivisionID  Specify a valid IDivision ID to only return games associated with the division, or set to -1 to match any division. A ILeague ID must be specified if specifying a IDivision ID.
lTeamID  Specify a valid ITeam ID to only return games associated with the team, or set to -1 to match any team.
lVenueID  Specify a valid IVenue ID to only return games associated with the venue, or set to -1 to match any venue.
lOfficialID  Specify a valid IOfficial ID to only return games associated with the official, or set to -1 to match any official.
iSortType  Specifies the way the games are sorted. The following values are supported:
0No Sort
1Sort based on Start Time
2Sort based on End Time
3Sort by Home Team name
4Sort by Away Team name
5Sort by League name
6Sort by Venue name
7Sort by Home Score
8Sort by Away Score
fInclusive  Set to true to return games starting on or after the specified dtStartTime, or false to return only games starting after the specified dtStartTime.
Returns:
Returns a IGameCollection of IGames that match the query.
Example: To return all the games in the schedule between a certain date range: 
    var oGame;
    var dateStart = new Date("11/1/2001");
    var dateEnd = new Date("11/30/2001");
    var eGames = new Enumerator(schedule.queryEvents(8,dateStart,dateEnd,-1,-1,-1,-1,-1,1,true));
    for (; !eGames.atEnd(); eGames.moveNext())
    {
        oGame = eGames.item();
        // do something with the IGame object
    }
See also:
IGame, IGameCollection, ILeague, IDivision, ITeam, IVenue, IOfficial

Galactix Home | Main Page | Class Hierarchy | Data Structures | Function List

Copyright © 1996-2007, Galactix Software. All rights reserved.
Questions? Comments? Send email to support@galactix.com