SettingsUISyncSource.java

/*
 * Funambol is a mobile platform developed by Funambol, Inc.
 * Copyright (C) 2010 Funambol, Inc.
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by
 * the Free Software Foundation with the addition of the following permission
 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE
 * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
 *
 * 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 Affero General Public License
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA.
 * 
 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite
 * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * "Powered by Funambol" logo. If the display of the logo is not reasonably
 * feasible for technical reasons, the Appropriate Legal Notices must display
 * the words "Powered by Funambol".
 */

package com.funambol.client.ui;

import com.funambol.client.source.AppSyncSource;

/**
 * This interface is a model for a generic representation of a SyncSource in the
 * settings screen.
 */
public interface SettingsUISyncSource extends SettingsUIItem {

    /**
     * Set the title
     */
    public void setTitle(String value);

    /**
     * Set the available sync modes
     */
    public void setAvailableSyncModes(int[] modes);
    
    /**
     * Set the sync mode
     */
    public void setSyncMode(int mode);

    /**
     * Get the sync mode
     */
    public int getSyncMode();

    /**
     * Set the icon when the item is enabled
     */
    public void setEnabledIcon(Bitmap icon);

    /**
     * Set the icon when the item is disabled
     */
    public void setDisabledIcon(Bitmap icon);

    /**
     * Enable or disabled this item
     */
    public void setEnabled(boolean flag);

    /**
     * Returns the AppSyncSource this item represents
     */
    public AppSyncSource getSource();

    /**
     * Set the AppSyncSource this item represents
     */
    public void setSource(AppSyncSource source);

    /**
     * Called when the controller requests the item to be layout
     */
    public void layout();

    /**
     * Set the source remote uri
     */
    public void setRemoteUri(String remoteUri);

    /**
     * Get the source remote uri
     */
    public String getRemoteUri();

    /**
     * @return true if there are chages on this settings source
     */
    public boolean hasChanges();

}