Interface | osid.blogging.EntryForm | ||
---|---|---|---|
Implements | osid.OsidObjectForm | ||
osid.OsidSourceableForm | |||
Description |
This is the form for creating and updating | ||
Method | getTimestampMetadata | ||
Description |
Gets the metadata for the timestamp. | ||
Return | osid.Metadata | metadata for the timestamp | |
Compliance | mandatory | This method must be implemented. | |
Method | setTimestamp | ||
Description |
Sets the timestamp. | ||
Parameters | osid.calendaring.DateTime | timestamp | the new timestamp |
Errors | INVALID_ARGUMENT | timestamp is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | timestamp is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearTimestamp | ||
Description |
Clears the poster. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getPosterMetadata | ||
Description |
Gets the metadata for the poster. | ||
Return | osid.Metadata | metadata for the poster | |
Compliance | mandatory | This method must be implemented. | |
Method | setPoster | ||
Description |
Sets the poster. | ||
Parameters | osid.id.Id | resourceId | the new poster |
Errors | INVALID_ARGUMENT | resourceId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | resourceId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearPoster | ||
Description |
Clears the poster. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubjectLineMetadata | ||
Description |
Gets the metadata for the subject line. | ||
Return | osid.Metadata | metadata for the subject line | |
Compliance | mandatory | This method must be implemented. | |
Method | setSubjectLine | ||
Description |
Sets the subject line. | ||
Parameters | string | subjectLine | the new subject line |
Errors | INVALID_ARGUMENT | subjectLine is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | subjectLine is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearSubjectLine | ||
Description |
Clears the subject line. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getSummaryMetadata | ||
Description |
Gets the metadata for the summary. | ||
Return | osid.Metadata | metadata for the summary | |
Compliance | mandatory | This method must be implemented. | |
Method | setSummary | ||
Description |
Sets the summary. | ||
Parameters | string | summary | the new summary |
Errors | INVALID_ARGUMENT | summary is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | summary is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearSummary | ||
Description |
Clears the summary. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getTextMetadata | ||
Description |
Gets the metadata for the text. | ||
Return | osid.Metadata | metadata for the text | |
Compliance | mandatory | This method must be implemented. | |
Method | setText | ||
Description |
Sets the text. | ||
Parameters | string | text | the new text |
Errors | INVALID_ARGUMENT | text is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | text is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearText | ||
Description |
Clears the text. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getCopyrightMetadata | ||
Description |
Gets the metadata for the copyright. | ||
Return | osid.Metadata | metadata for the copyright | |
Compliance | mandatory | This method must be implemented. | |
Method | setCopyright | ||
Description |
Sets the copyright. | ||
Parameters | string | copyright | the new copyright |
Errors | INVALID_ARGUMENT | copyright is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | copyright is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCopyright | ||
Description |
Clears the copyright. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getEntryFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | entryRecordType | the entry record type |
Return | osid.blogging.records.EntryFormRecord | the entry form record | |
Errors | NULL_ARGUMENT | entryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(entryRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |