com.unvired.core

Class ApplicationManager

java.lang.Object

com.unvired.core.ApplicationManager

public class ApplicationManager
extends java.lang.Object

ApplicationManager provides information about the application, application meta data and access to the application's data manager.

• Application Info: Application name and application id in the Unvired server.
• Application Meta Data: Meta data describing the application ( ApplicationMeta), the business entities (BusinessEntityMeta), the data structure objects (headers and items - StructureMeta) and fields of the data structures (FieldMeta).
• Application Data Manager: Data manager is the handle to the application to the database for database operations - IDataManager.

ApplicationManager is a singleton and access to its instance has to be obtained using the static method getInstance().

 Example:
  IDataManager applicationDataManager = ApplicationManager.getInstance().getDataManager();
 

Method Summary

Modifier and Type	Method and Description
void	activateApplication(java.lang.String appId)
void	closeDB()
void	deactivateApplication(java.lang.String appId)
static void	destroy()
void	dropDatabase()
java.lang.String	getAppBuild()
java.lang.String	getApplicationId() Provides the application id.
com.unvired.model.ApplicationMeta	getApplicationMeta() Returns the ApplicationMeta.
com.unvired.model.ApplicationMeta	getApplicationMeta(java.lang.String appName)
java.lang.String	getApplicationName() Provides the application name.
com.unvired.model.BusinessEntityMeta[]	getBusinessEntitiesMeta() Return an array of business entities in the application - BusinessEntityMeta.
com.unvired.model.BusinessEntityMeta	getBusinessEntityMeta(java.lang.String beName) Return the business entity with the given name - BusinessEntityMeta.
IDataManager	getDataManager() Provides access to the applications data manager to perform database operations.
com.unvired.model.FieldMeta	getFieldMeta(java.lang.String structureName, java.lang.String fieldName) Return the field details of the given structure and field - FieldMeta.
com.unvired.model.FieldMeta[]	getFieldsMeta(java.lang.String structureName) Return the details of all the fields belonging to a given structure name - FieldMeta.
java.lang.String[]	getGIDFields(java.lang.String structureName) Returns the global identifier fields for the give structure name.
com.unvired.model.StructureMeta	getHeaderStructureMeta(java.lang.String beName) Return the header structure details for the given business entity name - StructureMeta.
static ApplicationManager	getInstance() Gets the single instance of ApplicationManager.
com.unvired.model.StructureMeta	getStructureMeta(java.lang.String structureName) Return the structure details for the given structure name - StructureMeta.
com.unvired.model.StructureMeta	getStructureMeta(java.lang.String beName, java.lang.String structureName) Return the structure details for the given business entity and structure name - StructureMeta.
com.unvired.model.StructureMeta[]	getStructureMetas(java.lang.String beName) Return the structure details of all the structures belonging to a given business entity - StructureMeta.
void	initialize(java.lang.String appName, java.lang.String key, int version)
boolean	isActive()
boolean	isAttachmentSupported(java.lang.String beName) Check if attachment supported for BE
boolean	isInDemoMode() Check if the application is used in demo mode
static boolean	isRunnable(Activity currentActivity, java.lang.Class applicationStartActivityClass)
void	reset()
void	setAppBuild(java.lang.String appBuildNo)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ApplicationManager getInstance()

Gets the single instance of ApplicationManager.

Returns:

Returns an instance of an ApplicationManager.

isRunnable

public static boolean isRunnable(Activity currentActivity,
                                 java.lang.Class applicationStartActivityClass)

destroy

public static void destroy()

setAppBuild

public void setAppBuild(java.lang.String appBuildNo)

getAppBuild

public java.lang.String getAppBuild()

initialize

public void initialize(java.lang.String appName,
                       java.lang.String key,
                       int version)
                throws DBException

Throws:

DBException

getDataManager

public IDataManager getDataManager()
                            throws DBException

Provides access to the applications data manager to perform database operations.

Returns:

Returns an object of IDataManager to access the database.

Throws:

DBException - Throws a DBException when the values cannot be fetched from the database.

activateApplication

public void activateApplication(java.lang.String appId)
                         throws DBException

Throws:

DBException

deactivateApplication

public void deactivateApplication(java.lang.String appId)
                           throws DBException

Throws:

DBException

isActive

public boolean isActive()
                 throws DBException

Throws:

DBException

getApplicationName

public java.lang.String getApplicationName()

Provides the application name. Application name is same as the one given in the meta data.

Returns:

Returns the application name.

getApplicationId

public java.lang.String getApplicationId()

Provides the application id.

Returns:

Returns the application id.

isInDemoMode

public boolean isInDemoMode()
                     throws DBException

Check if the application is used in demo mode

Returns:

true if application is in demo mode otherwise false.

Throws:

DBException - DBExcaption if database error occurs

getApplicationMeta

public com.unvired.model.ApplicationMeta getApplicationMeta()
                                                     throws DBException

Returns the ApplicationMeta. Application meta provides information about the application.

Returns:

Returns the meta data of the application.

Throws:

DBException - Throws a DBException when the data cannot be fetched from the database.

getApplicationMeta

public com.unvired.model.ApplicationMeta getApplicationMeta(java.lang.String appName)
                                                     throws DBException

Throws:

DBException

getBusinessEntitiesMeta

public com.unvired.model.BusinessEntityMeta[] getBusinessEntitiesMeta()
                                                               throws DBException

Return an array of business entities in the application - BusinessEntityMeta.

Returns:

Returns an array of business entities belonging to the application.

Throws:

DBException - Throws a DBException when the data cannot be fetched from the database.

getBusinessEntityMeta

public com.unvired.model.BusinessEntityMeta getBusinessEntityMeta(java.lang.String beName)
                                                           throws DBException

Return the business entity with the given name - BusinessEntityMeta.

Parameters:

beName - of the business entity whose details are required.

Returns:

Returns the business entity with the given name.

Throws:

DBException - Throws a DBException when the data cannot be fetched from the database.

isAttachmentSupported

public boolean isAttachmentSupported(java.lang.String beName)
                              throws DBException,
                                     ApplicationException

Check if attachment supported for BE

Parameters:

beName - Name of the business entity to which the attachment belongs.

Returns:

true if attachments tag in BussineesEntity is set to true in metadata otherwise false.

Throws:

DBException - DBException if database error occurs

ApplicationException

getHeaderStructureMeta

public com.unvired.model.StructureMeta getHeaderStructureMeta(java.lang.String beName)
                                                       throws DBException

Return the header structure details for the given business entity name - StructureMeta.

Parameters:

beName - Name of the business entity to which the structure belongs.

Returns:

Returns the structure meta.

Throws:

DBException - Throws a DBException when the data cannot be fetched from the database.

getStructureMeta

public com.unvired.model.StructureMeta getStructureMeta(java.lang.String beName,
                                                        java.lang.String structureName)
                                                 throws DBException

Return the structure details for the given business entity and structure name - StructureMeta.

Parameters:

beName - Name of the business entity to which the structure belongs.

structureName - Name of the structure whose details are required.

Returns:

Returns the structure meta.

Throws:

DBException - Throws a DBException when the data cannot be fetched from the database.

getStructureMeta

public com.unvired.model.StructureMeta getStructureMeta(java.lang.String structureName)
                                                 throws DBException

Return the structure details for the given structure name - StructureMeta.

Parameters:

structureName - Name of the structure whose details are required.

Returns:

Returns the structure meta.

Throws:

DBException - Throws a DBException when the data cannot be fetched from the database.

getStructureMetas

public com.unvired.model.StructureMeta[] getStructureMetas(java.lang.String beName)
                                                    throws DBException

Return the structure details of all the structures belonging to a given business entity - StructureMeta.

Parameters:

beName - of the business entity to which the required structure belongs.

Returns:

Returns an array of structure meta.

Throws:

DBException - Throws a DBException when the data cannot be fetched from the database.

getFieldsMeta

public com.unvired.model.FieldMeta[] getFieldsMeta(java.lang.String structureName)
                                            throws DBException

Return the details of all the fields belonging to a given structure name - FieldMeta.

Parameters:

structureName - Name of the structure to which the field belongs.

Returns:

Returns an array of field meta.

Throws:

DBException - Throws a DBException when the data cannot be fetched from the database.

getFieldMeta

public com.unvired.model.FieldMeta getFieldMeta(java.lang.String structureName,
                                                java.lang.String fieldName)
                                         throws DBException

Return the field details of the given structure and field - FieldMeta.

Parameters:

structureName - Structure name to which the required field belongs

fieldName - Field name whose details is required

Returns:

Returns the field meta

Throws:

DBException - Throws a DBException when the data cannot be fetched from the database.

getGIDFields

public java.lang.String[] getGIDFields(java.lang.String structureName)
                                throws DBException

Returns the global identifier fields for the give structure name.

Parameters:

structureName - Name of the structure for which the global identifier fields are required.

Returns:

String[] Returns the global identifier fields of the structure.

Throws:

DBException - Throws a DBException when the data cannot be fetched from the database.

closeDB

public void closeDB()
             throws DBException

Throws:

DBException

dropDatabase

public void dropDatabase()
                  throws DBException

Throws:

DBException

reset

public void reset()
           throws DBException

Throws:

DBException