OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.OfferingForm
Implementsosid.OsidRelationshipForm
Description

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

MethodgetTitleMetadata
Description

Gets the metadata for a title.

Returnosid.Metadatametadata for the title
CompliancemandatoryThis method must be implemented.
MethodsetTitle
Description

Sets the title.

Parametersstringtitlethe title
ErrorsINVALID_ARGUMENT title is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT title is null
CompliancemandatoryThis method must be implemented.
MethodclearTitle
Description

Clears the title.

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

Gets the metadata for a given name.

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

Sets the code.

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

Clears the code.

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

Gets the metadata for the grading options.

Returnosid.Metadatametadata for the prerequisite information
CompliancemandatoryThis method must be implemented.
MethodsetResultOptions
Description

Sets the grading options.

Parametersosid.id.Id[]gradeSystemIdsthe new grading options
ErrorsINVALID_ARGUMENT gradeSystemIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT gradeSystemIds is null
CompliancemandatoryThis method must be implemented.
MethodclearResultOptions
Description

Removes the grading options.

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

Gets the metadata for the sponsors.

Returnosid.Metadatametadata for the sponsors
CompliancemandatoryThis method must be implemented.
MethodsetSponsors
Description

Sets the sponsors.

Parametersosid.id.Id[]sponsorIdsthe new sponsors
ErrorsINVALID_ARGUMENT sponsorIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT sponsorIds is null
CompliancemandatoryThis method must be implemented.
MethodclearSponsors
Description

Removes the sponsors.

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

Gets the OfferingFormRecord interface corresponding to the given offering record Type.

Parametersosid.type.TypeofferingRecordTypethe offering record type
Returnosid.offering.records.OfferingFormRecordthe record
ErrorsNULL_ARGUMENT offeringRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(offeringRecordType) is false
CompliancemandatoryThis method must be implemented.