org.osid.recognition

Interface Convocation

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject, Sourceable

public interface Convocation
extends OsidGovernator

A Convocation is a set of Awards to be conferred.

Method Summary

Methods

Modifier and Type	Method and Description
IdList	getAwardIds() Gets the Ids of the awards.
AwardList	getAwards() Gets the awards.
ConvocationRecord	getConvocationRecord(Type convocationRecordType) Gets the convocation record corresponding to the given Convocation record Type.
DateTime	getDate() Gets the date the awards in this convocation are to be conferred.
TimePeriod	getTimePeriod() .Gets the time period.
Id	getTimePeriodId() Gets the Id of the time period.
boolean	hasTimePeriod() Tests if the convocation confers awards for a period of time.

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.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getAwardIds

IdList getAwardIds()

Gets the Ids of the awards.

Returns:

the award Ids

Compliance:

mandatory - This method must be implemented.

getAwards

AwardList getAwards()
                    throws OperationFailedException

Gets the awards.

Returns:

the awards

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasTimePeriod

boolean hasTimePeriod()

Tests if the convocation confers awards for a period of time.

Returns:

true if a time period exists, false otherwise

Compliance:

mandatory - This method must be implemented.

getTimePeriodId

Id getTimePeriodId()

Gets the Id of the time period.

Returns:

the time period Id

Throws:

IllegalStateException - hasTimePeriod() is false

Compliance:

mandatory - This method must be implemented.

getTimePeriod

TimePeriod getTimePeriod()
                         throws OperationFailedException

.Gets the time period.

Returns:

the time period

Throws:

IllegalStateException - hasTimePeriod() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getDate

DateTime getDate()

Gets the date the awards in this convocation are to be conferred.

Returns:

the awards date

Throws:

IllegalStateException - hasTimePeriod() is true

Compliance:

mandatory - This method must be implemented.

getConvocationRecord

ConvocationRecord getConvocationRecord(Type convocationRecordType)
                                       throws OperationFailedException

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

Parameters:

convocationRecordType - the type of convocation record to retrieve

Returns:

the convocation record

Throws:

NullArgumentException - convocationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(convocationRecordType) is false

Compliance:

mandatory - This method must be implemented.