OSID Logo
OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.ReplyForm
Implementsosid.OsidObjectForm
osid.OsidContainableForm
osid.OsidSubjugateableForm
Description

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

MethodgetTimestampMetadata
Description

Gets the metadata for the timestamp.

Returnosid.Metadatametadata for the timestamp
CompliancemandatoryThis method must be implemented.
MethodsetTimestamp
Description

Sets the timestamp.

Parametersosid.calendaring.DateTimetimestampthe new timestamp
ErrorsINVALID_ARGUMENT timestamp is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT timestamp is null
CompliancemandatoryThis method must be implemented.
MethodclearTimestamp
Description

Clears the poster.

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

Gets the metadata for the poster.

Returnosid.Metadatametadata for the poster
CompliancemandatoryThis method must be implemented.
MethodsetPoster
Description

Sets the poster.

Parametersosid.id.IdresourceIdthe new poster
ErrorsINVALID_ARGUMENT resourceId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearPoster
Description

Clears the poster.

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

Gets the metadata for the subject line.

Returnosid.Metadatametadata for the subject line
CompliancemandatoryThis method must be implemented.
MethodsetSubjectLine
Description

Sets the subject line.

ParametersstringsubjectLinethe new subject line
ErrorsINVALID_ARGUMENT subjectLine is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT subjectLine is null
CompliancemandatoryThis method must be implemented.
MethodclearSubjectLine
Description

Clears the subject line.

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

Gets the metadata for the text.

Returnosid.Metadatametadata for the text
CompliancemandatoryThis method must be implemented.
MethodsetText
Description

Sets the text.

Parametersstringtextthe new text
ErrorsINVALID_ARGUMENT text is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT text is null
CompliancemandatoryThis method must be implemented.
MethodclearText
Description

Clears the text.

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

Gets the ReplyFormRecord corresponding to the given reply record Type.

Parametersosid.type.TypereplyRecordTypethe reply record type
Returnosid.forum.records.ReplyFormRecordthe reply form record
ErrorsNULL_ARGUMENT replyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(replyRecordType) is false
CompliancemandatoryThis method must be implemented.