| Interface | osid.tracking.LogEntryForm | ||
|---|---|---|---|
| Implements | osid.OsidObjectForm | ||
| Description | 
                 This is the form for creating and updating   | ||
| 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 | 
                     Removes the summary.  | ||
| Errors | NO_ACCESS |  Metadata.isRequired()  is  true  or  
Metadata.isReadOnly()  is  true   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMessageMetadata | ||
| Description | 
                     Gets the metadata for the message.  | ||
| Return | osid.Metadata | metadata for the summary | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setMessage | ||
| Description | 
                     Sets the message.  | ||
| Parameters | string | message | the new message | 
| Errors | INVALID_ARGUMENT |  message  is invalid  |                 |
| NO_ACCESS |  Metadata.isReadOnly()  is  true   |                 ||
| NULL_ARGUMENT |  message  is  null   |                 ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearMessage | ||
| Description | 
                     Removes the message.  | ||
| Errors | NO_ACCESS |  Metadata.isRequired()  is  true  or  
Metadata.isReadOnly()  is  true   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLogEntryFormRecord | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.type.Type | logEntryRecordType | a log entry record type | 
| Return | osid.tracking.records.LogEntryFormRecord | the log entry form record | |
| Errors | NULL_ARGUMENT |  logEntryRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(logEntryRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |