/android/import-contacts : contents of src/am/ed/importcontacts/Backend.java at revision 57

: (revision 57)

To get this branch, use:

bzr branch
http://bzr.ed.am/android/import-contacts

/*
 * Backend.java
 *
 * Copyright (C) 2012 Tim Marston <tim@ed.am>
 *
 * This file is part of the Import Contacts program (hereafter referred
 * to as "this program"). For more information, see
 * http://ed.am/dev/android/import-contacts
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package am.ed.importcontacts;

import am.ed.importcontacts.Importer.ContactData;

public interface Backend
{
	/**
	 * Build-up our contacts cache, using contacts on the device.
	 * @param cache the contacts cache to populate
	 */
	public void populateCache( ContactsCache cache );

	/**
	 * Delete a contact from the device.
	 * @param id of the contact to delete
	 */
	public void deleteContact( Long id );

	/**
	 * Add a contact to the device.
	 * @param name name of the new contact
	 * @return the new contact's id, or null on failure
	 */
	public Long addContact( String name );

	/**
	 * Add a phone number to an existing contact on the device.
	 * @param id the existing contact's id
	 * @param number the phone number
	 * @param data data about the number
	 */
	public void addContactPhone( Long id, String number,
		ContactData.PreferredDetail data );

	/**
	 * Add an email address to an existing contact on the device.
	 * @param id the existing contact's id
	 * @param email the email address
	 * @param data data about the email address
	 */
	public void addContactEmail( Long id, String email,
		ContactData.PreferredDetail data );

	/**
	 * Add an address to an existing contact on the device.
	 * @param id the existing contact's id
	 * @param address the address
	 * @param data data about the address
	 */
	public void addContactAddresses( Long id, String address,
		ContactData.TypeDetail data );

	/**
	 * Add a title and organisation to an existing contact on the device.
	 * @param id the existing contact's id
	 * @param organisation the organisation
	 * @param data data about the organisation
	 */
	public void addContactOrganisation( Long id, String organisation,
		ContactData.ExtraDetail data );
}

53 by edam abstracted the android contacts API in to an interface, ready to be switched to	1	/*
	2	* Backend.java
	3	*
	4	* Copyright (C) 2012 Tim Marston <tim@ed.am>
	5	*
	6	* This file is part of the Import Contacts program (hereafter referred
	7	* to as "this program"). For more information, see
	8	* http://ed.am/dev/android/import-contacts
	9	*
	10	* This program is free software: you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation, either version 3 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	22	*/
	23
	24	package am.ed.importcontacts;
	25
	26	import am.ed.importcontacts.Importer.ContactData;
	27
	28	public interface Backend
	29	{
	30	/**
	31	* Build-up our contacts cache, using contacts on the device.
	32	* @param cache the contacts cache to populate
	33	*/
	34	public void populateCache( ContactsCache cache );
	35
	36	/**
57 by edam cleanup; fixed some typos; updated TODO	37	* Delete a contact from the device.
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	38	* @param id of the contact to delete
	39	*/
	40	public void deleteContact( Long id );
	41
	42	/**
57 by edam cleanup; fixed some typos; updated TODO	43	* Add a contact to the device.
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	44	* @param name name of the new contact
57 by edam cleanup; fixed some typos; updated TODO	45	* @return the new contact's id, or null on failure
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	46	*/
	47	public Long addContact( String name );
	48
	49	/**
57 by edam cleanup; fixed some typos; updated TODO	50	* Add a phone number to an existing contact on the device.
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	51	* @param id the existing contact's id
	52	* @param number the phone number
	53	* @param data data about the number
	54	*/
	55	public void addContactPhone( Long id, String number,
	56	ContactData.PreferredDetail data );
	57
	58	/**
57 by edam cleanup; fixed some typos; updated TODO	59	* Add an email address to an existing contact on the device.
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	60	* @param id the existing contact's id
	61	* @param email the email address
	62	* @param data data about the email address
	63	*/
	64	public void addContactEmail( Long id, String email,
	65	ContactData.PreferredDetail data );
	66
	67	/**
57 by edam cleanup; fixed some typos; updated TODO	68	* Add an address to an existing contact on the device.
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	69	* @param id the existing contact's id
	70	* @param address the address
	71	* @param data data about the address
	72	*/
	73	public void addContactAddresses( Long id, String address,
	74	ContactData.TypeDetail data );
	75
	76	/**
57 by edam cleanup; fixed some typos; updated TODO	77	* Add a title and organisation to an existing contact on the device.
53 by edam abstracted the android contacts API in to an interface, ready to be switched to	78	* @param id the existing contact's id
	79	* @param organisation the organisation
	80	* @param data data about the organisation
	81	*/
	82	public void addContactOrganisation( Long id, String organisation,
	83	ContactData.ExtraDetail data );
	84	}