Interface | osid.contact.ContactForm | ||
---|---|---|---|
Implements | osid.OsidRelationshipForm | ||
Description |
This is the form for creating and updating | ||
Method | getAddresseeMetadata | ||
Description |
Gets the metadata for the addressee. | ||
Return | osid.Metadata | metadata for the addressee | |
Compliance | mandatory | This method must be implemented. | |
Method | setAddressee | ||
Description |
Sets the addressee. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
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 | clearAddressee | ||
Description |
Clears the addressee. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getContactFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | contactRecordType | the contact record type |
Return | osid.contact.records.ContactFormRecord | the contact form record | |
Errors | NULL_ARGUMENT | contactRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(contactRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |