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

ITeam Interface Reference

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

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

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

HRESULT getLeague ([out, retval] ILeague **ppILeague)
 Get the ILeague which owns this team. More...

HRESULT getDivision ([out, retval] IDivision **ppIDivision)
 Get the IDivision which owns this team. More...

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

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

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

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

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

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

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

HRESULT getSeasonVenuePriority ([in] long lVenueID,[out, retval] long *plPriority)
 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 **pplCollection)
 Get a collection of all the ISeaonsSchedule's for the team. More...

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

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

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

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

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

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

Detailed Description

The ITeam object.

Use the ITeam object to access the team's contacts, schedules, and other information. Do not create this object directly, instead use a getTeam or getTeams method from the IProject, ILeague, IDivision, IGame, IMasterSchedule, ISeasonSchedule, IPracticeSchedule, or ITournamentSchedule object.

Program ID: TSSSX.Team

Example: 

    var eTeams = new Enumerator(league.getTeams());
    for (; !eTeams.atEnd(); eTeams.moveNext())
    {
        oTeam = eTeams.item();

        // do something with the ITeam object
        Response.Write("The team: '" + oTeam.Name + "' is in the division: '" + 
            oTeam.getDivision().Name + "'";
    }

See also:
IProject, ILeague, IDivision, IGame, IMasterSchedule, ISeasonSchedule, IPracticeSchedule, ITournamentSchedule

Member Function Documentation

HRESULT ITeam::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 ITeam::Comment (  [out, retval] BSTR *    pVal ) 
 

Get the Comment property of this object as a String.

Example: 

    var sComment = obj.Comment;

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

Get the Description property of this object as a String.

Example: 

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

HRESULT ITeam::DivisionID (  [out, retval] long *    pVal ) 
 

Get the DivisionID property of this object as a long.

Returns:
Returns the IDivision's ID which owns this team.
Example: 
    var division = Project.getDivision(team.DivisionID);
    if (division != null)
    {
        // do something with the division
    }

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

Get the ID property of this object as a long.

Example: 

    var iID = obj.ID;

HRESULT ITeam::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 ITeam::LeagueID (  [out, retval] long *    pVal ) 
 

Get the LeagueID property of this object as a long.

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

HRESULT ITeam::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 ITeam::Name (  [out, retval] BSTR *    pVal ) 
 

Get the Name property of this object as a String.

Example: 

    var sName = obj.Name;

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

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

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

HRESULT ITeam::getDivision (  [out,retval] IDivision **    ppIDivision ) 
 

Get the IDivision which owns this team.

Returns:
Returns the IDivision object which owns this team.
Example: 
    var league = team.getDivision();
    if (league != null)
    {
        // do something with the league
    }
See also:
ILeague

HRESULT ITeam::getLeague (  [out,retval] ILeague **    ppILeague ) 
 

Get the ILeague which owns this team.

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

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

Get the number of IContact's for the team.

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

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

Get the number of IPracticeSchedule's for the team.

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

HRESULT ITeam::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 ITeam::getNumOfSeasonSchedules (  [out,retval] long *    plNum ) 
 

Get the number of ISeasonSchedule's for the team.

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

HRESULT ITeam::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 ITeam::getNumOfSponsors (  [out,retval] long *    plNum ) 
 

Get the number of ISponsor's for the team.

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

HRESULT ITeam::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 ITeam::getPracticeSchedules (  [out,retval] IPracticeScheduleCollection **    pplCollection ) 
 

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

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

HRESULT ITeam::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 (team.getPracticeVenuePriority(venue.ID) == 9)
    {
        Response.WriteLine("The venue '" + venue.Name + "' will not be considered for scheduling.");
    }

HRESULT ITeam::getPracticeVenues (  [out,retval] IVenueCollection **    pplCollection ) 
 

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(team.getPracticeVenues());
    for (; !eVenues.atEnd(); eVenues.moveNext())
    {
        oVenue = eVenues.item();
        // do something with the IVenue
    }
See also:
IVenue, IVenueCollection

HRESULT ITeam::getSeasonSchedules (  [out,retval] ISeasonScheduleCollection **    pplCollection ) 
 

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

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

HRESULT ITeam::getSeasonVenuePriority (  [in] long    lVenueID,
[out,retval] long *    plPriority
) 
 

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 (team.getSeasonVenuePriority(venue.ID) == 9)
    {
        Response.WriteLine("The venue '" + venue.Name + "' will not be considered for scheduling.");
    }

HRESULT ITeam::getSeasonVenues (  [out,retval] IVenueCollection **    pplCollection ) 
 

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(team.getSeasonVenues());
    for (; !eVenues.atEnd(); eVenues.moveNext())
    {
        oVenue = eVenues.item();
        // do something with the IVenue
    }
See also:
IVenue, IVenueCollection

HRESULT ITeam::getSponsors (  [out,retval] ISponsorCollection **    pplCollection ) 
 

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

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

HRESULT ITeam::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 (team.getPracticeVenuePriority(venue.ID) == 9)
    {
        Response.WriteLine("The venue '" + venue.Name + "' will not be considered for scheduling.");
    }

HRESULT ITeam::getTournamentVenues (  [out,retval] IVenueCollection **    pplCollection ) 
 

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(team.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