Contact
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.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
Address
An Address for a
Resource. The detailed components of the
Address are maintained in the
AddressRecord while
getAddressText() supplies a usable form
of the address. The genus Type of the
Address indicates the kind of address
such as email or phone number.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Name | Syntax | Many | Description |
|---|---|---|---|
resourceId |
id | a resource Id |
|
resource |
Resource | a resource | |
addressText |
displaytext | the address |
Address Book
An AddressBook represents a
collection of contacts. Like all OSID objects, a
AddressBook is identified by its
Id and any persisted references should
use the Id.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Sourceable | |||
providerId |
id | the provider Id |
|
provider |
Resource | the provider | |
brandingIds |
id | ⋆ | a list of asset Ids |
branding |
Asset | ⋆ | a list of assets |
license |
displaytext | the license | |