com.mot.iden.customercare
Class CustomerCare

java.lang.Object
  |
  +--com.mot.iden.customercare.CustomerCare

public final class CustomerCare

extends java.lang.Object

CustomerCare API

The Customer Care API will provide J2ME applications access to unit and user specific data. This data may be used to track and troubleshoot issues out on the field. Specifically it will provide access to Trace mode functionality, such as the Unit Info, System Status, Reset/Error Log, Client Info, My Info, and Java System metrics. Where applicable, the data will be provided in a similar format as displayed in trace mode. This feature will be protected via the "System Information Access" or "Read User Data Access" functional groups of the Permission/Security Domain feature.

Reading Unit Info

The customercare.getUnitInfo method takes in through the fieldID parameter the type of information desired. The following are the valid fieldIDs for: DEVICE_MODEL, CP_VERSION (i.e. codeplug version), CSD_VERSION, SW_VERSION, GPS_VERSION, USR_VERSION, and BP_SW_VERSION. The following are examples of the string returned for these fieldIDs, respectively: i930A, 19.00/19.00, C97.05.05, D0B.00.50, SiRF Cust SW Version Info, U00c.00.00, D0C.00.65.

Reading System Status

The customercare.getSystemStatus method takes in through the fieldID parameter the type of information desired. The following are the valid fieldIDs: SQE (i.e. signal quality), CARRIER_CHNL, COLOR_CODE, PWR_CUTBACK, and SVG_CELL_QUALITY. The following are examples of the string returned for these fieldIDs, respectively: 34.73, 2EB, 00db, -66.

Reading My Info

The customercare.getMyInfo method which provides Mobile Indentification Information takes in through the fieldID parameter the type of information desired. The following are the valid fieldIDs: PRVT_ID (i.e. private dispatch id), LINE_1 (i.e. the main phone number - line 1), LINE_2 (i.e. the alternate phone line - line 2), and CARRIER_IP (i.e. unit's ip address). The following are examples of the string returned for these fieldIDs, respectively:902*43*12345, 5551234567, 5558901234 and 123.45.67.89. A null will be returned for applications in unauthorized domains.

Reading Client Info

The customercare.getClientInfo method takes in through the fieldID parameter the type of information desired. The following are the valid fieldIDs: IMEI (which provides a unique identifier for the unit), SERIAL_NUMBER, and SIM_ID. The following are examples of the string returned for these fieldIDs, respectively: "01010101010101", "1234567890" and "12345678901234". For IMEI, SERIAL_NUMBER, and SIMID, hashed unique values will be provided for unsigned applications.

Reading Errors

The customercare.getErrors method takes in through the fieldID parameter the type of information desired. )The following are the valid fieldIDs: RESET_NUMBER (i.e. number of resets, where 24 is the maximum value)and RESET. The following are examples of the string returned for these fieldIDs, respectively: "1" and R[0]:R0400Date:N/AX-&1019594CT100CFC.

Reading System Info

The customercare.getSystemInfo method takes in through the fieldID parameter the type of information desired and returns the number of kilobytes. The following are the valid fieldIDs: DATA_SPACE_FREE, DATA_SPACE_TOTAL, PROG_SPACE_FREE, and PROG_SPACE_TOTAL.

If an invalid fieldID is passed into a method then an IllegalArgumentException is thrown.

See Also:

MOTOROLA and the Stylized M Logo are registered trademarks of Motorola, Inc. Reg. U.S. Pat. & Tm. Off.
?Copyright 2003 Motorola, Inc. All Rights Reserved.

Field Summary

static int	BP_SW_VERSION Field ID used to retrieve the Device's BP Software Version
static int	CARRIER_CHNL Field ID used to retrieve the Device's Carrier Channel
static int	CARRIER_IP Field ID used to retrieve the Device's IP Address
static int	COLOR_CODE Field ID used to retrieve the Device's Carrier Color Code
static int	CP_VERSION Field ID used to retrieve the Device's Codeplug Version
static int	CSD_VERSION Field ID used to retrieve the Device's Customer Specific Data
static int	DATA_SPACE_FREE Field ID used to retrieve the Device's Java System Free Data Space
static int	DATA_SPACE_TOTAL Field ID used to retrieve the Device's Java System Total Data Space
static int	DEVICE_MODEL Field ID used to retrieve the Device's Model Number
static int	GPS_VERSION Field ID used to retrieve the Device's Global Positioning System Version
static int	IMEI Field ID used to retrieve the Device's Unique Identifier
static int	LINE_1 Field ID used to retrieve the Device's Main Phone Number
static int	LINE_2 Field ID used to retrieve the Device's Alternate Line Phone Number
static int	PROG_SPACE_FREE Field ID used to retrieve the Device's Java System Free Programming Space
static int	PROG_SPACE_TOTAL Field ID used to retrieve the Device's Java System Total Programming Space
static int	PRVT_ID Field ID used to retrieve the Device's Own Private Dispatch ID
static int	PWR_CUTBACK Field ID used to retrieve the Device's Power Cutback Level
static int	RESET Field ID used to retrieve the Device's Reset Log
static int	RESET_NUMBER Field ID used to retrieve the Number of Reset (since last reset clear)
static int	SERIAL_NUMBER Field ID used to retrieve the Device's Serial Number
static int	SIM_ID Field ID used to retrieve the Device's Subscriber Identification Module Number
static int	SQE Field ID used to retrieve the Device's Signal Quality
static int	SVG_CELL_QUALITY Field ID used to retrieve the Device's Serving Serving Cell Quality
static int	SW_VERSION Field ID used to retrieve the Device's Software Version
static int	USR_VERSION Field ID used to retrieve the Device's User Data Version

Method Summary

static java.lang.String	getClientInfo(int fieldID) This method provides client information such as a unique identifier (or IMEI), the device's serial number, and the SIM identifier.
static java.lang.String	getErrors(int fieldID) This method provides information of the error that have occurred, such as the number of resets (where 24 is the maximum value) and the reset log.
static java.lang.String	getMyInfo(int fieldID) This method provides information on the various service ids for the device, such as private dispatch id (as a '*' deliminated UFMI), the main phone number, the alternate line phone number for supporting devices, and the carrier ip address.
static int	getSystemInfo(int fieldID) This method provides unit information such as device's java system free data space , device's java system total data space, device's java system free programming space, and device's java system total programming space.
static java.lang.String	getSystemStatus(int fieldID) This method provides system status information sucha as signal quality, carrier channel, carrier color code (including extended color code for supporting devices), power cutback level and serving cell quality.
static java.lang.String	getUnitInfo(int fieldID) This method provides unit information such as the model, the version of the codeplug, the version of the CSD, the version of the software, the GPS version, the version of the user file, and the version of BP software.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEVICE_MODEL

public static final int DEVICE_MODEL

Field ID used to retrieve the Device's Model Number

CP_VERSION

public static final int CP_VERSION

Field ID used to retrieve the Device's Codeplug Version

CSD_VERSION

public static final int CSD_VERSION

Field ID used to retrieve the Device's Customer Specific Data

SW_VERSION

public static final int SW_VERSION

Field ID used to retrieve the Device's Software Version

GPS_VERSION

public static final int GPS_VERSION

Field ID used to retrieve the Device's Global Positioning System Version

USR_VERSION

public static final int USR_VERSION

Field ID used to retrieve the Device's User Data Version

SQE

public static final int SQE

Field ID used to retrieve the Device's Signal Quality

CARRIER_CHNL

public static final int CARRIER_CHNL

Field ID used to retrieve the Device's Carrier Channel

COLOR_CODE

public static final int COLOR_CODE

Field ID used to retrieve the Device's Carrier Color Code

PWR_CUTBACK

public static final int PWR_CUTBACK

Field ID used to retrieve the Device's Power Cutback Level

SVG_CELL_QUALITY

public static final int SVG_CELL_QUALITY

Field ID used to retrieve the Device's Serving Serving Cell Quality

PRVT_ID

public static final int PRVT_ID

Field ID used to retrieve the Device's Own Private Dispatch ID

LINE_1

public static final int LINE_1

Field ID used to retrieve the Device's Main Phone Number

LINE_2

public static final int LINE_2

Field ID used to retrieve the Device's Alternate Line Phone Number

CARRIER_IP

public static final int CARRIER_IP

Field ID used to retrieve the Device's IP Address

IMEI

public static final int IMEI

Field ID used to retrieve the Device's Unique Identifier

SERIAL_NUMBER

public static final int SERIAL_NUMBER

Field ID used to retrieve the Device's Serial Number

SIM_ID

public static final int SIM_ID

Field ID used to retrieve the Device's Subscriber Identification Module Number

RESET_NUMBER

public static final int RESET_NUMBER

Field ID used to retrieve the Number of Reset (since last reset clear)

RESET

public static final int RESET

Field ID used to retrieve the Device's Reset Log

DATA_SPACE_FREE

public static final int DATA_SPACE_FREE

Field ID used to retrieve the Device's Java System Free Data Space

DATA_SPACE_TOTAL

public static final int DATA_SPACE_TOTAL

Field ID used to retrieve the Device's Java System Total Data Space

PROG_SPACE_FREE

public static final int PROG_SPACE_FREE

Field ID used to retrieve the Device's Java System Free Programming Space

PROG_SPACE_TOTAL

public static final int PROG_SPACE_TOTAL

Field ID used to retrieve the Device's Java System Total Programming Space

BP_SW_VERSION

public static final int BP_SW_VERSION

Field ID used to retrieve the Device's BP Software Version

Method Detail

getUnitInfo

public static final java.lang.String getUnitInfo(int fieldID)
                                          throws java.lang.IllegalArgumentException

This method provides unit information such as the model, the version of the codeplug, the version of the CSD, the version of the software, the GPS version, the version of the user file, and the version of BP software.

Parameters:

fieldID - valid values are DEVICE_MODEL, CP_VERSION, CSD_VERSION, SW_VERSION, GPS_VERSION, USR_VERSION, BP_SW_VERSION

Returns:

String containing the requested information. The following are examples of the string returned for these fieldIDs: i930A, 19.00/19.00, C97.05.05, D0B.00.50, SiRF Cust SW Version Info, U00c.00.00 and D0B.00.65.

Throws:

java.lang.IllegalArgumentException - If an invalid fieldID is passed into the method.

java.lang.SecurityException - if application does not have permission to get the information.

getSystemStatus

public static final java.lang.String getSystemStatus(int fieldID)
                                              throws java.lang.IllegalArgumentException

This method provides system status information sucha as signal quality, carrier channel, carrier color code (including extended color code for supporting devices), power cutback level and serving cell quality.

Parameters:

fieldID - valid values are SQE, CARRIER_CHNL, COLOR_CODE, PWR_CUTBACK, SVG_CELL_QUALITY.

Returns:

String containing the requested information. The following are examples of the string returned for these fieldIDs: 34.73, 2EB, 00db and -66.

Throws:

java.lang.IllegalArgumentException - If an invalid fieldID is passed into the method

java.lang.SecurityException - if application does not have permission to get the information.

getMyInfo

public static final java.lang.String getMyInfo(int fieldID)
                                        throws java.lang.IllegalArgumentException

This method provides information on the various service ids for the device, such as private dispatch id (as a '*' deliminated UFMI), the main phone number, the alternate line phone number for supporting devices, and the carrier ip address.

Parameters:

fieldID - valid values are PRVT_ID, LINE_1, LINE_2,CARRIER_IP

Returns:

String containing the requested information. The following are examples of the string returned for these fieldIDs: 902*43*12345, 5551234567, 5558901234 and 123.45.67.89. A null will be returned for applications in unauthorized domains.

Throws:

java.lang.IllegalArgumentException - If an invalid fieldID is passed into the method

java.lang.SecurityException - if application does not have permission to get the information.

getClientInfo

public static final java.lang.String getClientInfo(int fieldID)
                                            throws java.lang.IllegalArgumentException

This method provides client information such as a unique identifier (or IMEI), the device's serial number, and the SIM identifier.

Parameters:

fieldID - valid values are IMEI , SERIAL_NUMBER, SIM_ID.

Returns:

String containing the requested information. The following are examples of the string returned for these fieldIDs: "01010101010101", "1234567890" and "12345678901234".For IMEI, SERIAL_NUMBER, and SIMID, hashed unique values will be provided for unsigned applications

Throws:

java.lang.IllegalArgumentException - If an invalid fieldID is passed into the method

java.lang.SecurityException - if application does not have permission to get the information.

getErrors

public static final java.lang.String getErrors(int fieldID)
                                        throws java.lang.IllegalArgumentException

This method provides information of the error that have occurred, such as the number of resets (where 24 is the maximum value) and the reset log.

Parameters:

fieldID - valid values are RESET_NUMBER, RESET

Returns:

String containing the requested information. The following are examples of the string returned for these fieldIDs: "1" and R[0]:R0400Date:N/AX-&1019594CT100CFC. The resets will concatenated together in the reset log. For example if 2 resets occurred the reset log would be as follows: "R[0]:RXXXXDate:XX/XX-&XXXXXXXXXXXXXXXR[1]:RXXXXDate:XX/XX-&XXXXXXXXXXXXXXX".

Throws:

java.lang.IllegalArgumentException - If an invalid fieldID is passed into the method

java.lang.SecurityException - if application does not have permission to get the information.

getSystemInfo

public static final int getSystemInfo(int fieldID)
                               throws java.lang.IllegalArgumentException

This method provides unit information such as device's java system free data space , device's java system total data space, device's java system free programming space, and device's java system total programming space. In Gemini, free data space equals free programming space and returns free file system space; total data space equals total programming space and returns total file system space.

Parameters:

fieldID - valid values are DATA_SPACE_FREE, DATA_SPACE_TOTAL, PROG_SPACE_FREE, PROG_SPACE_TOTAL.

Returns:

int of the requested information in int kilobytes.

Throws:

java.lang.IllegalArgumentException - If an invalid fieldID is passed into the method

java.lang.SecurityException - if application does not have permission to get the information.