com.sybase.uep.bobclient.options
Class OptionsDefinition

java.lang.Object
  extended by com.sybase.uep.bobclient.custom.BaseDefinition
      extended by com.sybase.uep.bobclient.options.OptionsDefinition

public abstract class OptionsDefinition
extends BaseDefinition

Be responsible to provide application specified info for options module. This class will be extended from BOBOptionsDefinition.

Author:
linsong

Constructor Summary
protected OptionsDefinition()
           
 
Method Summary
 void addDatabaseClass(java.lang.String packageName, java.lang.String dbClassName)
          Stores the database class name
 void addProfile(java.lang.String profileRefID, int resourceProfileNameKey, java.lang.String serverName, int serverPort, java.lang.String username, java.lang.String password, boolean secure)
          This method add a profile
 void addProfile(java.lang.String profileRefID, int resourceProfileNameKey, java.lang.String serverName, int serverPort, java.lang.String username, java.lang.String password, boolean secure, java.lang.String streamParams)
          This method add a profile
 void addProfile(java.lang.String profileRefID, int resourceProfileNameKey, java.lang.String serverName, int serverPort, java.lang.String username, java.lang.String password, boolean secure, java.lang.String streamParams, java.lang.String packageName)
          This method add a profile
 void addProfile(java.lang.String profileRefID, java.lang.String profileName, java.lang.String serverName, int serverPort, java.lang.String username, java.lang.String password, boolean secure)
          This method add a profile
 void addProfile(java.lang.String profileRefID, java.lang.String profileName, java.lang.String serverName, int serverPort, java.lang.String username, java.lang.String password, boolean secure, java.lang.String streamParams)
          This method add a profile
 void addProfile(java.lang.String profileRefID, java.lang.String profileName, java.lang.String serverName, int serverPort, java.lang.String username, java.lang.String password, boolean secure, java.lang.String streamParams, java.lang.String packageName)
          This method add a profile
 AppLoggerWrapper getAppLogger()
          Getts the application logger wrapper
abstract  java.lang.String getClientName()
           
 java.lang.String getDatabaseClass(java.lang.String packageName)
          Gets the name of the database class that is defined for the given package
 net.rim.device.api.i18n.ResourceBundle getResourceBundle()
          Get the resource bundle
 java.lang.String getRibbonName()
          Gets the ribbon name
abstract  java.util.Vector getSettingsScreenRegistry()
           
 java.lang.String getVersion()
           
 boolean hasLoginScreen()
           
protected abstract  void init()
          init options definition
protected  void initAppLoggerWrapper()
           
protected  void initDefaultProfile()
          Add the profile to the repository
abstract  void initScreens()
          init options screens
protected  void initSettings()
          initialize settings
 void setHasLoginScreen(boolean hasLogin)
           
 void setLoginProfile(java.lang.String loginProfileId)
          Set the login profile that will be used for authenticating.
 void setResourceBundle(net.rim.device.api.i18n.ResourceBundle resource)
          Set the resource bundle
 void setRibbonName(int nameKey)
          Sets the resource key of the ribbon name
 void setRibbonName(java.lang.String name)
          Sets the ribbon name string
 void setup()
          Setup the profile, sync settings
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OptionsDefinition

protected OptionsDefinition()
Method Detail

getSettingsScreenRegistry

public abstract java.util.Vector getSettingsScreenRegistry()
Returns:
the collection of settings screens

getClientName

public abstract java.lang.String getClientName()
Returns:
the name of client application

init

protected abstract void init()
init options definition


initScreens

public abstract void initScreens()
init options screens


setup

public void setup()
Setup the profile, sync settings

Specified by:
setup in class BaseDefinition

initSettings

protected void initSettings()
initialize settings


initAppLoggerWrapper

protected void initAppLoggerWrapper()
Specified by:
initAppLoggerWrapper in class BaseDefinition

getAppLogger

public AppLoggerWrapper getAppLogger()
Description copied from class: BaseDefinition
Getts the application logger wrapper

Specified by:
getAppLogger in class BaseDefinition

initDefaultProfile

protected void initDefaultProfile()
Add the profile to the repository


setLoginProfile

public void setLoginProfile(java.lang.String loginProfileId)
Set the login profile that will be used for authenticating.


addProfile

public void addProfile(java.lang.String profileRefID,
                       int resourceProfileNameKey,
                       java.lang.String serverName,
                       int serverPort,
                       java.lang.String username,
                       java.lang.String password,
                       boolean secure)
This method add a profile

Parameters:
profileRefID - - Profile reference ID
resourceProfileNameKey - - Resource profile name key value
serverName - - Server name
serverPort - - Server port number
username - - user name for this profile
password - - password for the user name
secure - - true if secure else false

addProfile

public void addProfile(java.lang.String profileRefID,
                       int resourceProfileNameKey,
                       java.lang.String serverName,
                       int serverPort,
                       java.lang.String username,
                       java.lang.String password,
                       boolean secure,
                       java.lang.String streamParams)
This method add a profile

Parameters:
profileRefID - - Profile reference ID
resourceProfileNameKey - - Resource profile name key value
serverName - - Server name
serverPort - - Server port number
username - - user name for this profile
password - - password for the user name
secure - - true if secure else false
streamParams - - mobiLink stream params used for sync

addProfile

public void addProfile(java.lang.String profileRefID,
                       int resourceProfileNameKey,
                       java.lang.String serverName,
                       int serverPort,
                       java.lang.String username,
                       java.lang.String password,
                       boolean secure,
                       java.lang.String streamParams,
                       java.lang.String packageName)
This method add a profile

Parameters:
profileRefID - - Profile reference ID
resourceProfileNameKey - - Resource profile name key value
serverName - - Server name
serverPort - - Server port number
username - - user name for this profile
password - - password for the user name
secure - - true if secure else false
streamParams - - mobiLink stream params used for sync
packageName - - package name of profile

addProfile

public void addProfile(java.lang.String profileRefID,
                       java.lang.String profileName,
                       java.lang.String serverName,
                       int serverPort,
                       java.lang.String username,
                       java.lang.String password,
                       boolean secure)
This method add a profile

Parameters:
profileRefID - - Profile reference ID
profileName - - Profile name
serverName - - Server name
serverPort - - Server port number
username - - user name for this profile
password - - password for the user name
secure - - true if secure else false

addProfile

public void addProfile(java.lang.String profileRefID,
                       java.lang.String profileName,
                       java.lang.String serverName,
                       int serverPort,
                       java.lang.String username,
                       java.lang.String password,
                       boolean secure,
                       java.lang.String streamParams)
This method add a profile

Parameters:
profileRefID - - Profile reference ID
profileName - - Profile name
serverName - - Server name
serverPort - - Server port number
username - - user name for this profile
password - - password for the user name
secure - - true if secure else false
streamParams - - mobiLink stream params used for sync

addProfile

public void addProfile(java.lang.String profileRefID,
                       java.lang.String profileName,
                       java.lang.String serverName,
                       int serverPort,
                       java.lang.String username,
                       java.lang.String password,
                       boolean secure,
                       java.lang.String streamParams,
                       java.lang.String packageName)
This method add a profile

Parameters:
profileRefID - - Profile reference ID
profileName - - Profile name
serverName - - Server name
serverPort - - Server port number
username - - user name for this profile
password - - password for the user name
secure - - true if secure else false
streamParams - - mobiLink stream params used for sync
packageName - - package name of profile

setHasLoginScreen

public void setHasLoginScreen(boolean hasLogin)

hasLoginScreen

public boolean hasLoginScreen()

addDatabaseClass

public void addDatabaseClass(java.lang.String packageName,
                             java.lang.String dbClassName)
Stores the database class name

Parameters:
packageName - - package name of database class
dbClassName - - database class name

getDatabaseClass

public java.lang.String getDatabaseClass(java.lang.String packageName)
Gets the name of the database class that is defined for the given package

Parameters:
packageName - - package name of database class
Returns:
empty string if no database class is found.

setResourceBundle

public void setResourceBundle(net.rim.device.api.i18n.ResourceBundle resource)
Set the resource bundle

Parameters:
resource - - Resource Bundle object

getResourceBundle

public net.rim.device.api.i18n.ResourceBundle getResourceBundle()
Get the resource bundle

Returns:
Resource Bundle object

setRibbonName

public void setRibbonName(java.lang.String name)
Sets the ribbon name string

Parameters:
name -

setRibbonName

public void setRibbonName(int nameKey)
Sets the resource key of the ribbon name

Parameters:
nameKey -

getRibbonName

public java.lang.String getRibbonName()
Gets the ribbon name

Returns:
ribbon name

getVersion

public java.lang.String getVersion()