Package org.osid.contact

package org.osid.contact

The Open Service Interface Definitions for the org.osid.contact service.

The Contact OSID is an auxiliary service that relates contact information to OsidObjects .

Addresses

An Address is an OsidObject for a the address of a Resource . Specific breakdowns of an Address may be made available in an AddressRecord but and the Address exposes a text form of the address.

Contacts

A Contact is an OsidRelationship between an Address and a reference Id Contacts are time-variant which allow Addresses to become effective based on schedules.

Contacts have an addressee. Addressees are Resources that indicate to whom or what should be contacted. In the case of making contacts for external Resources , the reference Id and the addressee Resource Id may be the same.

Example

An Address exists for Tom: tom@earth.com. An OSID Consumer wishing to contact Tom does by looking up effective Contacts for Tom as a reference and then retrieving the related Addresses for the Contacts .

An Contact exists for a startup company (reference) where the addressee is Scott with an Address at 162 School Street. Another Contact exists with an addressee for Sarah also with an Address at 162 School Street. A single Address can be used for 162 School Street with an address Resource of Scott & Sarah's House. Gypsy can be added by creating a Contact referencing the dog related to the same Address .

Address Book Cataloging

Addresses and Contacts can be organized into federateable AddressBooks .

Sub Packages

The Contact OSID includes a rules subpackage for managing the effective status of Contacts and a Contact Batch OSID for managing Contacts and Addresses in bulk.

Copyright © 2010 Ingenescus. All Rights Reserved.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may nodify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.

Related Packages

Package	Description
org.osid	The Open Service Interface Definitions for the org.osid service.
org.osid.contact.batch	The Open Service Interface Definitions for the org.osid.contact.batch service.
org.osid.contact.records
org.osid.contact.rules	The Open Service Interface Definitions for the org.osid.contact.rules service.

Interfaces

Class	Description
Address	An Address for a Resource .
AddressAddressBookAssignmentSession	This session provides methods to re-assign Addresses to AddressBooks .
AddressAddressBookSession	This session provides methods to retrieve Address to AddressBook mappings.
AddressAdminSession	This session creates, updates, and deletes Addresses .
AddressBook	An AddressBook represents a collection of contacts.
AddressBookAdminSession	This session creates, updates, and deletes AddressBooks .
AddressBookForm	This is the form for creating and updating AddressBooks .
AddressBookHierarchyDesignSession	This session manages a hierarchy of address books.
AddressBookHierarchySession	This session defines methods for traversing a hierarchy of AddressBooks .
AddressBookList	Like all OsidLists , AddressBookList provides a means for accessing AddressBook elements sequentially either one at a time or many at a time.
AddressBookLookupSession	This session provides methods for retrieving AddressBooks .
AddressBookNode	This interface is a container for a partial hierarchy retrieval.
AddressBookNodeList	Like all OsidLists , AddressBookNodeList provides a means for accessing AddressBookNode elements sequentially either one at a time or many at a time.
AddressBookNotificationSession	This session defines methods to receive notifications on adds/changes to AddressBooks .
AddressBookQuery	This is the query for searching for address books.
AddressBookQueryInspector	This is the query inspector for examining address book queries.
AddressBookQuerySession	This session provides methods for searching AddressBooks .
AddressBookReceiver	The address book receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted AddressBook objects.
AddressBookSearch	The search interface for governing address book searches.
AddressBookSearchOrder	An interface for specifying the ordering of search results.
AddressBookSearchResults	This interface provides a means to capture results of a search.
AddressBookSearchSession	This session provides methods for searching AddressBooks .
AddressForm	This is the form for creating and updating Addresses .
AddressList	Like all OsidLists , AddressList provides a means for accessing Address elements sequentially either one at a time or many at a time.
AddressLookupSession	This session provides methods for retrieving Addresses .
AddressNotificationSession	This session defines methods to receive notifications on adds/changes to Addresses .
AddressQuery	This is the query for searching for addresses.
AddressQueryInspector	This is the query inspector for examining address queries.
AddressQuerySession	This session provides methods for searching Addresses .
AddressReceiver	The address receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Address objects.
AddressSearch	The search interface for governing address searches.
AddressSearchOrder	An interface for specifying the ordering of search results.
AddressSearchResults	This interface provides a means to capture results of a search.
AddressSearchSession	This session provides methods for searching Addresses .
AddressSmartAddressBookSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Contact	A Contact relates a reference Id to an address and addresse.
ContactAddressBookAssignmentSession	This session provides methods to re-assign Contacts to AddressBooks .
ContactAddressBookSession	This session provides methods to retrieve Contact to AddressBook mappings.
ContactAdminSession	This session creates, updates, and deletes Contacts .
ContactForm	This is the form for creating and updating Contacts .
ContactList	Like all OsidLists , ContactList provides a means for accessing Contact elements sequentially either one at a time or many at a time.
ContactLookupSession	This session defines methods for retrieving contacts.
ContactManager	The contact manager provides access to contact sessions and provides interoperability tests for various aspects of this service.
ContactNotificationSession	This session defines methods to receive notifications on adds/changes to Contacts .
ContactProfile	The contact profile describes the interoperability among contact services.
ContactProxyManager	The contact manager provides access to contact sessions and provides interoperability tests for various aspects of this service.
ContactQuery	This is the query for searching contacts.
ContactQueryInspector	The query inspector for examining contact queries.
ContactQuerySession	This session provides methods for searching Contacts .
ContactReceiver	The contact receiver is the consumer supplied interface for receiving notifications pertaining to new or deleted contacts.
ContactSearch	The search interface for governing contact searches.
ContactSearchOrder	An interface for specifying the ordering of search results.
ContactSearchResults	This interface provides a means to capture results of a search.
ContactSearchSession	This session provides methods for searching Contacts .
ContactSession	This session defines methods for evaluating and retrieving active and applicable contacts.
ContactSmartAddressBookSession	This session manages queries and sequencing to create "smart" dynamic catalogs.