OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.DirectionForm
Implementsosid.OsidObjectForm
osid.OsidSubjugateableForm
Description

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

MethodgetProceduresMetadata
Description

Gets the metadata for the procedures.

Returnosid.Metadatametadata for the procedures
CompliancemandatoryThis method must be implemented.
MethodsetProcedures
Description

Sets the procedures.

Parametersosid.id.Id[]procedureIdsthe new procedures
ErrorsINVALID_ARGUMENT procedureIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT procedureIds is null
CompliancemandatoryThis method must be implemented.
MethodclearProcedures
Description

Removes the procedures.

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

Gets the metadata for the estimated duration.

Returnosid.Metadatametadata for the estimated duration
CompliancemandatoryThis method must be implemented.
MethodsetEstimatedDuration
Description

Sets the estimated duration.

Parametersosid.calendaring.Durationdurationthe new estimated duration
ErrorsINVALID_ARGUMENT duration is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT duration is null
CompliancemandatoryThis method must be implemented.
MethodclearEstimatedDuration
Description

Removes the estimated duration.

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

Gets the metadata for the assets.

Returnosid.Metadatametadata for the assets
CompliancemandatoryThis method must be implemented.
MethodsetAssets
Description

Sets the assets.

Parametersosid.id.Id[]assetIdsthe new assets
ErrorsINVALID_ARGUMENT assetIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT assetIds is null
CompliancemandatoryThis method must be implemented.
MethodclearAssets
Description

Removes the assets.

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

Gets the DirectionFormRecord corresponding to the given direction record Type.

Parametersosid.type.TypedirectionRecordTypea direction record type
Returnosid.recipe.records.DirectionFormRecordthe direction form record
ErrorsNULL_ARGUMENT directionRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(directionRecordType) is false
CompliancemandatoryThis method must be implemented.