Class: TLicenseVendor

Declaration: LicenseProduct.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

The concrete class TLicenseVendor represents a software vendor. A vendor is identified by its unique identifier that is carried by this object. The identifier should be constructed using an algorithm that is guaranteed to make the identifier refer to only one vendor in this galaxy. The TLicenseProduct object also maintains vendor contact information that is meant to be human readable and localizable so that it can be presented to the user whenever necessary.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TLicenseVendor::TLicenseVendor

TLicenseVendor ()
TLicenseVendor (const TLicenseVendor &)
TLicenseVendor (const TLicenseVendorIdentifier & identifier, const TText & contactInfo)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Initializes internal data elements.

Calling Context:

Called by the stream-in operators.
Called to copy an object.
Called by the product, Licensing framework, and providers.

Parameters:

Takes no parameters.
const TLicenseVendor & -The object to copy.
const TLicenseVendorIdentifier & vendorIdentifier -The identifier for the vendor.
const TText & vendorContactInfo -The vendor contact information.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLicenseVendor::~TLicenseVendor

virtual ~ TLicenseVendor ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLicenseVendor::operator=

TLicenseVendor & operator =(const TLicenseVendor & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TLicenseVendor & source -The object to copy.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLicenseVendor::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws TInvalidVersionException if the version of the object is not recognized.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLicenseVendor::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLicenseVendor::GetIdentifier

virtual void GetIdentifier (TLicenseVendorIdentifier & target) const

Interface Category:

API.

Purpose:

Gets the unique identifier for the vendor represented by the object.

Calling Context:

Called to query object for its vendor identifier.

Parameters:

TLicenseVendorIdentifier & target -The storage where the identifier is copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLicenseVendor::GetContactInfo

virtual void GetContactInfo (TText & target) const

Interface Category:

API.

Purpose:

Gets the contact information from the vendor object. The contact information is the human-readable vendor description that the vendor would like presented to the user. This object is not used for matching and should be localized.

Calling Context:

Called to query an object for its vendor contact information.

Parameters:

TText & target -The storage where the contact information is copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.