Interface Product

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Product
extends OsidObject

A Product represents something ordered.

Method Summary

Modifier and Type	Method	Description
long	getAvailability()	Gets the availability.
String	getCode()	Gets the product code.
IdList	getPriceScheduleIds()	Gets the price schedule Ids .
PriceScheduleList	getPriceSchedules()	Gets the price schedules.
ProductRecord	getProductRecord(Type productRecordType)	Gets the product record corresponding to the given Product record Type .This method is used to retrieve an object implementing the requested record.
boolean	hasAvailability()	Tests if an availability is available for this product.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Method Details

getCode

String getCode()

Gets the product code.

Returns:

a product code

Compliance:

mandatory - This method must be implemented.

getPriceScheduleIds

IdList getPriceScheduleIds()

Gets the price schedule Ids .

Returns:

a price schedule Id

Compliance:

mandatory - This method must be implemented.

getPriceSchedules

PriceScheduleList getPriceSchedules()
                             throws OperationFailedException

Gets the price schedules.

Returns:

the price schedules

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasAvailability

boolean hasAvailability()

Tests if an availability is available for this product.

Returns:

true if an available is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAvailability

long getAvailability()

Gets the availability.

Returns:

the availability

Throws:

IllegalStateException - hasAvailability() is false

Compliance:

mandatory - This method must be implemented.

getProductRecord

ProductRecord getProductRecord(Type productRecordType)
                        throws OperationFailedException

Gets the product record corresponding to the given Product record Type .This method is used to retrieve an object implementing the requested record. The productRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(productRecordType) is true .

Parameters:

productRecordType - the type of product record to retrieve

Returns:

the product record

Throws:

NullArgumentException - productRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(productRecordType) is false

Compliance:

mandatory - This method must be implemented.