com.azalient.api.a.model
Interface IPlugins

All Superinterfaces:

IModule, IPage

public interface IPlugins
extends IModule, IPage

This is a handle to the page of data associated with the Plugins component.

The plugins component allows you to store any number of tables containing name/value pairs. If required, you could store multiple data items in each value by packing them into a String and using a separator character between items.

Field Summary

Fields inherited from interface com.azalient.api.a.tables.IModule

NONE

Fields inherited from interface com.azalient.api.a.tables.IPage

ZERO

Method Summary

Object	getProperty(String tableName, String property) Get the data value of the given property in the given table.
Object	getProperty(String tableName, String propertyName, Object defaultValue) Get the data value of the given property in the given table.
boolean	getPropertyB(String tableName, String propertyName) Get the data value of the given property in the given table as a boolean
boolean	getPropertyB(String tableName, String propertyName, boolean b) Get the data value of the given property in the given table as a boolean, or if the property is not found, return the given value as a convenience
double	getPropertyD(String tableName, String propertyName) Get the data value of the given property in the given table as a double
double	getPropertyD(String tableName, String propertyName, double d) Get the data value of the given property in the given table as a double, or if the property is not found, return the given value as a convenience
int	getPropertyI(String tableName, String propertyName) Get the data value of the given property in the given table as an integer.
int	getPropertyI(String tableName, String propertyName, int v) Get the data value of the given property in the given table as an integer, or if the property is not found, return the given value as a convenience
String[]	getPropertyNames(String tableName) An array of the names of all properties in the given table
String	getPropertyS(String tableName, String propertyName) Get the data value of the given property in the given table as a String
String	getPropertyS(String tableName, String propertyName, String s) Get the data value of the given property in the given table as a String, or if the property is not found, return the given value as a convenience
UTime	getPropertyT(String tableName, String propertyName) Get the data value of the given property in the given table as a UTime
UTime	getPropertyT(String tableName, String propertyName, UTime t) Get the data value of the given property in the given table as a UTime Object, or if the property is not found, return the given value as a convenience
void	setProperty(String tableName, String propertyName, Object value) Store a property (a name/value pair) in a table of the given name

Methods inherited from interface com.azalient.api.a.tables.IModule

addTable, baseName, childModules, destroy, open, open, pageName, pageType, parentModule, rename, save, save, table, verify

Methods inherited from interface com.azalient.api.a.tables.IPage

baseName, pageName, pageType

Method Detail

setProperty

void setProperty(String tableName,
                 String propertyName,
                 Object value)

Store a property (a name/value pair) in a table of the given name

Parameters:

tableName - The name of the table - to make it unique, a recommended convention is to prefix the Plugin class name

propertyName - The name of the property

value - The value of the property, which can have one of the following types:

• String
• Double
• Integer
• Boolean
• UTime

getPropertyNames

String[] getPropertyNames(String tableName)

An array of the names of all properties in the given table

getProperty

Object getProperty(String tableName,
                   String property)

Get the data value of the given property in the given table. The value returned is an object, with one of the following types:

• String
• Double
• Integer
• Boolean
• UTime

getProperty

Object getProperty(String tableName,
                   String propertyName,
                   Object defaultValue)

Get the data value of the given property in the given table. The value returned is an object, with one of the following types:

• String
• Double
• Integer
• Boolean
• UTime

If the value is not found, rather than returning null, the given default value is returned. This is a convenience method to avoid having to check for nulls

getPropertyI

int getPropertyI(String tableName,
                 String propertyName)

Get the data value of the given property in the given table as an integer.

getPropertyI

int getPropertyI(String tableName,
                 String propertyName,
                 int v)

Get the data value of the given property in the given table as an integer, or if the property is not found, return the given value as a convenience

getPropertyD

double getPropertyD(String tableName,
                    String propertyName)

Get the data value of the given property in the given table as a double

getPropertyD

double getPropertyD(String tableName,
                    String propertyName,
                    double d)

Get the data value of the given property in the given table as a double, or if the property is not found, return the given value as a convenience

getPropertyB

boolean getPropertyB(String tableName,
                     String propertyName)

Get the data value of the given property in the given table as a boolean

getPropertyB

boolean getPropertyB(String tableName,
                     String propertyName,
                     boolean b)

Get the data value of the given property in the given table as a boolean, or if the property is not found, return the given value as a convenience

getPropertyS

String getPropertyS(String tableName,
                    String propertyName)

Get the data value of the given property in the given table as a String

getPropertyS

String getPropertyS(String tableName,
                    String propertyName,
                    String s)

Get the data value of the given property in the given table as a String, or if the property is not found, return the given value as a convenience

getPropertyT

UTime getPropertyT(String tableName,
                   String propertyName)

Get the data value of the given property in the given table as a UTime

See Also:

UTime

getPropertyT

UTime getPropertyT(String tableName,
                   String propertyName,
                   UTime t)

Get the data value of the given property in the given table as a UTime Object, or if the property is not found, return the given value as a convenience