DeviceInfoInterface.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.platform;

public interface DeviceInfoInterface {
    /**
     * The way the device is used in media sync context
     */
    public static class DeviceRole { // poor man's enum
        /** Unable to compute the device type */
        public static final DeviceRole UNDEFINED = new DeviceRole(0);
        /** Device is a smartphone */
        public static final DeviceRole SMARTPHONE = new DeviceRole(1);
        /** Device is a tablet */
        public static final DeviceRole TABLET = new DeviceRole(2);
        
        private int role;
        
        private DeviceRole(int role) {
            this.role = role;
        }
        
        public boolean equals(Object o) {
            if (o == null || !(o instanceof DeviceRole)) {
                return false;
            }
            return this.role == ((DeviceRole) o).role;
        }
        
        public String toString() {
            String value;
            switch (role) {
            case 1:
                value = "Smartphone";
                break;
            case 2:
                value = "Tablet";
                break;
            default:
                value = "Unknown";
                break;
            }
            return value;
        }
    }
  
    /**
     * Returns the phone number or null if not available.
     */
    public String getPhoneNumber();

    /**
     * Returns the platform or null if not available. The platform here is a
     * Funambol identification of the client build.
     */
    public String getFunambolPlatform();

    /**
     * Returns the main email adddress or null if not available.
     */
    public String getEmailAddress();

    /**
     * Returns the device timezone or null if not available.
     */
    public String getTimezone();

    /**
     * Returns the device manufacturer or null if not available.
     */
    public String getManufacturer();

    /**
     * Returns the device model or null if not available.
     */
    public String getDeviceModel();

    /**
     * Returns the carrier name, or null if not available.
     */
    public String getCarrier();

    /**
     * Returns the A2 country code, or null if not available.
     */
    public String getCountryCode();

    /**
     * Returns whether the device is a tablet
     */
    public boolean isTablet();

    /**
     * Returns whether the device is a smartphone
     */
    public boolean isSmartphone();

    /**
     * Returns the device role (tablet, smartphone, tv etc)
     */
    public DeviceRole getDeviceRole();

    /**
     * Returns the device OS version
     */
    public String getOSVersion();

}