OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.ActivityForm
Implementsosid.OsidRelationshipForm
osid.OsidSubjugateableForm
Description

This is the form for creating and updating Activities. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ActivityAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetInstructorsMetadata
Description

Gets the metadata for the instructors.

Returnosid.Metadatametadata for the instructors
CompliancemandatoryThis method must be implemented.
MethodsetInstructors
Description

Sets the instructors.

Parametersosid.id.Id[]resourceIdsthe new instructors
ErrorsINVALID_ARGUMENT instructorIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT instructorIds is null
CompliancemandatoryThis method must be implemented.
MethodclearInstructors
Description

Removes the instructors.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetMinimumSeatsMetadata
Description

Gets the metadata for the minimum seats.

Returnosid.Metadatametadata for the minimum seats
CompliancemandatoryThis method must be implemented.
MethodsetMinimumSeats
Description

Sets the minimum seating count.

Parameterscardinalseatsthe new minimum seats
ErrorsINVALID_ARGUMENT seats is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearMinimumSeats
Description

Removes the minimum seats.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetMaximumSeatsMetadata
Description

Gets the metadata for the maximum seats.

Returnosid.Metadatametadata for the maximum seats
CompliancemandatoryThis method must be implemented.
MethodsetMaximumSeats
Description

Sets the maximum seating count.

Parameterscardinalseatsthe new maximum seats
ErrorsINVALID_ARGUMENT seats is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearMaximumSeats
Description

Removes the maximum seats.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetTotalEffortMatadata
Description

Gets the metadata for the total effort. The amount may be calculated from the other data.

Returnosid.Metadatametadata for the total effort
CompliancemandatoryThis method must be implemented.
MethodsetTotalTargetEffort
Description

Sets the total effort.

Parametersosid.calendaring.Durationtimethe new total effort
ErrorsINVALID_ARGUMENT time is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT time is null
CompliancemandatoryThis method must be implemented.
MethodclearTotalTargetEffort
Description

Removes the total effort.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetContactMetadata
Description

Gets the metadata for the contact flag.

Returnosid.Metadatametadata for the contact
CompliancemandatoryThis method must be implemented.
MethodsetContact
Description

Sets the contact flag.

Parametersbooleancontactthe new contact flag
ErrorsINVALID_ARGUMENT contact is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearContact
Description

Removes the contact flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetTotalTargetContactTimeMetadata
Description

Gets the metadata for the total contact time.

Returnosid.Metadatametadata for the total contact time
CompliancemandatoryThis method must be implemented.
MethodsetTotalTargetContactTime
Description

Sets the total contact time.

Parametersosid.calendaring.Durationtimethe new total contact time
ErrorsINVALID_ARGUMENT time is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT time is null
CompliancemandatoryThis method must be implemented.
MethodclearTotalTargetContactTime
Description

Removes the total contact time.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetTotalTargetIndividualEffortMetadata
Description

Gets the metadata for the total individual effort. The amount may be calculated from the other data.

Returnosid.Metadatametadata for the total individual effort
CompliancemandatoryThis method must be implemented.
MethodsetTotalTargetIndividualEffort
Description

Sets the total individual effort.

Parametersosid.calendaring.Durationtimethe new total individual effort
ErrorsINVALID_ARGUMENT time is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT time is null
CompliancemandatoryThis method must be implemented.
MethodclearTotalTargetIndividualEffort
Description

Removes the total individual effort.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetRecurringWeeklyMetadata
Description

Gets the metadata for the recurring weekly flag.

Returnosid.Metadatametadata for the contact
CompliancemandatoryThis method must be implemented.
MethodsetRecurringWeekly
Description

Sets the recurring weekly flag.

Parametersbooleanrecurringthe new recurring weekly flag
ErrorsINVALID_ARGUMENT recurring is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearRecurringWeekly
Description

Removes the recurring weekly flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetWeeklyEffortMetadata
Description

Gets the metadata for the weekly effort. The amount may be calculated from the other data.

Returnosid.Metadatametadata for the weekly effort
CompliancemandatoryThis method must be implemented.
MethodsetWeeklyEffort
Description

Sets the weekly effort.

Parametersosid.calendaring.Durationtimethe new weekly effort
ErrorsINVALID_ARGUMENT time is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT time is null
CompliancemandatoryThis method must be implemented.
MethodclearWeeklyEffort
Description

Removes the weekly effort.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetWeeklyContactTimeMetadata
Description

Gets the metadata for the weekly contact time.

Returnosid.Metadatametadata for the weekly contact time
CompliancemandatoryThis method must be implemented.
MethodsetWeeklyContactTime
Description

Sets the weekly contact time.

Parametersosid.calendaring.Durationtimethe new weekly contact time
ErrorsINVALID_ARGUMENT time is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT time is null
CompliancemandatoryThis method must be implemented.
MethodclearWeeklyContactTime
Description

Removes the weekly contact time.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetWeeklyIndividualEffortMetadata
Description

Gets the metadata for the weekly individual effort. The amount may be calculated from the other data.

Returnosid.Metadatametadata for the weekly individual effort
CompliancemandatoryThis method must be implemented.
MethodsetWeeklyIndividualEffort
Description

Sets the weekly individual effort.

Parametersosid.calendaring.Durationtimethe new weekly individual effort
ErrorsINVALID_ARGUMENT time is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT time is null
CompliancemandatoryThis method must be implemented.
MethodclearWeeklyIndividualEffort
Description

Removes the weekly individual effort.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetActivityFormRecord
Description

Gets the ActivityFormRecord corresponding to the given activity record Type.

Parametersosid.type.TypeactivityRecordTypean activity record type
Returnosid.course.records.ActivityFormRecordthe activity form record
ErrorsNULL_ARGUMENT activityRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityRecordType) is false
CompliancemandatoryThis method must be implemented.