org.osid.voting

Interface Polls

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Polls
extends OsidCatalog

An inventory defines a collection of candidates.

Method Summary

Methods

Modifier and Type	Method and Description
PollsRecord	getPollsRecord(Type pollsRecordType) Gets the polls record corresponding to the given Polls record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getPollsRecord

PollsRecord getPollsRecord(Type pollsRecordType)
                           throws OperationFailedException

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

Parameters:

pollsRecordType - the polls record type

Returns:

the polls record

Throws:

NullArgumentException - pollsRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pollsRecordType) is false

Compliance:

mandatory - This method must be implemented.