com.busit

Class App

Object

App

public abstract class App
extends Object

Constructor Summary

Constructors

Constructor and Description
App()

Method Summary

Methods

Modifier and Type	Method and Description
Any	config() Retrieve a configuration parameter.
void	config(Any conf) Sets the configuration parameters.
String	config(String key) Retrieve a configuration parameter.
String	id() Retreive the unique ID of this app instance.
String	locale() Retrieve the preferred user language.
String	name() Retreive the user-given name of this app instance.
void	notifyOwner(String message, Object data) Sends a notification to the app owner.
void	notifyUser(String message) Sends a notification to the app user.

Methods inherited from class Object

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

Constructor Detail

App

public App()

Method Detail

notifyOwner

public void notifyOwner(String message,
               Object data)

Sends a notification to the app owner. This method is useful for debugging purposes.

Parameters:

data - Some other useful data that will be converted to JSON

message - A textual note

notifyUser

public void notifyUser(String message)

Sends a notification to the app user. This method is useful for debugging purposes.

Parameters:

message - A textual note

config

public void config(Any conf)

Sets the configuration parameters.

Internal use only

config

public String config(String key)

Retrieve a configuration parameter. Anything can be stored in the configuration but everything will be string. The easyest way to get complex data is therefore to deal with JSON.

Parameters:

key - The configuration key name or null to retreive all configuration parameters

Returns:

The value matching the provided key in string format, or an associative array of all key-value pairs if no key is provided, or null if no configuration matches the provided key

Internal use only

used to set the original config by passing the config array as argument

config

public Any config()

Retrieve a configuration parameter. Anything can be stored in the configuration but everything will be string. The easyest way to get complex data is therefore to deal with JSON.

Returns:

A map of all configuration parameters

Internal use only

used to set the original config by passing the config array as argument

locale

public String locale()

Retrieve the preferred user language.

Returns:

The 2 letter language code

id

public String id()

Retreive the unique ID of this app instance. The id will always be the same for a given app instance and will always be different between instances of the same app.

Returns:

The unique ID

name

public String name()

Retreive the user-given name of this app instance. This may be useful to display information such that the user recognizes his instance.

Returns:

The app name