public interface Convocation extends OsidGovernator
A Convocation
is a set of Awards
to be
conferred.
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.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
IdList getAwardIds()
Ids
of the awards. Ids
mandatory
- This method must be implemented. AwardList getAwards() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasTimePeriod()
true
if a time period exists, false
otherwisemandatory
- This method must be implemented. Id getTimePeriodId()
Id
of the time period. Id
IllegalStateException
- hasTimePeriod()
is false
mandatory
- This method must be implemented. TimePeriod getTimePeriod() throws OperationFailedException
IllegalStateException
- hasTimePeriod()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getDate()
IllegalStateException
- hasTimePeriod()
is true
mandatory
- This method must be implemented. ConvocationRecord getConvocationRecord(Type convocationRecordType) throws OperationFailedException
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
.convocationRecordType
- the type of convocation record to
retrieveNullArgumentException
- convocationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(convocationRecordType)
is false
mandatory
- This method must be implemented.