OSID Logo
OSID Specifications
contact package
Version 3.0.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.Metadatametadata for the addressee
CompliancemandatoryThis method must be implemented.
MethodsetAddressee
Description

Sets the addressee.

Parametersosid.id.IdresourceIda resource Id
ErrorsINVALID_ARGUMENTresourceId is invalid
NO_ACCESSMetadata.isReadOnly() is true
NULL_ARGUMENTresourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearAddressee
Description

Clears the addressee.

ErrorsNO_ACCESSMetadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetContactFormRecord
Description

Gets the ContactFormRecord corresponding to the given contact record Type .

Parametersosid.type.TypecontactRecordTypethe contact record type
Returnosid.contact.records.ContactFormRecordthe contact form record
ErrorsNULL_ARGUMENTcontactRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(contactRecordType) is false
CompliancemandatoryThis method must be implemented.