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

IDivision Interface Reference

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

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

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

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

Detailed Description

The IDivision object.

Use the IDivision object to get it's teams and the league it belongs to. Do not create this object directly, instead use the getDivision or getDivisions methods from the IProject, ILeague, or ITeam objects.

Program ID: TSSSX.Division

Example: 

    var eDivisions = new Enumerator(league.getDivisions());
    for (; !eDivisions.atEnd(); eDivisions.moveNext())
    {
        oDivision = eDivisions.item();

        // do something with the IDivision object
        Response.Write("The division: '" + oDivision.Name + "' has: " + 
            oDivision.getNumOfTeams() + " teams";
    }

See also:
IProject, ILeague, ITeam

Member Function Documentation

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

Get the Comment property of this object as a String.

Example: 

    var sComment = obj.Comment;

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

Get the ID property of this object as a long.

Example: 

    var iID = obj.ID;

HRESULT IDivision::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 division.
Example: 
    var league = Project.getLeague(schedule.LeagueID);
    if (league != null)
    {
        // do something with the league
    }

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

Get the Name property of this object as a String.

Example: 

    var sName = obj.Name;

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

Get the ILeague which owns this division.

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

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

Get the number of ITeam's in the division.

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

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

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

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

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