OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.ActivityForm
Implementsosid.OsidObjectForm
osid.OsidFederateableForm
osid.OsidTemporalForm
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.

MethodgetOrganizationMetadata
Description

Gets the metadata for the organization.

Returnosid.Metadatametadata for the organization
CompliancemandatoryThis method must be implemented.
MethodsetOrganization
Description

Sets the organization.

Parametersosid.id.IdorganizationIdthe new organization
ErrorsINVALID_ARGUMENT organizationId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT organizationId is null
CompliancemandatoryThis method must be implemented.
MethodclearOrganization
Description

Removes the organization.

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

Gets the metadata for the supervisor.

Returnosid.Metadatametadata for the supervisor
CompliancemandatoryThis method must be implemented.
MethodsetSupervisor
Description

Sets the supervisor.

Parametersosid.id.IdsupervisorIdthe new supervisor
ErrorsINVALID_ARGUMENT supervisorId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT supervisorId is null
CompliancemandatoryThis method must be implemented.
MethodclearSupervisor
Description

Removes the supervisor.

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

Gets the metadata for the code flag.

Returnosid.Metadatametadata for the code
CompliancemandatoryThis method must be implemented.
MethodsetCode
Description

Sets the code.

Parametersstringcodethe new code
ErrorsINVALID_ARGUMENT code is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearCode
Description

Removes the code.

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.financials.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.