Interface | osid.contact.AddressForm | ||
---|---|---|---|
Implements | osid.OsidObjectForm | ||
Description |
This is the form for creating and updating | ||
Method | getResourceMetadata | ||
Description |
Gets the metadata for the resource. | ||
Return | osid.Metadata | metadata for the addressee | |
Compliance | mandatory | This method must be implemented. | |
Method | setResource | ||
Description |
Sets the resource. | ||
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 | clearResource | ||
Description |
Clears the resource. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | addressRecordType | the address record type |
Return | osid.contact.records.AddressFormRecord | the address form record | |
Errors | NULL_ARGUMENT | addressRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(addressRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |