ie.ncl.sms.nbs
Class MenuItem

java.lang.Object
  ie.ncl.sms.nbs.MenuItem

public class MenuItem
extends java.lang.Object

A menu item can be dynamically added to some mobile phone handsets. The protocol used to update and query menus is he Dynamic Menu Control Protocol (DMCP). The menu item describes the menu and the items that are within.

Authorization is achieved by checking the source address of the dynamic menu and comparing it with a list of internally configured addresses on the handset. A correct match allows the dynamic menu to be updated.

Field Summary

static java.lang.String	GROUP_LOCAL Local area services menu group.
static java.lang.String	GROUP_MANUF Manufacturer specific menu group.
static java.lang.String	GROUP_OPERATOR Home operator menu group.
static java.lang.String	GROUP_ROAMING Roaming-operator menu group.
static java.lang.String	GROUP_USER User's favorite services list menu group.
static java.lang.String	TYPE_LINKED A Linked menu item indicates that a volatile selection of items need to be requested from the 'menu-server'.
static java.lang.String	TYPE_NORMAL A Normal menu item.
static java.lang.String	TYPE_SELECTED A Selected menu is used to indicates 'the currently active' volatile menu.
static java.lang.String	TYPE_VOLATILE A Volatile menu item indicates that a volatile selection of items change from time to time and may need to

Constructor Summary

MenuItem(java.lang.String name, MenuAction action)
Construct a MenuItem with the specfied name and action.

Method Summary

MenuAction	getAction() Get the menu action.
java.lang.String	getGroup() Get the Menu group.
java.lang.String	getHelpText() Set the help text associated with this menu item.
java.lang.String	getKey() This key can be used to remove the menu from the handset.
java.lang.String	getName() Get the menu item name.
java.lang.String	getProviderInfo() This is used to store provider information (such as version numbers, language info etc.) with the menu that can later be retrieved if needed, much the same as an internet 'cookie'.
java.lang.String	getToken() Get the menu token.
java.lang.String	getType() Get the type of menu item.
static void	main(java.lang.String[] args)
static MenuItem	sample()
void	setAction(MenuAction action) Set the menu action.
void	setGroup(java.lang.String group) Set the Menu group.
void	setGroup(java.lang.String group, java.lang.String operatorName) Set the Menu group.
void	setHelpText(java.lang.String helpText) Set the help text associated with this menu item.
void	setName(java.lang.String name) Set the menu item name.
void	setProviderInfo(java.lang.String providerInfo) This is used to store provider information (such as version numbers etc.) with the menu that can later be retrieved if needed.
void	setToken(java.lang.String token) Set the menu token.
void	setType(java.lang.String type) Set the type of menu item.
java.lang.String	toString() String form of menu item.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_NORMAL

public static final java.lang.String TYPE_NORMAL

A Normal menu item.

See Also:

setType(java.lang.String), getType(), Constant Field Values

TYPE_LINKED

public static final java.lang.String TYPE_LINKED

A Linked menu item indicates that a volatile selection of items need to be requested from the 'menu-server'.

See Also:

setType(java.lang.String), getType(), Constant Field Values

TYPE_VOLATILE

public static final java.lang.String TYPE_VOLATILE

A Volatile menu item indicates that a volatile selection of items change from time to time and may need to

See Also:

setType(java.lang.String), getType(), Constant Field Values

TYPE_SELECTED

public static final java.lang.String TYPE_SELECTED

A Selected menu is used to indicates 'the currently active' volatile menu.

See Also:

setType(java.lang.String), getType(), Constant Field Values

GROUP_OPERATOR

public static final java.lang.String GROUP_OPERATOR

Home operator menu group. Access to this menu group is restricted in the handset by authorisation list is enabled.

See Also:

setGroup(java.lang.String, java.lang.String), getGroup(), Constant Field Values

GROUP_ROAMING

public static final java.lang.String GROUP_ROAMING

Roaming-operator menu group. Acciess is restricted in the handset by authorisation list on phone.

See Also:

setGroup(java.lang.String, java.lang.String), Constant Field Values

GROUP_LOCAL

public static final java.lang.String GROUP_LOCAL

Local area services menu group. Services that any service provider would normally offer in the current geographical area.

See Also:

setGroup(java.lang.String, java.lang.String), getGroup(), Constant Field Values

GROUP_USER

public static final java.lang.String GROUP_USER

User's favorite services list menu group. This is the default group. This group would be like a browser's favorites bookmark.

See Also:

setGroup(java.lang.String, java.lang.String), getGroup(), Constant Field Values

GROUP_MANUF

public static final java.lang.String GROUP_MANUF

Manufacturer specific menu group. Authorisation is required to change this.

See Also:

setGroup(java.lang.String, java.lang.String), getGroup(), Constant Field Values

Constructor Detail

MenuItem

public MenuItem(java.lang.String name,
                MenuAction action)

Construct a MenuItem with the specfied name and action. The default menu group USER is used.

Method Detail

setType

public void setType(java.lang.String type)

Set the type of menu item.

See Also:

getType(), TYPE_NORMAL, TYPE_LINKED, TYPE_VOLATILE, TYPE_SELECTED

getType

public java.lang.String getType()

Get the type of menu item.

See Also:

setType(java.lang.String), TYPE_NORMAL, TYPE_LINKED, TYPE_VOLATILE, TYPE_SELECTED

setToken

public void setToken(java.lang.String token)

Set the menu token. This token is used for authentication. Once a menu item is set, it cannot be changed unless the update has the same matching token as the original.

See Also:

getToken()

getToken

public java.lang.String getToken()

Get the menu token. This token is used for authentication. Once a menu item is set, it cannot be changed unless the update has the same matching token as the original.

See Also:

setToken(java.lang.String)

setHelpText

public void setHelpText(java.lang.String helpText)

Set the help text associated with this menu item.

See Also:

getHelpText()

getHelpText

public java.lang.String getHelpText()

Set the help text associated with this menu item.

See Also:

setHelpText(java.lang.String)

setName

public void setName(java.lang.String name)

Set the menu item name. This is the menu item name as it appears on the handset. The ':' character represents line feeds.

See Also:

getName()

getName

public java.lang.String getName()

Get the menu item name. This is the menu item name as it appears on the handset. The ':' character represents line feeds.

See Also:

setName(java.lang.String)

setProviderInfo

public void setProviderInfo(java.lang.String providerInfo)

This is used to store provider information (such as version numbers etc.) with the menu that can later be retrieved if needed.

See Also:

getProviderInfo

getProviderInfo

public java.lang.String getProviderInfo()

This is used to store provider information (such as version numbers, language info etc.) with the menu that can later be retrieved if needed, much the same as an internet 'cookie'.

See Also:

setProviderInfo

setAction

public void setAction(MenuAction action)

Set the menu action.

getAction

public MenuAction getAction()

Get the menu action.

setGroup

public void setGroup(java.lang.String group,
                     java.lang.String operatorName)

Set the Menu group.

setGroup

public void setGroup(java.lang.String group)

Set the Menu group.

getGroup

public java.lang.String getGroup()

Get the Menu group.

toString

public java.lang.String toString()

String form of menu item.

Overrides:

toString in class java.lang.Object

getKey

public java.lang.String getKey()

This key can be used to remove the menu from the handset.

sample

public static MenuItem sample()

main

public static void main(java.lang.String[] args)