Package org.javarosa.core.services.properties

Class JavaRosaPropertyRules

java.lang.Object

org.javarosa.core.services.properties.JavaRosaPropertyRules

All Implemented Interfaces:

IPropertyRules

public class JavaRosaPropertyRules
extends Object
implements IPropertyRules

A set of rules governing the allowable properties for JavaRosa's core funtionality.

Author:

ctsims

Field Summary

Fields

Modifier and Type	Field	Description
static String	CURRENT_LOCALE
static String	DEVICE_ID_PROPERTY
static String	LOGS_ENABLED
static String	LOGS_ENABLED_NO
static String	LOGS_ENABLED_YES
static String	OPENROSA_API_LEVEL	The expected compliance version for the OpenRosa API set

Constructor Summary

Constructors

Constructor	Description
JavaRosaPropertyRules()	Creates the JavaRosa set of property rules

Method Summary

Modifier and Type	Method	Description
ArrayList<String>	allowableProperties()	(non-Javadoc)
ArrayList<String>	allowableValues(String propertyName)	(non-Javadoc)
boolean	checkPropertyAllowed(String propertyName)	(non-Javadoc)
boolean	checkPropertyUserReadOnly(String propertyName)	(non-Javadoc)
boolean	checkValueAllowed(String propertyName, String potentialValue)	(non-Javadoc)
String	getHumanReadableDescription(String propertyName)	Returns a human readable string representing the description of a property.
String	getHumanReadableValue(String propertyName, String value)	Returns a human readable string representing the value of a specific property.
void	handlePropertyChanges(String propertyName)	Handles any state changes that would be required upon a specific value being changed.

Methods inherited from class java.lang.Object

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

Field Details

DEVICE_ID_PROPERTY

public static final String DEVICE_ID_PROPERTY

See Also:

Constant Field Values

CURRENT_LOCALE

public static final String CURRENT_LOCALE

See Also:

Constant Field Values

LOGS_ENABLED

public static final String LOGS_ENABLED

See Also:

Constant Field Values

LOGS_ENABLED_YES

public static final String LOGS_ENABLED_YES

See Also:

Constant Field Values

LOGS_ENABLED_NO

public static final String LOGS_ENABLED_NO

See Also:

Constant Field Values

OPENROSA_API_LEVEL

public static final String OPENROSA_API_LEVEL

The expected compliance version for the OpenRosa API set

See Also:

Constant Field Values

Constructor Details

JavaRosaPropertyRules

public JavaRosaPropertyRules()

Creates the JavaRosa set of property rules

Method Details

allowableValues

public ArrayList<String> allowableValues(String propertyName)

(non-Javadoc)

Specified by:

allowableValues in interface IPropertyRules

Parameters:

propertyName - The name of the property that is being identified

Returns:

A List containing all of the values that this property may be set to

See Also:

IPropertyRules.allowableValues(String)

checkValueAllowed

public boolean checkValueAllowed(String propertyName, String potentialValue)

(non-Javadoc)

Specified by:

checkValueAllowed in interface IPropertyRules

Parameters:

propertyName - The name of the property that is being identified

potentialValue - The value that is being tested

Returns:

True if the property specified may be set to potentialValue, False otherwise

See Also:

IPropertyRules.checkValueAllowed(String, String)

allowableProperties

public ArrayList<String> allowableProperties()

(non-Javadoc)

Specified by:

allowableProperties in interface IPropertyRules

Returns:

A List containing all of the properties that may be set

See Also:

IPropertyRules.allowableProperties()

checkPropertyAllowed

public boolean checkPropertyAllowed(String propertyName)

(non-Javadoc)

Specified by:

checkPropertyAllowed in interface IPropertyRules

Parameters:

propertyName - The name of the property that is being tested

Returns:

True if the property specified may used. False otherwise

checkPropertyUserReadOnly

public boolean checkPropertyUserReadOnly(String propertyName)

(non-Javadoc)

Specified by:

checkPropertyUserReadOnly in interface IPropertyRules

Parameters:

propertyName - The name of the property that is being tested

Returns:

True if the property specified may not be modified by the user. false otherwise

getHumanReadableDescription

public String getHumanReadableDescription(String propertyName)

Description copied from interface: IPropertyRules

Returns a human readable string representing the description of a property.

Specified by:

getHumanReadableDescription in interface IPropertyRules

Parameters:

propertyName - The name of the property to be described

Returns:

A string that describes the meaning of the property name

getHumanReadableValue

public String getHumanReadableValue(String propertyName, String value)

Description copied from interface: IPropertyRules

Returns a human readable string representing the value of a specific property. This allows multiple choice answers to be stored in a concise format, while offering a standardized way to present those options to a user.

Specified by:

getHumanReadableValue in interface IPropertyRules

Parameters:

propertyName - The name of the property whose value is to be interpreted.

value - The value to be interpreted as a String

Returns:

A string representing the passed in value that can be parsed by a user to determine what its significance is.

handlePropertyChanges

public void handlePropertyChanges(String propertyName)

Description copied from interface: IPropertyRules

Handles any state changes that would be required upon a specific value being changed.

Specified by:

handlePropertyChanges in interface IPropertyRules

Parameters:

propertyName - The name of the property that has changed