OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.Contact
Implementsosid.OsidRelationship
Description

A Contact relates a reference Id to an address and addresse. The contact addressee is expressed as a Resource. For example, a contact for a Repository would have the repository Id as the reference, and the person to contact as the addressee. When specifying Contacts for external Resources, the reference Id and the addressee may be the same.

Multiple contacts may be related to an Id sorted by priority. A Contact is available for use on the specified weekdays and within a time of day. The genus Type of the Contact may be used to provide further detail on how the context or usage of this Contact.

MethodgetReferenceId
Description

Gets the Id of the reference.

Returnosid.id.Idthe reference Id
CompliancemandatoryThis method must be implemented.
MethodgetAddresseeId
Description

Gets the Id of the addressee.

Returnosid.id.Idthe resource Id
CompliancemandatoryThis method must be implemented.
MethodgetAddressee
Description

Gets the addressee.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAddressId
Description

Gets the Id of the subscriber's address.

Returnosid.id.Idthe subscriber Id
CompliancemandatoryThis method must be implemented.
MethodgetAddress
Description

Gets the subscriber's address.

Returnosid.contact.Addressthe subscriber's address.
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetContactRecord
Description

Gets the contact record corresponding to the given Contact record Type. This method is used to retrieve an object implementing the requested record. The contactRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(contactRecordType) is true .

Parametersosid.type.TypecontactRecordTypethe type of contact record to retrieve
Returnosid.contact.records.ContactRecordthe contact record
ErrorsNULL_ARGUMENT contactRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(contactRecordType) is false
CompliancemandatoryThis method must be implemented.