OSID Logo
OSID Specifications
contact package
Version 3.1.0
Interfaceosid.contact.ContactForm
Implementsosid.OsidRelationshipForm
Implemented Byosid.contact.batch.ContactBatchForm
Used Byosid.contact.ContactAdminSession
Description

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

MethodgetAddresseeMetadata
Description

Gets the metadata for the addressee.

Returnosid.Metadata metadata for the addressee
Compliancemandatory This method must be implemented.
MethodsetAddressee
Description

Sets the addressee.

Parametersosid.id.IdresourceId a resource Id
ErrorsINVALID_ARGUMENT resourceId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceId is null
Compliancemandatory This method must be implemented.
MethodclearAddressee
Description

Clears the addressee.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
Compliancemandatory This method must be implemented.
MethodgetContactFormRecord
Description

Gets the ContactFormRecord corresponding to the given contact record Type.

Parametersosid.type.TypecontactRecordType the contact record type
Returnosid.contact.records.ContactFormRecord the contact form record
ErrorsNULL_ARGUMENT contactRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(contactRecordType) is false
Compliancemandatory This method must be implemented.