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

IPracticeSchedule Interface Reference

The IPracticeSchedule 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 StartDate ([out, retval] DATE *pVal)
 Get the StartDate property of this object as a DATE. More...

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

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

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

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

HRESULT getMasterSchedule ([out, retval] IMasterSchedule **ppIMasterSchedule)
 Get the IMasterSchedule for this schedule. More...

HRESULT getLeague ([out, retval] ILeague **ppILeague)
 Get the ILeague for this schedule. More...

HRESULT getNumOfTeams ([out, retval] long *plNum)
 Get the number of ITeam's in the schedule. More...

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

HRESULT getNumOfScheduledGames ([out, retval] long *plNum)
 Get the number of scheduled IGame's in the schedule. More...

HRESULT getNumOfUnscheduledGames ([out, retval] long *plNum)
 Get the number of unscheduled IGame's in the schedule. More...

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

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

HRESULT getTeams ([out, retval] ITeamCollection **ppICollection)
 Get a collection of all the ITeam's in the schedule. More...

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

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

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

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

HRESULT getVenueGames ([in] long lVenueID,[out, retval] IGameCollection **ppICollection)
 Get a collection of all the venue's IGame's 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 IPracticeSchedule object.

The IPracticeSchedule object represents a practice schedule (one in which the home and away teams are the same) in the project. Use this object to get the games, settings, and other information relavant to the practice schedule. Do not create this object directly, instead use the getPracticeSchedule() or getPracticeSchedules() methods of the IProject, ILeague, or ITeam object.

Program ID: TSSSX.PracticeSchedule

Example: 

    var eSchedules = new Enumerator(league.getPracticeSchedules());
    for (; !eSchedules.atEnd(); eSchedules.moveNext())
    {
        oSchedule = eSchedules.item();

        // do something with the IPracticeSchedule object
        Response.WriteLine("There are " + oSchedule.getNumOfGames() + 
            " games in the practice schedule '" + oSchedule.Name + "'");
    }

See also:
IProject, ILeague, ITeam

Member Function Documentation

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

Get the Comment property of this object as a String.

Example: 

    var sComment = obj.Comment;

HRESULT IPracticeSchedule::EndDate (  [out, retval] DATE *    pVal ) 
 

Get the EndDate property of this object as a DATE.

Example: 

    var end = new Date(schedule.EndDate);
    Response.Write(end);

HRESULT IPracticeSchedule::GameDurationMinutes (  [out, retval] long *    pVal ) 
 

Get the GameDurationMinutes property of this object as an long.

The GameDurationMinutes property returns the game duration in minutes. If a game is 2 hours, the number of minutes returned would be 120.

Returns:
Returns the number of minutes a game takes to play.
Example: 
    var iHours,iMinutes;

    iHours = schedule.GameDurationMinutes/60;
    iMinutes = schedule.GameDurationMinutes%60;

    Response.Write("The game duration is " + iHours + " hours, " + iMinutes + " minutes.");

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

Get the ID property of this object as a long.

Example: 

    var iID = obj.ID;

HRESULT IPracticeSchedule::LeagueID (  [out, retval] long *    pVal ) 
 

Get the LeagueID property of this object as a long.

Returns:
Returns the ILeague's league ID associated with this schedule.
Example: 
    var league = Project.getLeague(schedule.LeagueID);
    if (league != null)
    {
        // do something with the league
    }

HRESULT IPracticeSchedule::MasterScheduleID (  [out, retval] long *    pVal ) 
 

Get the MasterScheduleID property of this object as a long.

Returns:
Returns the IMasterSchedule's ID associated with this schedule.
Example: 
    var masterschedule = Project.getMasterSchedule(schedule.MasterScheduleID);
    if (masterschedule != null)
    {
        // do something with the masterschedule
    }

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

Get the Name property of this object as a String.

Example: 

    var sName = obj.Name;

HRESULT IPracticeSchedule::StartDate (  [out, retval] DATE *    pVal ) 
 

Get the StartDate property of this object as a DATE.

Example: 

    var start = new Date(schedule.StartDate);
    Response.Write(start);

HRESULT IPracticeSchedule::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 IPracticeSchedule::getGames (  [out,retval] IGameCollection **    ppICollection ) 
 

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(schedule.getGames());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
IGame, IGameCollection

HRESULT IPracticeSchedule::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 IPracticeSchedule::getLeague (  [out,retval] ILeague **    ppILeague ) 
 

Get the ILeague for this schedule.

Returns:
Returns the ILeague object associated with this schedule.
Example: 
    var league = schedule.getLeague();
    if (league != null)
    {
        // do something with the league
    }
See also:
ILeague

HRESULT IPracticeSchedule::getMasterSchedule (  [out,retval] IMasterSchedule **    ppIMasterSchedule ) 
 

Get the IMasterSchedule for this schedule.

Returns:
Returns the IMasterSchedule object for this schedule.
Example: 
    var schedule = schedule.getMasterSchedule();
    if (schedule != null)
    {
        // do something with the league
    }
See also:
ILeague

HRESULT IPracticeSchedule::getNumOfGames (  [out,retval] long *    plNum ) 
 

Get the number of IGame's in the schedule.

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

HRESULT IPracticeSchedule::getNumOfScheduledGames (  [out,retval] long *    plNum ) 
 

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

Returns:
Returns the number of scheduled IGame's in the schedule.
Example: 
    var iNum = schedule.getNumOfScheduledGames();

HRESULT IPracticeSchedule::getNumOfTeamGames (  [in] long    lTeamID,
[out,retval] long *    plNum
) 
 

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 IPracticeSchedule::getNumOfTeams (  [out,retval] long *    plNum ) 
 

Get the number of ITeam's in the schedule.

Returns:
Returns the number of ITeam's in the schedule.
Example: 
    var iNum = schedule.getNumOfTeams();

HRESULT IPracticeSchedule::getNumOfUnscheduledGames (  [out,retval] long *    plNum ) 
 

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

Returns:
Returns the number of unscheduled IGame's in the schedule.
Example: 
    var iNum = schedule.getNumOfUnscheduledGames();

HRESULT IPracticeSchedule::getNumOfVenueGames (  [in] long    lVenueID,
[out,retval] long *    plNum
) 
 

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 IPracticeSchedule::getScheduledGames (  [out,retval] IGameCollection **    ppICollection ) 
 

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

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

HRESULT IPracticeSchedule::getTeamGames (  [in] long    lTeamID,
[out,retval] IGameCollection **    ppICollection
) 
 

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 IPracticeSchedule::getTeams (  [out,retval] ITeamCollection **    ppICollection ) 
 

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

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

HRESULT IPracticeSchedule::getUnscheduledGames (  [out,retval] IGameCollection **    ppICollection ) 
 

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

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

HRESULT IPracticeSchedule::getVenueGames (  [in] long    lVenueID,
[out,retval] IGameCollection **    ppICollection
) 
 

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

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