Conferral
A Conferral represents an
Award conferred to a
Recipient for something (reference).
Often, an award is conferred for a body of work. The
body of work may be represented by another
OsidObject, such as an Asset
or an Assessment may be related using an
Id. The recipiens is the
Resource to whom the award is addressed
is often the producer or creator of the work. In some
instances, the Resource and the reference
may be one in the same.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
awardId |
id | the subscriber Id |
|
award |
Award | the subscriber's award. | |
recipientId |
id | the resource Id |
|
recipient |
Resource | the resource | |
hasReference |
boolean | true if a reference exists, false otherwise |
|
referenceId |
id | the reference Id |
|
hasConvocation |
boolean | true if a convocation exists, false otherwise |
|
convocationId |
id | the convocation Id |
|
convocation |
Convocation | the convocation |
Award
An Award is something that can be
conferred.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
Convocation
A Convocation is a set of
Awards to be conferred.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| Name | Syntax | Many | Description |
|---|---|---|---|
sponsorIds |
id | ⋆ | the sponsor Ids |
sponsors |
Resource | ⋆ | the sponsors |
awardIds |
id | ⋆ | the award Ids |
awards |
Award | ⋆ | the awards |
hasTimePeriod |
boolean | true if a time period exists, false otherwise |
|
timePeriodId |
id | the time period Id |
|
timePeriod |
TimePeriod | the time period | |
date |
datetime | the awards date |
Academy
An Academy represents a collection of
awards and conferrals. Like all OSID objects, a
Academy is identified by its
Id and any persisted references should
use the Id.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Sourceable | |||
providerId |
id | the provider Id |
|
provider |
Resource | the provider | |
brandingIds |
id | ⋆ | a list of asset Ids |
branding |
Asset | ⋆ | a list of assets |
license |
displaytext | the license | |