com.sybase.uep.bobclient.custom
Class UIDefinition

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

public abstract class UIDefinition
extends BaseDefinition

This is the UI Definition class This class will be extended from BOBCDefinition The constructor in BOBCDefinition will construct default profile, screens and mobile applications.

Author:
tdang

Field Summary
static java.lang.String DEFAULT_SYNC_COMPLETED_MESSAGE
           
static java.lang.String DEFAULT_SYNC_CONNECTING_MESSAGE
           
static java.lang.String DEFAULT_SYNC_DOWNLOADING_MESSAGE
           
static java.lang.String DEFAULT_SYNC_MESSAGE
           
static java.lang.String DEFAULT_SYNC_METADATA_DOWNLOADING_MESSAGE
           
static java.lang.String DEFAULT_SYNC_METADATA_UPLOADING_MESSAGE
           
static java.lang.String DEFAULT_SYNC_PUBLICATION_MESSAGE
           
static java.lang.String DEFAULT_SYNC_UPLOADING_MESSAGE
           
static long KEY
           
 
Constructor Summary
UIDefinition()
          UIDefinition Constructor Instantiate the Event Logger
 
Method Summary
static void addAssociation(java.lang.String packageName, java.lang.String name, java.lang.String leftNode, java.lang.String rightNode, int type, boolean inverse)
          Create an association and store it
static void addDatabaseClass(java.lang.String packageName, java.lang.String dbClassName)
          Stores the database class name
static void addInitialSyncParameter(java.lang.String id, java.lang.String paramName, java.lang.Object paramValue, java.lang.String schemaType)
          Add initial sync parameter
static void addMBOAttribute(java.lang.String id, java.lang.String columnName, int displayNameRID, java.lang.String schemaType, LogicalType logicalType)
          Add MBO attribute object
static void addMBOAttribute(java.lang.String id, java.lang.String columnName, java.lang.String displayName, java.lang.String schemaType, LogicalType logicalType)
          Add MBO attribute object
static void addMobileApplication(java.lang.String id, java.lang.String name, java.lang.String profileRefID, int displayNameRID, java.lang.String packageName, int type)
          This method add a mobile application
static void addMobileApplication(java.lang.String id, java.lang.String name, java.lang.String profileRefID, java.lang.String displayName, java.lang.String packageName, int type)
          This method add a mobile application
static void addOtherOperations(java.lang.String mboId, java.lang.String operationName)
          Add other operation
static void addPersonalizationKey(java.lang.String key)
          Add personalization key
static void addPersonalizationKey(java.lang.String packageName, java.lang.String key, boolean isProtected, java.lang.String spMBOId, java.lang.String screenId, boolean isList)
          Add personalization key
static void addPKMobileApplication(java.lang.String id, java.lang.String name, java.lang.String profileRefID, java.lang.String displayName, java.lang.String packageName, boolean isSyncable)
          Add a PK mobile application
static void addScreen(java.lang.String screenId, IBOBScreen screen)
          Register the screen
static void addScreenReference(IBOBScreen bobcscreen)
          Add screen references
static void addVariable(java.lang.String key, java.lang.String value, java.lang.String type, java.lang.String schemaType)
          Add custom variable to persist
static void addVariables(java.util.Hashtable variables)
          Add a hashtable of custom variables to persist
 AppLoggerWrapper getAppLogger()
          Getts the application logger wrapper
static java.util.Hashtable getAssociations()
           
abstract  java.lang.String getClientName()
          This method will return the client name
static java.lang.String getCurrentAssociationName()
          Get the current association name used for relationship
static java.lang.String getDatabaseClass(java.lang.String packageName)
          Gets the name of the database class that is defined for the given package
 java.lang.String getDatabaseClassforLogger()
          Gets the name of the database class that is used for the application trace
static java.util.Hashtable getInitialSyncParameterByID(java.lang.String id)
          Get the sync parameters by mbo id
static java.util.Hashtable getInitialSyncParameters()
          Get initial sync parameters
static java.util.Hashtable getMBOAttributeByID(java.lang.String id)
          Get the column attribute by ID
static java.util.Hashtable getMBOAttributes()
          Get column attributes
static java.util.Vector getMobileApps()
           
static java.util.Hashtable getOtherOperations()
          Get other operations
 java.lang.String getPackageNameforLogger()
          Gets the name of the package that is used for application trace
 java.util.Enumeration getPackages()
          Gets all package names that are used in the application.
 int getPendingOperationNumber()
          Get the minium number of pending operations to do sync
 long getPersistentKey(java.lang.String key)
          This method will return the persistent key for a specific package
static java.util.Hashtable getPersonalizationKeys()
          Get personalization keys
static net.rim.device.api.i18n.ResourceBundle getResourceBundle()
          Get the resource bundle
static IBOBScreen getScreen(java.lang.String screenId)
          Get the IBOBScreen by id
static java.util.Vector getScreenRerences()
          Get the list of screen references
 IBOBScreen getStartUpScreen()
          This method will return the first startup screen
static java.lang.String getSyncCompletedMessage()
          Get sync completed message
static java.lang.String getSyncConnectingMessage()
          Get sync connecting message
static java.lang.String getSyncDownloadingMessage()
          Get sync downloading message
 java.lang.Object getSyncLock()
          Get the sync lock object
static java.lang.String getSyncMessage()
          Get sync message that goes on the sync progress screen
static java.lang.String getSyncMetaDataDownloadingMessage()
          Get sync meta data downloading message
static java.lang.String getSyncMetaDataUploadingMessage()
          Get sync meta data uploading message
static java.lang.String getSyncPublicationMessage()
          Get sync publication message that goes on the sync progress screen
 int getSyncStartupFrequency()
          Get the sync on start up frequency
 java.lang.String getSyncStartupType()
          Get the sync on start up type
static java.lang.String getSyncUploadingMessage()
          Get sync uploading message
static java.lang.Object getTableContextColumnValue(java.lang.String mobileAppID, java.lang.String columnName)
          Get the current table context column values
static boolean hasLoginScreen()
          Check if there is a login screen assigned to the client
 void init()
          Instantiate the profile, mobile applications, and screens
protected  void initAppLoggerWrapper()
           
protected  void initProfileInfo()
           
 boolean isSyncDeleteOperation()
          Check to see if we sync the mobile business object after performing a delete operation
 boolean isSyncFirstTime()
          Check to see if we need to sync the first time
 boolean isSyncPendingOperation()
          Check to see if we need to sync on a certain number of operations
 boolean isSyncStartup()
          Check to see if client should sync on start up
static void printOutLastActiveTableContext(java.lang.String from)
           
static void setCurrentAssoicationName(java.lang.String associationName)
          Set the current association name
static void setHasLoginScreen(boolean bol)
          Set if there is a login screen
 void setIsSyncFirstTime(boolean bol)
          Set if is sync first time
static void setLastActiveTableContextMobileAppID(java.lang.String mobileAppID)
          Set the last active table contenxt mobile application ID
static void setResourceBundle(net.rim.device.api.i18n.ResourceBundle resource)
          Set the resource bundle
 void setStartUpScreen(IBOBScreen startUpScreen)
          This method will set the startup screen
static void setSyncCompletedMessage(int rid)
          Set sync completed message
static void setSyncCompletedMessage(java.lang.String message)
          Set sync completed message
static void setSyncConnectingMessage(int rid)
          Set sync connecting message
static void setSyncConnectingMessage(java.lang.String message)
          Set sync connecting message
static void setSyncDownloadingMessage(int rid)
          Set sync downloading message
static void setSyncDownloadingMessage(java.lang.String message)
          Set sync downloading message
static void setSyncMessage(int resourceID)
          Set sync message that goes on the sync progress screen
static void setSyncMessage(java.lang.String message)
          Set sync message that goes on the sync progress screen
static void setSyncMetaDataDownloadingMessage(int rid)
          Set sync meta data downloading message
static void setSyncMetaDataDownloadingMessage(java.lang.String message)
          Set sync meta data downloading message
static void setSyncMetaDataUploadingMessage(int rid)
          Set sync meta data uploading message
static void setSyncMetaDataUploadingMessage(java.lang.String message)
          Set sync meta data uploading message
static void setSyncProperties(boolean syncStartup, int syncStartupFrequency, java.lang.String syncStartupType, boolean syncFirstTime, boolean pendingOperation, int pendingOperationNumber, boolean deleteOperation)
          Set the Sync information properties
static void setSyncPublicationMessage(int resourceID)
          Set sync publication message that goes on the sync progress screen
static void setSyncPublicationMessage(java.lang.String message)
          Set sync pulication message that goes on the sync progress screen
static void setSyncUploadingMessage(int rid)
          Set sync uploading message
static void setSyncUploadingMessage(java.lang.String message)
          Set sync uploading message
static void setTableContextProperties(java.lang.String mobileAppID, java.util.Hashtable columnValues)
          Set the table context properties
 void setup()
          Setup the profile, sync settings, mobile applications, and variables
static void setUseMilliSeconds(boolean useMilliSeconds)
          Set the flag to use Milliseconds for date and datetime values
static void updateTableContextObjects(java.lang.String mobileAppID, java.util.Hashtable columnValues)
          Update the table context objects based on a mobile application ID
static boolean useMilliSeconds()
          Get the flag to use Milliseconds for date and datetime values
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

KEY

public static final long KEY
See Also:
Constant Field Values

DEFAULT_SYNC_MESSAGE

public static final java.lang.String DEFAULT_SYNC_MESSAGE
See Also:
Constant Field Values

DEFAULT_SYNC_PUBLICATION_MESSAGE

public static final java.lang.String DEFAULT_SYNC_PUBLICATION_MESSAGE
See Also:
Constant Field Values

DEFAULT_SYNC_CONNECTING_MESSAGE

public static final java.lang.String DEFAULT_SYNC_CONNECTING_MESSAGE
See Also:
Constant Field Values

DEFAULT_SYNC_UPLOADING_MESSAGE

public static final java.lang.String DEFAULT_SYNC_UPLOADING_MESSAGE
See Also:
Constant Field Values

DEFAULT_SYNC_DOWNLOADING_MESSAGE

public static final java.lang.String DEFAULT_SYNC_DOWNLOADING_MESSAGE
See Also:
Constant Field Values

DEFAULT_SYNC_METADATA_UPLOADING_MESSAGE

public static final java.lang.String DEFAULT_SYNC_METADATA_UPLOADING_MESSAGE
See Also:
Constant Field Values

DEFAULT_SYNC_METADATA_DOWNLOADING_MESSAGE

public static final java.lang.String DEFAULT_SYNC_METADATA_DOWNLOADING_MESSAGE
See Also:
Constant Field Values

DEFAULT_SYNC_COMPLETED_MESSAGE

public static final java.lang.String DEFAULT_SYNC_COMPLETED_MESSAGE
See Also:
Constant Field Values
Constructor Detail

UIDefinition

public UIDefinition()
UIDefinition Constructor Instantiate the Event Logger

Method Detail

init

public void init()
Instantiate the profile, mobile applications, and screens


getPersistentKey

public long getPersistentKey(java.lang.String key)
This method will return the persistent key for a specific package

Parameters:
key - - The key for the persistent class
Returns:
long - The persistent key for this specific client on this RIM device

getClientName

public abstract java.lang.String getClientName()
This method will return the client name

Returns:
String - The client name for this client on this device

getStartUpScreen

public IBOBScreen getStartUpScreen()
This method will return the first startup screen

Returns:
Screen - The first startup screen

setStartUpScreen

public void setStartUpScreen(IBOBScreen startUpScreen)
This method will set the startup screen

Parameters:
startUpScreen - - The first startup screen

addMobileApplication

public static void addMobileApplication(java.lang.String id,
                                        java.lang.String name,
                                        java.lang.String profileRefID,
                                        java.lang.String displayName,
                                        java.lang.String packageName,
                                        int type)
This method add a mobile application

Parameters:
id - - reference ID
name - - Name of the mobile application
profileRefID - - Profile reference ID
displayName - - The display name for the mobile application
packageName - - The package name

addMobileApplication

public static void addMobileApplication(java.lang.String id,
                                        java.lang.String name,
                                        java.lang.String profileRefID,
                                        int displayNameRID,
                                        java.lang.String packageName,
                                        int type)
This method add a mobile application

Parameters:
id - - reference ID
name - - Name of the mobile application
profileRefID - - Profile reference ID
displayNameRID - - Resource bunch ID for the display name of the mobile application
packageName - - The package name

addPKMobileApplication

public static void addPKMobileApplication(java.lang.String id,
                                          java.lang.String name,
                                          java.lang.String profileRefID,
                                          java.lang.String displayName,
                                          java.lang.String packageName,
                                          boolean isSyncable)
Add a PK mobile application

Parameters:
id - application id
name - application name
profileRefID - referenced profile id
displayName - the display name, for pk mbo, it usually ""
packageName - package name
isSyncable - if the PK mobile application is syncable

setSyncProperties

public static void setSyncProperties(boolean syncStartup,
                                     int syncStartupFrequency,
                                     java.lang.String syncStartupType,
                                     boolean syncFirstTime,
                                     boolean pendingOperation,
                                     int pendingOperationNumber,
                                     boolean deleteOperation)
Set the Sync information properties

Parameters:
syncStartup - - If true sync on startup
syncStartupFrequency - - Sync frequency in day, hour, or minute
syncStartupType - - Sync start up type
syncFirstTime - - Sync the first time
pendingOperation - - If true, synchronize mobile business object data if the number of pending operations equals or exceeds the number selected.
pendingOperationNumber - - maximum number of pending operations before a synchronization of table data should happen.
deleteOperation - - When a user performs a delete, immediately do synchronization on the mobile business object data.

isSyncStartup

public boolean isSyncStartup()
Check to see if client should sync on start up

Returns:
If true sync on start up, otherwise don't

getSyncStartupFrequency

public int getSyncStartupFrequency()
Get the sync on start up frequency

Returns:
the frequency number in days, hours or minutes

getSyncStartupType

public java.lang.String getSyncStartupType()
Get the sync on start up type

Returns:
Type can be SYNC_START_TYPE_MINUTE, SYNC_START_TYPE_HOUR, or SYNC_START_TYPE_DAY

isSyncFirstTime

public boolean isSyncFirstTime()
Check to see if we need to sync the first time

Returns:
True if sync first time, otherwise don't

isSyncPendingOperation

public boolean isSyncPendingOperation()
Check to see if we need to sync on a certain number of operations

Returns:
if true, sync on a certain number of operations, else false do nothing

getPendingOperationNumber

public int getPendingOperationNumber()
Get the minium number of pending operations to do sync

Returns:
number of operations to perform sync

isSyncDeleteOperation

public boolean isSyncDeleteOperation()
Check to see if we sync the mobile business object after performing a delete operation

Returns:
if true, sync mobile business object after delete operation is performed, else false do nothing

setIsSyncFirstTime

public void setIsSyncFirstTime(boolean bol)
Set if is sync first time

Parameters:
bol - - If true sync first time during boot up

addPersonalizationKey

public static void addPersonalizationKey(java.lang.String key)
Add personalization key

Parameters:
key - - personalization key

addPersonalizationKey

public static void addPersonalizationKey(java.lang.String packageName,
                                         java.lang.String key,
                                         boolean isProtected,
                                         java.lang.String spMBOId,
                                         java.lang.String screenId,
                                         boolean isList)
Add personalization key

Parameters:
packageName - - package name of project
key - - personalization key
isProtected - - whether the personalization key is protected
spMBOId - - the structured type mbo id if the pk is structured type(complex type)
isList - - whether the pk type is a list of structured type

getPersonalizationKeys

public static java.util.Hashtable getPersonalizationKeys()
Get personalization keys

Returns:
Hashtable of personalization keys

addOtherOperations

public static void addOtherOperations(java.lang.String mboId,
                                      java.lang.String operationName)
Add other operation

Parameters:
mboId - - id of mbo application
operationName - - name of other operation

getOtherOperations

public static java.util.Hashtable getOtherOperations()
Get other operations

Returns:
Hashtable of other operation

addVariables

public static void addVariables(java.util.Hashtable variables)
Add a hashtable of custom variables to persist

Parameters:
variables - - hashtable of variables

setUseMilliSeconds

public static void setUseMilliSeconds(boolean useMilliSeconds)
Set the flag to use Milliseconds for date and datetime values

Parameters:
useMilliSeconds - - true or false

useMilliSeconds

public static boolean useMilliSeconds()
Get the flag to use Milliseconds for date and datetime values

Returns:
true to use milliseconds false otherwise

addVariable

public static void addVariable(java.lang.String key,
                               java.lang.String value,
                               java.lang.String type,
                               java.lang.String schemaType)
Add custom variable to persist

Parameters:
key - - key of the variable
value - - value of the key
type - - type of variable, could be "SYSTEM", "USER", "TABLE"
schema - type - data type of variable, e.g. INT, STRING, DATE, etc

addMBOAttribute

public static void addMBOAttribute(java.lang.String id,
                                   java.lang.String columnName,
                                   int displayNameRID,
                                   java.lang.String schemaType,
                                   LogicalType logicalType)
Add MBO attribute object

Parameters:
id - - mbo id name
columnName - - column name
displayNameRID - - localization resouce ID for the display name
schemaType - - data type eg. MBOAttribute.SCHEMA_TYPE_STRING, MBOAttribute.SCHEMA_TYPE_DATE, MBOAttribute.SCHEMA_TYPE_INT and etc.
logicalType - - Logical type object @see import com.sybase.uep.bobclient.LogicalType

addMBOAttribute

public static void addMBOAttribute(java.lang.String id,
                                   java.lang.String columnName,
                                   java.lang.String displayName,
                                   java.lang.String schemaType,
                                   LogicalType logicalType)
Add MBO attribute object

Parameters:
id - - mbo id name
columnName - - column name
displayName - - display name
schemaType - - data type eg. MBOAttribute.SCHEMA_TYPE_STRING, MBOAttribute.SCHEMA_TYPE_DATE, MBOAttribute.SCHEMA_TYPE_INT and etc.
logicalType - - Logical type object @see import com.sybase.uep.bobclient.LogicalType

getMBOAttributes

public static java.util.Hashtable getMBOAttributes()
Get column attributes


getMBOAttributeByID

public static java.util.Hashtable getMBOAttributeByID(java.lang.String id)
Get the column attribute by ID

Parameters:
id - - id to search by
Returns:
Hashtable of MBOAttribute objects referenced by MBO id

addInitialSyncParameter

public static void addInitialSyncParameter(java.lang.String id,
                                           java.lang.String paramName,
                                           java.lang.Object paramValue,
                                           java.lang.String schemaType)
Add initial sync parameter

Parameters:
id - - mbo id
paramName - - parameter name
paramValue - - parameter value

getInitialSyncParameters

public static java.util.Hashtable getInitialSyncParameters()
Get initial sync parameters


getInitialSyncParameterByID

public static java.util.Hashtable getInitialSyncParameterByID(java.lang.String id)
Get the sync parameters by mbo id

Parameters:
id - - mbo id to search by
Returns:
Hashtable of parameters referenced by MBO id

hasLoginScreen

public static boolean hasLoginScreen()
Check if there is a login screen assigned to the client

Returns:
true if there is a login screen else false

setHasLoginScreen

public static void setHasLoginScreen(boolean bol)
Set if there is a login screen

Parameters:
bol - - true if there is a login screen else false

getSyncLock

public java.lang.Object getSyncLock()
Get the sync lock object

Returns:
Object

getSyncMessage

public static java.lang.String getSyncMessage()
Get sync message that goes on the sync progress screen

Returns:
message

setSyncMessage

public static void setSyncMessage(int resourceID)
Set sync message that goes on the sync progress screen

Parameters:
resourceID - - localization resource ID

setSyncMessage

public static void setSyncMessage(java.lang.String message)
Set sync message that goes on the sync progress screen

Parameters:
message - - new message, can't be null or empty string

getSyncPublicationMessage

public static java.lang.String getSyncPublicationMessage()
Get sync publication message that goes on the sync progress screen

Returns:
message

setSyncPublicationMessage

public static void setSyncPublicationMessage(int resourceID)
Set sync publication message that goes on the sync progress screen

Parameters:
resourceID - - localization resource ID

setSyncPublicationMessage

public static void setSyncPublicationMessage(java.lang.String message)
Set sync pulication message that goes on the sync progress screen

Parameters:
message - - new message, can't be null or empty string

getSyncConnectingMessage

public static java.lang.String getSyncConnectingMessage()
Get sync connecting message

Returns:
message

setSyncConnectingMessage

public static void setSyncConnectingMessage(int rid)
Set sync connecting message

Parameters:
rid - - localization resource ID

setSyncConnectingMessage

public static void setSyncConnectingMessage(java.lang.String message)
Set sync connecting message

Parameters:
message - - new message, can't be null or empty string

getSyncUploadingMessage

public static java.lang.String getSyncUploadingMessage()
Get sync uploading message

Returns:
message

setSyncUploadingMessage

public static void setSyncUploadingMessage(int rid)
Set sync uploading message

Parameters:
rid - - localization resource ID

setSyncUploadingMessage

public static void setSyncUploadingMessage(java.lang.String message)
Set sync uploading message

Parameters:
message - - new message, can't be null or empty string

getSyncDownloadingMessage

public static java.lang.String getSyncDownloadingMessage()
Get sync downloading message

Returns:
message

setSyncDownloadingMessage

public static void setSyncDownloadingMessage(int rid)
Set sync downloading message

Parameters:
rid - - localization resource ID

setSyncDownloadingMessage

public static void setSyncDownloadingMessage(java.lang.String message)
Set sync downloading message

Parameters:
message - - new message, can't be null or empty string

getSyncCompletedMessage

public static java.lang.String getSyncCompletedMessage()
Get sync completed message

Returns:
message

setSyncCompletedMessage

public static void setSyncCompletedMessage(int rid)
Set sync completed message

Parameters:
rid - - localization resource ID

setSyncCompletedMessage

public static void setSyncCompletedMessage(java.lang.String message)
Set sync completed message

Parameters:
message - - new message, can't be null or empty string

getSyncMetaDataUploadingMessage

public static java.lang.String getSyncMetaDataUploadingMessage()
Get sync meta data uploading message

Returns:
message

setSyncMetaDataUploadingMessage

public static void setSyncMetaDataUploadingMessage(int rid)
Set sync meta data uploading message

Parameters:
rid - - localization resource ID

setSyncMetaDataUploadingMessage

public static void setSyncMetaDataUploadingMessage(java.lang.String message)
Set sync meta data uploading message

Parameters:
message - - new message, can't be null or empty string

getSyncMetaDataDownloadingMessage

public static java.lang.String getSyncMetaDataDownloadingMessage()
Get sync meta data downloading message

Returns:
message

setSyncMetaDataDownloadingMessage

public static void setSyncMetaDataDownloadingMessage(int rid)
Set sync meta data downloading message

Parameters:
rid - - localization resource ID

setSyncMetaDataDownloadingMessage

public static void setSyncMetaDataDownloadingMessage(java.lang.String message)
Set sync meta data downloading message

Parameters:
message - - new message, can't be null or empty string

setLastActiveTableContextMobileAppID

public static void setLastActiveTableContextMobileAppID(java.lang.String mobileAppID)
Set the last active table contenxt mobile application ID

Parameters:
mobileAppID - - string value of the mobile application ID

updateTableContextObjects

public static void updateTableContextObjects(java.lang.String mobileAppID,
                                             java.util.Hashtable columnValues)
Update the table context objects based on a mobile application ID

Parameters:
mobileAppID - - mobile application ID
selectedRowIndex - - current table context selected row index
row - - current table context row object
columnValues - - current table context row column values
dataHandler - - the data handler of the mobile application
pagingObject - - paging information that was applied to appData

setTableContextProperties

public static void setTableContextProperties(java.lang.String mobileAppID,
                                             java.util.Hashtable columnValues)
Set the table context properties

Parameters:
mobileAppID - - mobile application ID
selectedRowIndex - - current table context selected row index
row - - current table context row object
dataHandler - - data handler of the mobile application
pagingObject - - paging information that was applied to appData

printOutLastActiveTableContext

public static void printOutLastActiveTableContext(java.lang.String from)

getTableContextColumnValue

public static java.lang.Object getTableContextColumnValue(java.lang.String mobileAppID,
                                                          java.lang.String columnName)
Get the current table context column values

Parameters:
mobileAppID - - mobile application ID
columnName - - column name
Returns:
column value

setCurrentAssoicationName

public static void setCurrentAssoicationName(java.lang.String associationName)
Set the current association name

Parameters:
associationName - - association name used for relationship

getCurrentAssociationName

public static java.lang.String getCurrentAssociationName()
Get the current association name used for relationship

Returns:
association name used for relationship

addScreenReference

public static void addScreenReference(IBOBScreen bobcscreen)
Add screen references

Parameters:
bobcscreen - - IBOBScreen references

getScreenRerences

public static java.util.Vector getScreenRerences()
Get the list of screen references

Returns:
vector of screen references

setResourceBundle

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

Parameters:
resource - - Resource Bundle object

getResourceBundle

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

Returns:
Resource Bundle object

setup

public void setup()
Setup the profile, sync settings, mobile applications, and variables

Specified by:
setup in class BaseDefinition

initProfileInfo

protected void initProfileInfo()

initAppLoggerWrapper

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

getAppLogger

public AppLoggerWrapper getAppLogger()
Getts the application logger wrapper

Specified by:
getAppLogger in class BaseDefinition

addDatabaseClass

public static 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 static 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.

getPackages

public java.util.Enumeration getPackages()
Gets all package names that are used in the application.

Returns:
an enumeration of all package names.

addScreen

public static void addScreen(java.lang.String screenId,
                             IBOBScreen screen)
Register the screen

Parameters:
struMBOId -
screen -

getScreen

public static IBOBScreen getScreen(java.lang.String screenId)
Get the IBOBScreen by id

Parameters:
screenId -
Returns:

getDatabaseClassforLogger

public java.lang.String getDatabaseClassforLogger()
Gets the name of the database class that is used for the application trace

Returns:
empty string if no database class is found.

getPackageNameforLogger

public java.lang.String getPackageNameforLogger()
Gets the name of the package that is used for application trace

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

addAssociation

public static void addAssociation(java.lang.String packageName,
                                  java.lang.String name,
                                  java.lang.String leftNode,
                                  java.lang.String rightNode,
                                  int type,
                                  boolean inverse)
Create an association and store it

Parameters:
packageName -
name -
leftNode -
rightNode -

getAssociations

public static java.util.Hashtable getAssociations()
Returns:
all associations.

getMobileApps

public static java.util.Vector getMobileApps()
Returns:
all mbo applications.