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

IOfficial Interface Reference

The IOfficial 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 getNumOfContacts ([out, retval] long *plNum)
 Get the number of IContact's for the official. More...

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

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

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

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


Detailed Description

The IOfficial object.

The IOfficial object represents a person who officiates a game. Use this object to get information about a particular official. Do not create the object directly, instead use the getOffical or getOfficials() methods from the IProject, IGame, ISeasonSchedule, or ITournamentSchedule objects.

Program ID: TSSSX.Official

Example:

    var eOfficials = new Enumerator(game.getOfficials());
    for (; !eOfficials.atEnd(); eOfficials.moveNext())
    {
        oOfficial = eOfficials.item();

        // do something with the IOfficial object
        Response.WriteLine(oOfficial.Name + " position: " + 
            game.getPosition(oOfficial.ID));
    }

See also:
IProject, IGame, ISeasonSchedule, ITournamentSchedule


Member Function Documentation

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

Get the Comment property of this object as a String.

Example:

    var sComment = obj.Comment;

HRESULT IOfficial::Description [out, retval] BSTR *    pVal
 

Get the Description property of this object as a String.

Example:

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

HRESULT IOfficial::ID [out, retval] long *    pVal
 

Get the ID property of this object as a long.

Example:

    var iID = obj.ID;

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

Get the Name property of this object as a String.

Example:

    var sName = obj.Name;

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

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

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

HRESULT IOfficial::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(official.getMasterSchedules());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
IMasterSchedule, IMasterScheduleCollection

HRESULT IOfficial::getNumOfContacts [out,retval] long *    plNum
 

Get the number of IContact's for the official.

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

HRESULT IOfficial::getNumOfSponsors [out,retval] long *    plNum
 

Get the number of ISponsor's for the official.

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

HRESULT IOfficial::getSponsors [out,retval] ISponsorCollection **    ppICollection
 

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

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


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