Interface | osid.resource.ResourceForm | ||
---|---|---|---|
Implements | osid.OsidObjectForm | ||
Description |
This is the form for creating and updating Resources can be designated as a group. The group metadata indicates if it is possible to convert a resource to a group and vice-versa. | ||
Method | getGroupMetadata | ||
Description |
Gets the metadata for a group. | ||
Return | osid.Metadata | metadata for the group | |
Compliance | mandatory | This method must be implemented. | |
Method | setGroup | ||
Description |
Sets the resource as a group. | ||
Parameters | boolean | group | true if this resource is a group, false
otherwise |
Errors | INVALID_ARGUMENT | group is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearGroup | ||
Description |
Clears the group designation. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getAvatarMetadata | ||
Description |
Gets the metadata for an asset. | ||
Return | osid.Metadata | metadata for the asset | |
Compliance | mandatory | This method must be implemented. | |
Method | setAvatar | ||
Description |
Sets the avatar asset. | ||
Parameters | osid.id.Id | assetId | an asset Id |
Errors | INVALID_ARGUMENT | assetId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearAvatar | ||
Description |
Clears the asset. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | resourceRecordType | the resource record type |
Return | osid.resource.records.ResourceFormRecord | the resource form record | |
Errors | NULL_ARGUMENT | resourceRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(resourceRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |