|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sybase.uep.bobclient.custom.BaseDefinition
com.sybase.uep.bobclient.custom.UIDefinition
public abstract class UIDefinition
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.
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 |
---|
public static final long KEY
public static final java.lang.String DEFAULT_SYNC_MESSAGE
public static final java.lang.String DEFAULT_SYNC_PUBLICATION_MESSAGE
public static final java.lang.String DEFAULT_SYNC_CONNECTING_MESSAGE
public static final java.lang.String DEFAULT_SYNC_UPLOADING_MESSAGE
public static final java.lang.String DEFAULT_SYNC_DOWNLOADING_MESSAGE
public static final java.lang.String DEFAULT_SYNC_METADATA_UPLOADING_MESSAGE
public static final java.lang.String DEFAULT_SYNC_METADATA_DOWNLOADING_MESSAGE
public static final java.lang.String DEFAULT_SYNC_COMPLETED_MESSAGE
Constructor Detail |
---|
public UIDefinition()
Method Detail |
---|
public void init()
public long getPersistentKey(java.lang.String key)
key
- - The key for the persistent class
public abstract java.lang.String getClientName()
public IBOBScreen getStartUpScreen()
public void setStartUpScreen(IBOBScreen startUpScreen)
startUpScreen
- - The first startup screenpublic 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)
id
- - reference IDname
- - Name of the mobile applicationprofileRefID
- - Profile reference IDdisplayName
- - The display name for the mobile applicationpackageName
- - The package namepublic static void addMobileApplication(java.lang.String id, java.lang.String name, java.lang.String profileRefID, int displayNameRID, java.lang.String packageName, int type)
id
- - reference IDname
- - Name of the mobile applicationprofileRefID
- - Profile reference IDdisplayNameRID
- - Resource bunch ID for the display name of the mobile applicationpackageName
- - The package namepublic 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)
id
- application idname
- application nameprofileRefID
- referenced profile iddisplayName
- the display name, for pk mbo, it usually ""packageName
- package nameisSyncable
- if the PK mobile application is syncablepublic static void setSyncProperties(boolean syncStartup, int syncStartupFrequency, java.lang.String syncStartupType, boolean syncFirstTime, boolean pendingOperation, int pendingOperationNumber, boolean deleteOperation)
syncStartup
- - If true sync on startupsyncStartupFrequency
- - Sync frequency in day, hour, or minutesyncStartupType
- - Sync start up typesyncFirstTime
- - Sync the first timependingOperation
- - 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.public boolean isSyncStartup()
public int getSyncStartupFrequency()
public java.lang.String getSyncStartupType()
public boolean isSyncFirstTime()
public boolean isSyncPendingOperation()
public int getPendingOperationNumber()
public boolean isSyncDeleteOperation()
public void setIsSyncFirstTime(boolean bol)
bol
- - If true sync first time during boot uppublic static void addPersonalizationKey(java.lang.String key)
key
- - personalization keypublic static void addPersonalizationKey(java.lang.String packageName, java.lang.String key, boolean isProtected, java.lang.String spMBOId, java.lang.String screenId, boolean isList)
packageName
- - package name of projectkey
- - personalization keyisProtected
- - whether the personalization key is protectedspMBOId
- - the structured type mbo id if the pk is structured type(complex type)isList
- - whether the pk type is a list of structured typepublic static java.util.Hashtable getPersonalizationKeys()
public static void addOtherOperations(java.lang.String mboId, java.lang.String operationName)
mboId
- - id of mbo applicationoperationName
- - name of other operationpublic static java.util.Hashtable getOtherOperations()
public static void addVariables(java.util.Hashtable variables)
variables
- - hashtable of variablespublic static void setUseMilliSeconds(boolean useMilliSeconds)
useMilliSeconds
- - true or falsepublic static boolean useMilliSeconds()
public static void addVariable(java.lang.String key, java.lang.String value, java.lang.String type, java.lang.String schemaType)
key
- - key of the variablevalue
- - value of the keytype
- - type of variable, could be "SYSTEM", "USER", "TABLE"schema
- type - data type of variable, e.g. INT, STRING, DATE, etcpublic static void addMBOAttribute(java.lang.String id, java.lang.String columnName, int displayNameRID, java.lang.String schemaType, LogicalType logicalType)
id
- - mbo id namecolumnName
- - column namedisplayNameRID
- - localization resouce ID for the display nameschemaType
- - 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.LogicalTypepublic static void addMBOAttribute(java.lang.String id, java.lang.String columnName, java.lang.String displayName, java.lang.String schemaType, LogicalType logicalType)
id
- - mbo id namecolumnName
- - column namedisplayName
- - display nameschemaType
- - 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.LogicalTypepublic static java.util.Hashtable getMBOAttributes()
public static java.util.Hashtable getMBOAttributeByID(java.lang.String id)
id
- - id to search by
public static void addInitialSyncParameter(java.lang.String id, java.lang.String paramName, java.lang.Object paramValue, java.lang.String schemaType)
id
- - mbo idparamName
- - parameter nameparamValue
- - parameter valuepublic static java.util.Hashtable getInitialSyncParameters()
public static java.util.Hashtable getInitialSyncParameterByID(java.lang.String id)
id
- - mbo id to search by
public static boolean hasLoginScreen()
public static void setHasLoginScreen(boolean bol)
bol
- - true if there is a login screen else falsepublic java.lang.Object getSyncLock()
public static java.lang.String getSyncMessage()
public static void setSyncMessage(int resourceID)
resourceID
- - localization resource IDpublic static void setSyncMessage(java.lang.String message)
message
- - new message, can't be null or empty stringpublic static java.lang.String getSyncPublicationMessage()
public static void setSyncPublicationMessage(int resourceID)
resourceID
- - localization resource IDpublic static void setSyncPublicationMessage(java.lang.String message)
message
- - new message, can't be null or empty stringpublic static java.lang.String getSyncConnectingMessage()
public static void setSyncConnectingMessage(int rid)
rid
- - localization resource IDpublic static void setSyncConnectingMessage(java.lang.String message)
message
- - new message, can't be null or empty stringpublic static java.lang.String getSyncUploadingMessage()
public static void setSyncUploadingMessage(int rid)
rid
- - localization resource IDpublic static void setSyncUploadingMessage(java.lang.String message)
message
- - new message, can't be null or empty stringpublic static java.lang.String getSyncDownloadingMessage()
public static void setSyncDownloadingMessage(int rid)
rid
- - localization resource IDpublic static void setSyncDownloadingMessage(java.lang.String message)
message
- - new message, can't be null or empty stringpublic static java.lang.String getSyncCompletedMessage()
public static void setSyncCompletedMessage(int rid)
rid
- - localization resource IDpublic static void setSyncCompletedMessage(java.lang.String message)
message
- - new message, can't be null or empty stringpublic static java.lang.String getSyncMetaDataUploadingMessage()
public static void setSyncMetaDataUploadingMessage(int rid)
rid
- - localization resource IDpublic static void setSyncMetaDataUploadingMessage(java.lang.String message)
message
- - new message, can't be null or empty stringpublic static java.lang.String getSyncMetaDataDownloadingMessage()
public static void setSyncMetaDataDownloadingMessage(int rid)
rid
- - localization resource IDpublic static void setSyncMetaDataDownloadingMessage(java.lang.String message)
message
- - new message, can't be null or empty stringpublic static void setLastActiveTableContextMobileAppID(java.lang.String mobileAppID)
mobileAppID
- - string value of the mobile application IDpublic static void updateTableContextObjects(java.lang.String mobileAppID, java.util.Hashtable columnValues)
mobileAppID
- - mobile application IDselectedRowIndex
- - current table context selected row indexrow
- - current table context row objectcolumnValues
- - current table context row column valuesdataHandler
- - the data handler of the mobile applicationpagingObject
- - paging information that was applied to appDatapublic static void setTableContextProperties(java.lang.String mobileAppID, java.util.Hashtable columnValues)
mobileAppID
- - mobile application IDselectedRowIndex
- - current table context selected row indexrow
- - current table context row objectdataHandler
- - data handler of the mobile applicationpagingObject
- - paging information that was applied to appDatapublic static void printOutLastActiveTableContext(java.lang.String from)
public static java.lang.Object getTableContextColumnValue(java.lang.String mobileAppID, java.lang.String columnName)
mobileAppID
- - mobile application IDcolumnName
- - column name
public static void setCurrentAssoicationName(java.lang.String associationName)
associationName
- - association name used for relationshippublic static java.lang.String getCurrentAssociationName()
public static void addScreenReference(IBOBScreen bobcscreen)
bobcscreen
- - IBOBScreen referencespublic static java.util.Vector getScreenRerences()
public static void setResourceBundle(net.rim.device.api.i18n.ResourceBundle resource)
resource
- - Resource Bundle objectpublic static net.rim.device.api.i18n.ResourceBundle getResourceBundle()
public void setup()
setup
in class BaseDefinition
protected void initProfileInfo()
protected void initAppLoggerWrapper()
initAppLoggerWrapper
in class BaseDefinition
public AppLoggerWrapper getAppLogger()
getAppLogger
in class BaseDefinition
public static void addDatabaseClass(java.lang.String packageName, java.lang.String dbClassName)
packageName
- - package name of database classdbClassName
- - database class namepublic static java.lang.String getDatabaseClass(java.lang.String packageName)
packageName
- - package name of database class
public java.util.Enumeration getPackages()
public static void addScreen(java.lang.String screenId, IBOBScreen screen)
struMBOId
- screen
- public static IBOBScreen getScreen(java.lang.String screenId)
screenId
-
public java.lang.String getDatabaseClassforLogger()
public java.lang.String getPackageNameforLogger()
packageName
- - package name of database class
public static void addAssociation(java.lang.String packageName, java.lang.String name, java.lang.String leftNode, java.lang.String rightNode, int type, boolean inverse)
packageName
- name
- leftNode
- rightNode
- public static java.util.Hashtable getAssociations()
public static java.util.Vector getMobileApps()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |