Interface | osid.course.ActivityForm | ||
---|---|---|---|
Implements | osid.OsidRelationshipForm | ||
osid.OsidSubjugateableForm | |||
Description |
This is the form for creating and updating | ||
Method | getInstructorsMetadata | ||
Description |
Gets the metadata for the instructors. | ||
Return | osid.Metadata | metadata for the instructors | |
Compliance | mandatory | This method must be implemented. | |
Method | setInstructors | ||
Description |
Sets the instructors. | ||
Parameters | osid.id.Id[] | resourceIds | the new instructors |
Errors | INVALID_ARGUMENT | instructorIds is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | instructorIds is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearInstructors | ||
Description |
Removes the instructors. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getMinimumSeatsMetadata | ||
Description |
Gets the metadata for the minimum seats. | ||
Return | osid.Metadata | metadata for the minimum seats | |
Compliance | mandatory | This method must be implemented. | |
Method | setMinimumSeats | ||
Description |
Sets the minimum seating count. | ||
Parameters | cardinal | seats | the new minimum seats |
Errors | INVALID_ARGUMENT | seats is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumSeats | ||
Description |
Removes the minimum seats. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getMaximumSeatsMetadata | ||
Description |
Gets the metadata for the maximum seats. | ||
Return | osid.Metadata | metadata for the maximum seats | |
Compliance | mandatory | This method must be implemented. | |
Method | setMaximumSeats | ||
Description |
Sets the maximum seating count. | ||
Parameters | cardinal | seats | the new maximum seats |
Errors | INVALID_ARGUMENT | seats is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearMaximumSeats | ||
Description |
Removes the maximum seats. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getTotalEffortMatadata | ||
Description |
Gets the metadata for the total effort. The amount may be calculated from the other data. | ||
Return | osid.Metadata | metadata for the total effort | |
Compliance | mandatory | This method must be implemented. | |
Method | setTotalTargetEffort | ||
Description |
Sets the total effort. | ||
Parameters | osid.calendaring.Duration | time | the new total effort |
Errors | INVALID_ARGUMENT | time is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | time is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearTotalTargetEffort | ||
Description |
Removes the total effort. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getContactMetadata | ||
Description |
Gets the metadata for the contact flag. | ||
Return | osid.Metadata | metadata for the contact | |
Compliance | mandatory | This method must be implemented. | |
Method | setContact | ||
Description |
Sets the contact flag. | ||
Parameters | boolean | contact | the new contact flag |
Errors | INVALID_ARGUMENT | contact is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearContact | ||
Description |
Removes the contact flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getTotalTargetContactTimeMetadata | ||
Description |
Gets the metadata for the total contact time. | ||
Return | osid.Metadata | metadata for the total contact time | |
Compliance | mandatory | This method must be implemented. | |
Method | setTotalTargetContactTime | ||
Description |
Sets the total contact time. | ||
Parameters | osid.calendaring.Duration | time | the new total contact time |
Errors | INVALID_ARGUMENT | time is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | time is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearTotalTargetContactTime | ||
Description |
Removes the total contact time. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getTotalTargetIndividualEffortMetadata | ||
Description |
Gets the metadata for the total individual effort. The amount may be calculated from the other data. | ||
Return | osid.Metadata | metadata for the total individual effort | |
Compliance | mandatory | This method must be implemented. | |
Method | setTotalTargetIndividualEffort | ||
Description |
Sets the total individual effort. | ||
Parameters | osid.calendaring.Duration | time | the new total individual effort |
Errors | INVALID_ARGUMENT | time is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | time is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearTotalTargetIndividualEffort | ||
Description |
Removes the total individual effort. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecurringWeeklyMetadata | ||
Description |
Gets the metadata for the recurring weekly flag. | ||
Return | osid.Metadata | metadata for the contact | |
Compliance | mandatory | This method must be implemented. | |
Method | setRecurringWeekly | ||
Description |
Sets the recurring weekly flag. | ||
Parameters | boolean | recurring | the new recurring weekly flag |
Errors | INVALID_ARGUMENT | recurring is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearRecurringWeekly | ||
Description |
Removes the recurring weekly flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getWeeklyEffortMetadata | ||
Description |
Gets the metadata for the weekly effort. The amount may be calculated from the other data. | ||
Return | osid.Metadata | metadata for the weekly effort | |
Compliance | mandatory | This method must be implemented. | |
Method | setWeeklyEffort | ||
Description |
Sets the weekly effort. | ||
Parameters | osid.calendaring.Duration | time | the new weekly effort |
Errors | INVALID_ARGUMENT | time is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | time is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearWeeklyEffort | ||
Description |
Removes the weekly effort. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getWeeklyContactTimeMetadata | ||
Description |
Gets the metadata for the weekly contact time. | ||
Return | osid.Metadata | metadata for the weekly contact time | |
Compliance | mandatory | This method must be implemented. | |
Method | setWeeklyContactTime | ||
Description |
Sets the weekly contact time. | ||
Parameters | osid.calendaring.Duration | time | the new weekly contact time |
Errors | INVALID_ARGUMENT | time is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | time is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearWeeklyContactTime | ||
Description |
Removes the weekly contact time. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getWeeklyIndividualEffortMetadata | ||
Description |
Gets the metadata for the weekly individual effort. The amount may be calculated from the other data. | ||
Return | osid.Metadata | metadata for the weekly individual effort | |
Compliance | mandatory | This method must be implemented. | |
Method | setWeeklyIndividualEffort | ||
Description |
Sets the weekly individual effort. | ||
Parameters | osid.calendaring.Duration | time | the new weekly individual effort |
Errors | INVALID_ARGUMENT | time is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | time is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearWeeklyIndividualEffort | ||
Description |
Removes the weekly individual effort. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivityFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | activityRecordType | an activity record type |
Return | osid.course.records.ActivityFormRecord | the activity form record | |
Errors | NULL_ARGUMENT | activityRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(activityRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |