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

ILeague Interface Reference

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

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

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

HRESULT Availability ([out, retval] IAvailability **pVal)
 Get the IAvailabiity object associated with this object. More...

HRESULT getNumOfSeasonSchedules ([out, retval] long *plNum)
 Get the number of ISeasonSchedule's for the league. More...

HRESULT getNumOfPracticeSchedules ([out, retval] long *plNum)
 Get the number of IPracticeSchedule's for the league. More...

HRESULT getNumOfDivisions ([out, retval] long *plNum)
 Get the number of IDivision's in the league. More...

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

HRESULT getNumOfSeasonVenues ([out, retval] long *plNum)
 Get the number of venues available for season games. More...

HRESULT getNumOfTournamentVenues ([out, retval] long *plNum)
 Get the number of venues available for tournament games. More...

HRESULT getNumOfPracticeVenues ([out, retval] long *plNum)
 Get the number of venues available for practice games. More...

HRESULT getNumOfContacts ([out, retval] long *plNum)
 Get the number of IContact's for the league. More...

HRESULT getNumOfSponsors ([out, retval] long *plNum)
 Get the number of ISponsor's for the league. More...

HRESULT getSeasonVenuePriority ([in] long lVenueID,[out, retval] long *plNum)
 Get the priority value for the specified season venue. More...

HRESULT getPracticeVenuePriority ([in] long lVenueID,[out, retval] long *plPriority)
 Get the priority value for the specified practice venue. More...

HRESULT getTournamentVenuePriority ([in] long lVenueID,[out, retval] long *plPriority)
 Get the priority value for the specified tournament venue. More...

HRESULT getSeasonSchedules ([out, retval] ISeasonScheduleCollection **ppICollection)
 Get a collection of all the ISeaonsSchedule's for the league. More...

HRESULT getPracticeSchedules ([out, retval] IPracticeScheduleCollection **ppICollection)
 Get a collection of all the IPracticeSchedule's for the league. More...

HRESULT getDivisions ([out, retval] IDivisionCollection **ppICollection)
 Get a collection of all the IDivision's in the league. More...

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

HRESULT getSeasonVenues ([out, retval] IVenueCollection **ppICollection)
 Get the collection of season IVenue's for this object. More...

HRESULT getPracticeVenues ([out, retval] IVenueCollection **ppICollection)
 Get the collection of practice IVenue's for this object. More...

HRESULT getTournamentVenues ([out, retval] IVenueCollection **ppICollection)
 Get the collection of tournament IVenue's for this object. More...

HRESULT getContacts ([out, retval] IContactCollection **ppICollection)
 Get a collection of all the IContact's for the league. More...

HRESULT getSponsors ([out, retval] ISponsorCollection **ppICollection)
 Get a collection of all the ISponsor's for the league. More...

HRESULT getMasterSchedules ([out, retval] IMasterScheduleCollection **ppICollection)
 Get a collection of all the IMasterSchedule's in the project. More...

Detailed Description

The ILeague object.

Use the ILeague object to access it's divisions, teams, season schedules and practice schedules in the project. Do not create this object directly, instead use the getLeague() or getLeagues() method in the IProject, IDivision, ITeam, IGame, ISeasonSchedule, or IPracticeSchedule object.

Program ID: TSSSX.League

Example: 

    var league = Project.getLeague(iLeagueID);
    if (league != null)
    {
        Response.Write(league.Name);
    }

See also:
IProject, IDivision, ITeam, IGame, ISeasonSchedule, IPracticeSchedule

Member Function Documentation

HRESULT ILeague::Availability (  [out, retval] IAvailability **    pVal ) 
 

Get the IAvailabiity object associated with this object.

Example: 

    if (obj.Availability.AlwaysAvailable)
    {
        Response.WriteLine("The object " + obj.Name + " is always available for game play.");
    }

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

Get the Comment property of this object as a String.

Example: 

    var sComment = obj.Comment;

HRESULT ILeague::Description (  [out, retval] BSTR *    pVal ) 
 

Get the Description property of this object as a String.

Example: 

    var sText = "The description is: '" + obj.Description + "'";

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

Get the ID property of this object as a long.

Example: 

    var iID = obj.ID;

HRESULT ILeague::ImagePathname (  [out, retval] BSTR *    pVal ) 
 

Get the ImagePathname property of this object as a String.

If specified, the ImagePathname is the filename of the image associated with this object. This may not point to the actual file on the hard drive. For example, during the website generation all the images are copied to the ProjectName-Web\images folder. The example below would point to the website generated image file.

Example: 

    var sImg = "";
    if (obj.ImagePathname != "")
        sImg = "<img src=\"images/\" + obj.ImagePathname + "\">";

HRESULT ILeague::LogoPathname (  [out, retval] BSTR *    pVal ) 
 

Get the LogoPathname property of this object as a String.

If specified, the LogoPathname is the filename of the logo image associated with this object. This may not point to the actual file on the hard drive. For example, during the website generation all the images are copied to the ProjectName-Web\images folder. The example below would point to the website generated image file.

Example: 

    var sImg = "";
    if (obj.ImagePathname != "")
        sImg = "<img src=\"images/\" + obj.LogoPathname + "\">";

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

Get the Name property of this object as a String.

Example: 

    var sName = obj.Name;

HRESULT ILeague::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 ILeague::getContacts (  [out,retval] IContactCollection **    ppICollection ) 
 

Get a collection of all the IContact's for the league.

Returns:
Returns a IContactCollection of all the IContact's for the league.
Example: 
    var obj;
    var eItems = new Enumerator(league.getContacts());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
IContact, IContactCollection

HRESULT ILeague::getDivisions (  [out,retval] IDivisionCollection **    ppICollection ) 
 

Get a collection of all the IDivision's in the league.

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

HRESULT ILeague::getMasterSchedules (  [out,retval] IMasterScheduleCollection **    ppICollection ) 
 

Get a collection of all the IMasterSchedule's in the project.

Returns:
Returns a IMasterScheduleCollection of all the IMasterSchedule's in the project.
Example: 
    var obj;
    var eItems = new Enumerator(league.getMasterSchedules());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
IMasterSchedule, IMasterScheduleCollection

HRESULT ILeague::getNumOfContacts (  [out,retval] long *    plNum ) 
 

Get the number of IContact's for the league.

Returns:
Returns the number of IContact's for the league.
Example: 
    var iNum = league.getNumOfContacts();

HRESULT ILeague::getNumOfDivisions (  [out,retval] long *    plNum ) 
 

Get the number of IDivision's in the league.

Returns:
Returns the number of IDivision's in the league.
Example: 
    var iNum = league.getNumOfDivisions();

HRESULT ILeague::getNumOfPracticeSchedules (  [out,retval] long *    plNum ) 
 

Get the number of IPracticeSchedule's for the league.

Returns:
Returns the number of IPracticeSchedule's for the league.
Example: 
    var iNum = league.getNumOfPracticeSchedules();

HRESULT ILeague::getNumOfPracticeVenues (  [out,retval] long *    plNum ) 
 

Get the number of venues available for practice games.

Returns:
Returns the number of venues specified for practice games.
Example: 
    Response.WriteLine("Fields available for practice games: " + obj.getNumOfPracticeVenues() );

HRESULT ILeague::getNumOfSeasonSchedules (  [out,retval] long *    plNum ) 
 

Get the number of ISeasonSchedule's for the league.

Returns:
Returns the number of ISeasonSchedule's for the league.
Example: 
    var iNum = league.getNumOfSeasonSchedules();

HRESULT ILeague::getNumOfSeasonVenues (  [out,retval] long *    plNum ) 
 

Get the number of venues available for season games.

Returns:
Returns the number of venues specified for season games.
Example: 
    Response.WriteLine("Season fields available for '" + obj.Name + 
        "' games: " + obj.getNumOfSeasonVenues() );

HRESULT ILeague::getNumOfSponsors (  [out,retval] long *    plNum ) 
 

Get the number of ISponsor's for the league.

Returns:
Returns the number of ISponsor's for the league.
Example: 
    var iNum = league.getNumOfSponsors();

HRESULT ILeague::getNumOfTeams (  [out,retval] long *    plNum ) 
 

Get the number of ITeam's in the league.

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

HRESULT ILeague::getNumOfTournamentVenues (  [out,retval] long *    plNum ) 
 

Get the number of venues available for tournament games.

Returns:
Returns the number of venues specified for tournament games.
Example: 
    Response.WriteLine("Fields available for tournament games: " + obj.getNumOfTournamentVenues() );

HRESULT ILeague::getPracticeSchedules (  [out,retval] IPracticeScheduleCollection **    ppICollection ) 
 

Get a collection of all the IPracticeSchedule's for the league.

Returns:
Returns a IPracticeScheduleCollection of all the IPracticeSchedule's for the league.
Example: 
    var obj;
    var eItems = new Enumerator(league.getPracticeSchedules());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
IPracticeSchedule, IPracticeScheduleCollection

HRESULT ILeague::getPracticeVenuePriority (  [in] long    lVenueID,
[out,retval] long *    plPriority
) 
 

Get the priority value for the specified practice venue.

Parameters:
lVenueID  The IVenue's ID
Returns:
Returns the priority value for the specified venue. This value will be between 0-9. A priority value of 9 means the venue will not be considered for game play. Priority 0 venues will be scheduled before priority 1 venues.
Example: 
    if (league.getPracticeVenuePriority(venue.ID) == 9)
    {
        Response.WriteLine("The venue '" + venue.Name + "' will not be considered for scheduling.");
    }

HRESULT ILeague::getPracticeVenues (  [out,retval] IVenueCollection **    ppICollection ) 
 

Get the collection of practice IVenue's for this object.

Returns:
Returns a IVenueCollection of all the practice IVenues for this object.
Example: 
    var eVenues = new Enumerator(league.getPracticeVenues());
    for (; !eVenues.atEnd(); eVenues.moveNext())
    {
        oVenue = eVenues.item();
        // do something with the IVenue
    }
See also:
IVenue, IVenueCollection

HRESULT ILeague::getSeasonSchedules (  [out,retval] ISeasonScheduleCollection **    ppICollection ) 
 

Get a collection of all the ISeaonsSchedule's for the league.

Returns:
Returns a ISeasonScheduleCollection of all the ISeaonsSchedule's for the league.
Example: 
    var obj;
    var eItems = new Enumerator(league.getSeaonsSchedules());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
ISeasonSchedule, ISeasonScheduleCollection

HRESULT ILeague::getSeasonVenuePriority (  [in] long    lVenueID,
[out,retval] long *    plNum
) 
 

Get the priority value for the specified season venue.

Parameters:
lVenueID  The IVenue's ID
Returns:
Returns the priority value for the specified venue. This value will be between 0-9. A priority value of 9 means the venue will not be considered for game play. Priority 0 venues will be scheduled before priority 1 venues.
Example: 
    if (league.getSeasonVenuePriority(venue.ID) == 9)
    {
        Response.WriteLine("The venue '" + venue.Name + "' will not be considered for scheduling.");
    }

HRESULT ILeague::getSeasonVenues (  [out,retval] IVenueCollection **    ppICollection ) 
 

Get the collection of season IVenue's for this object.

Returns:
Returns a IVenueCollection of all the season IVenues for this object.
Example: 
    var eVenues = new Enumerator(league.getSeasonVenues());
    for (; !eVenues.atEnd(); eVenues.moveNext())
    {
        oVenue = eVenues.item();
        // do something with the IVenue
    }
See also:
IVenue, IVenueCollection

HRESULT ILeague::getSponsors (  [out,retval] ISponsorCollection **    ppICollection ) 
 

Get a collection of all the ISponsor's for the league.

Returns:
Returns a ISponsorCollection of all the ISponsor's for the league.
Example: 
    var obj;
    var eItems = new Enumerator(league.getSponsors());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
ISponsor, ISponsorCollection

HRESULT ILeague::getTeams (  [out,retval] ITeamCollection **    ppICollection ) 
 

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

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

HRESULT ILeague::getTournamentVenuePriority (  [in] long    lVenueID,
[out,retval] long *    plPriority
) 
 

Get the priority value for the specified tournament venue.

Parameters:
lVenueID  The IVenue's ID
Returns:
Returns the priority value for the specified venue. This value will be between 0-9. A priority value of 9 means the venue will not be considered for game play. Priority 0 venues will be scheduled before priority 1 venues.
Example: 
    if (league.getPracticeVenuePriority(venue.ID) == 9)
    {
        Response.WriteLine("The venue '" + venue.Name + "' will not be considered for scheduling.");
    }

HRESULT ILeague::getTournamentVenues (  [out,retval] IVenueCollection **    ppICollection ) 
 

Get the collection of tournament IVenue's for this object.

Returns:
Returns a IVenueCollection of all the tournament IVenues for this object.
Example: 
    var eVenues = new Enumerator(league.getTournamentVenues());
    for (; !eVenues.atEnd(); eVenues.moveNext())
    {
        oVenue = eVenues.item();
        // do something with the IVenue
    }
See also:
IVenue, IVenueCollection

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