com.mot.iden.device
Class StatusManager

java.lang.Object
  com.mot.iden.device.StatusManager

public class StatusManager

extends java.lang.Object

The Status Manager Class give an application the ability to query the status of various features present on the device. These Features include: Battery Level, Signal Strength, Pack Data Registration, Mobile Ip Registration, if Call Forwarding is enabled, the current active line, number of unread text messages, total number of text messages, unheard voice mail messaged, total number of voice mail messages, number of unread NetAlert messages, thte total number of NetAlert messages, and the state of the High Audio Speaker.

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	BATTERY_LEVEL This is the value passed to the status manager to retrive the battery levels The return value is in the range of [0 - 3] with 0 being no charge and 3 being a full battery.
static int	CALL_FORWARD_STATE This is the value passed to the status manager to retrieve if the device has Call Forwarding enabled.
static int	CURRENT_ACTIVE_LINE This is the value passed to the status manager to retrieve which line is currently active on the device.
static int	CURRENT_VIBE_STYLE_ALERT This is the value passed to the status manager to retrieve the current vibe style for Call Alerts.
static int	CURRENT_VIBE_STYLE_LINE1 This is the value passed to the status manager to retrieve the current vibe style for line 1.
static int	CURRENT_VIBE_STYLE_LINE2 This is the value passed to the status manager to retrieve the current vibe style for line 2.
static int	HIGH_AUDIO_STATE This is the value passed to the status manager to retrieve the state of High Audio speaker Returns the state of the High Audio speaker for Two Way Radio messages.
static int	MIP_REGISTRATION This is the value passed to the isRegistered method to retrieve if the device is mobile ip registered or not returns value of false when the the device was unable to mobile ip register and true when the device was able to mobile ip register.
static int	NUM_NET_ALERT This is the value passed to the status manager to retrieve the number of Net Alerts the device has.
static int	NUM_TEXT_MSG This is the value passed to the status manager to retrieve the number of text messages the device has.
static int	NUM_UNHEARD_VOICE_MAIL This is the value passed to the status manager to retrieve the number of unheard Voice Mail messages the device has.
static int	NUM_UNREAD_NET_ALERT This is the value passed to the status manager to retrieve the number of unread Net Alerts the device has.
static int	NUM_UNREAD_TEXT_MSG This is the value passed to the status manager to retrieve the number of unread text messages the device has.
static int	NUM_VOICE_MAIL This is the value passed to the status manager to retrieve the number of Voice Mail messages the device has.
static int	PD_REGISTRATION This is the value passed to the isRegistered method to retrieve if the device is packet data registered or not returns value of false when there is no packet data service and true when the device was able to packet data register.
static int	SIGNAL_STRENGTH This is the value passed to the status manager to retrieve the Signal Strength The return value is in the range of [0 - 3] with 0 being no singal and 3 being full signal strength.
static int	VIBE_STYLE_RING Style if the vibe style is set to Ring for the spcified line.
static int	VIBE_STYLE_SILENT Style if the vibe style is set to Silent for the spcified line.
static int	VIBE_STYLE_VIBE_ALL Style if the vibe style is set to Vibe All for the device VIBE_STYLE_VIBE_ALL has a value of 4
static int	VIBE_STYLE_VIBE_RING Style if the vibe style is set to Vibe then Ring for the spcified line.
static int	VIBE_STYLE_VIBRATE Style if the vibe style is set to VIBRATE for the spcified line.

Method Summary

static int	getStatus(int item) Retrieves the status of the requested Item See the following possible Paramaters: BATTERY_LEVEL SIGNAL_STRENTH CALL_FORWARD_STATE CURRENT_ACTIVE_LINE NUM_UNREAD_TEXT_MSG NUM_TEXT_MSG NUM_UNHEARD_VOICE_MAIL NUM_VOICE_MAIL NUM_UNREAD_NET_ALERT NUMD_NET_ALERT HIGH_AUDIO_STATE CURRENT_VIBE_STYLE_LINE1 CURRENT_VIBE_STYLE_LINE2 CURRENT_VIBE_STYLE_ALERT
static boolean	isRegistered(int item) Retrieves if the item has gain registration See the following possible Paramaters: PD_REGISTRATION MIP_REGISTRATION

Methods inherited from class java.lang.Object

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

Field Detail

BATTERY_LEVEL

public static final int BATTERY_LEVEL

This is the value passed to the status manager to retrive the battery levels

The return value is in the range of [0 - 3] with 0 being no charge and 3 being a full battery.

BATTERY_LEVEL has a value of 0

See Also:

Constant Field Values

SIGNAL_STRENGTH

public static final int SIGNAL_STRENGTH

This is the value passed to the status manager to retrieve the Signal Strength

The return value is in the range of [0 - 3] with 0 being no singal and 3 being full signal strength.

SIGNAL_STRENGTH has a value of 1

See Also:

Constant Field Values

PD_REGISTRATION

public static final int PD_REGISTRATION

This is the value passed to the isRegistered method to retrieve if the device is packet data registered or not

returns value of false when there is no packet data service and true when the device was able to packet data register.

PD_REGISTRATION has a value of 2

See Also:

Constant Field Values

MIP_REGISTRATION

public static final int MIP_REGISTRATION

This is the value passed to the isRegistered method to retrieve if the device is mobile ip registered or not

returns value of false when the the device was unable to mobile ip register and true when the device was able to mobile ip register.

MIP_REGISTRATION has a value of 3

See Also:

Constant Field Values

CALL_FORWARD_STATE

public static final int CALL_FORWARD_STATE

This is the value passed to the status manager to retrieve if the device has Call Forwarding enabled.

Return values are as follows:
0 - Call Forwarding is off.
1 - Call Forwarding is on for Line 1.
2 - Call Forwarding is on for Line 2.
3 - Call Forwarding is on for Line 1 and Line 2.

IS_CALL_FORWARD_ENABLED has a value of 4

See Also:

Constant Field Values

CURRENT_ACTIVE_LINE

public static final int CURRENT_ACTIVE_LINE

This is the value passed to the status manager to retrieve which line is currently active on the device.

Returns 1 if Line 1 is the current active line and 2 if line 2 is the current active line.

CURRNET_ACTIVE_LINE has a value of 5

See Also:

Constant Field Values

NUM_UNREAD_TEXT_MSG

public static final int NUM_UNREAD_TEXT_MSG

This is the value passed to the status manager to retrieve the number of unread text messages the device has.

Returns the total number of Unread Text Messages present on the device.

NUM_UNREAD_TEXT_MSG has a value of 6

See Also:

Constant Field Values

NUM_TEXT_MSG

public static final int NUM_TEXT_MSG

This is the value passed to the status manager to retrieve the number of text messages the device has.

Returns the total number of Text Messages present on the device.

NUM_TEXT_MSG has a value of 7

See Also:

Constant Field Values

NUM_UNHEARD_VOICE_MAIL

public static final int NUM_UNHEARD_VOICE_MAIL

This is the value passed to the status manager to retrieve the number of unheard Voice Mail messages the device has.

Returns the total number of Unheard Voice Mail Messages.

NUM_UNHEARD_VOICE_MAIL has a value of 8

See Also:

Constant Field Values

NUM_VOICE_MAIL

public static final int NUM_VOICE_MAIL

This is the value passed to the status manager to retrieve the number of Voice Mail messages the device has.

Returns the total number of Voice Mail Messages.

NUM_VOICE_MAIL has a value of 9

See Also:

Constant Field Values

NUM_UNREAD_NET_ALERT

public static final int NUM_UNREAD_NET_ALERT

This is the value passed to the status manager to retrieve the number of unread Net Alerts the device has.

Returns the numbr of Unread Net Alerts

NUM_UNREAD_NET_ALERT has the value of 10

See Also:

Constant Field Values

NUM_NET_ALERT

public static final int NUM_NET_ALERT

This is the value passed to the status manager to retrieve the number of Net Alerts the device has.

Returns the total number of Net Alerts.

NUM_NET_ALERT has a value of 11

See Also:

Constant Field Values

HIGH_AUDIO_STATE

public static final int HIGH_AUDIO_STATE

This is the value passed to the status manager to retrieve the state of High Audio speaker

Returns the state of the High Audio speaker for Two Way Radio messages.

HIGH_AUDIO_STATE has a value of 12

See Also:

Constant Field Values

CURRENT_VIBE_STYLE_LINE1

public static final int CURRENT_VIBE_STYLE_LINE1

This is the value passed to the status manager to retrieve the current vibe style for line 1.

Returns the Current Vibe Style for Line 1. see:
VIBE_STYLE_RING
VIBE_STYLE_VIBRATE
VIBE_STYLE_VIBE_RING
VIBE_STYLE_SILENT
VIBE_STYLE_VIBE_ALL

CURRENT_VIBE_STYLE_LINE1 has a value of 13

See Also:

Constant Field Values

CURRENT_VIBE_STYLE_LINE2

public static final int CURRENT_VIBE_STYLE_LINE2

This is the value passed to the status manager to retrieve the current vibe style for line 2.

Returns the Current Vibe Style for Line 2. see:
VIBE_STYLE_RING
VIBE_STYLE_VIBRATE
VIBE_STYLE_VIBE_RING
VIBE_STYLE_SILENT
VIBE_STYLE_VIBE_ALL

CURRENT_VIBE_STYLE_LINE2 has a value of 14

See Also:

Constant Field Values

CURRENT_VIBE_STYLE_ALERT

public static final int CURRENT_VIBE_STYLE_ALERT

This is the value passed to the status manager to retrieve the current vibe style for Call Alerts.

Returns the Current Vibe Style for a Call Alert. see:
VIBE_STYLE_RING
VIBE_STYLE_VIBRATE
VIBE_STYLE_VIBE_RING
VIBE_STYLE_SILENT
VIBE_STYLE_VIBE_ALL

CURRENT_VIBE_STYLE_ALERT has a value of 15

See Also:

Constant Field Values

VIBE_STYLE_RING

public static final int VIBE_STYLE_RING

Style if the vibe style is set to Ring for the spcified line.

VIBE_STYLE_RING has a value of 0

See Also:

Constant Field Values

VIBE_STYLE_VIBRATE

public static final int VIBE_STYLE_VIBRATE

Style if the vibe style is set to VIBRATE for the spcified line.

VIBE_STYLE_VIBRATE has a value of 1

See Also:

Constant Field Values

VIBE_STYLE_VIBE_RING

public static final int VIBE_STYLE_VIBE_RING

Style if the vibe style is set to Vibe then Ring for the spcified line.

VIBE_STYLE_VIBE_RING has a value of 2

See Also:

Constant Field Values

VIBE_STYLE_SILENT

public static final int VIBE_STYLE_SILENT

Style if the vibe style is set to Silent for the spcified line.

VIBE_STYLE_SILENT has a value of 3

See Also:

Constant Field Values

VIBE_STYLE_VIBE_ALL

public static final int VIBE_STYLE_VIBE_ALL

Style if the vibe style is set to Vibe All for the device

VIBE_STYLE_VIBE_ALL has a value of 4

See Also:

Constant Field Values

Method Detail

getStatus

public static int getStatus(int item)
                     throws java.lang.IllegalArgumentException

Retrieves the status of the requested Item

See the following possible Paramaters:
BATTERY_LEVEL
SIGNAL_STRENTH
CALL_FORWARD_STATE
CURRENT_ACTIVE_LINE
NUM_UNREAD_TEXT_MSG
NUM_TEXT_MSG
NUM_UNHEARD_VOICE_MAIL
NUM_VOICE_MAIL
NUM_UNREAD_NET_ALERT
NUMD_NET_ALERT
HIGH_AUDIO_STATE
CURRENT_VIBE_STYLE_LINE1
CURRENT_VIBE_STYLE_LINE2
CURRENT_VIBE_STYLE_ALERT

Parameters:

item - Which item to get the status for.

Returns:

the status of the item requested.

Throws:

java.lang.IllegalArgumentException

isRegistered

public static boolean isRegistered(int item)
                            throws java.lang.IllegalArgumentException

Retrieves if the item has gain registration

See the following possible Paramaters:
PD_REGISTRATION
MIP_REGISTRATION

Parameters:

item - Which item to get the status for.

Returns:

the status of the item requested.

Throws:

java.lang.IllegalArgumentException