OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.Resource
Implementsosid.OsidObject
Description

A Resource represents an arbitrary entity. Resources are used to define an object to accompany an OSID Id used in other OSIDs. A resource may be used to represent a meeting room in the Scheduling OSID, or a student in the Course OSID.

A Resource may also represent a group or organization. A provider may present such a group in an opaque manner through a single resource definition, or the provider may expose the resource collection for examination or manipulation. If such a resource collection is visible, isGroup() is true and can be used in one of the group sessions available in this OSID.

MethodisGroup
Description

Tests if this resource is a group. A resource that is a group can be used in the group sessions.

Returnboolean true if this resource is a group, false otherwise
CompliancemandatoryThis method must be implemented.
MethodisDemographic
Description

Tests if this resource is a demographic. A resource that is a demographic can be used in the demographic service and the group sessions.

Returnboolean true if this resource is a demographic, false otherwise
CompliancemandatoryThis method must be implemented.
MethodhasAvatar
Description

Tests if this resource has an avatar.

Returnboolean true if this resource has an avatar, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAvatarId
Description

Gets the asset Id.

Returnosid.id.Idthe asset Id
ErrorsILLEGAL_STATE hasAvatar() is false
CompliancemandatoryThis method must be implemented.
MethodgetAvatar
Description

Gets the asset.

Returnosid.repository.Assetthe asset
ErrorsILLEGAL_STATE hasAvatar() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetResourceRecord
Description

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

Parametersosid.type.TyperesourceRecordTypethe resource record type
Returnosid.resource.records.ResourceRecordthe resource record
ErrorsNULL_ARGUMENT resourceRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(resourceRecordType) is false
CompliancemandatoryThis method must be implemented.