Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV LETTER
NEXT LETTER
FRAMES
NO FRAMES
All Classes
A
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
G
generateViewXml(EventHandlerContext, String, Element)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
The specified view handles action, creates XmlForXsl.
get(String)
- Method in interface com.archibus.datasource.
ObjectDataSource
Returns the persistent object with the given id, or null if there is no such object.
get(String)
- Method in class com.archibus.datasource.
ObjectDataSourceImpl
Returns the persistent object with the given id, or null if there is no such object.
getActivityParameterBoolean(EventHandlerContext, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Retrieves a boolean value from the afm_activity_params table.
getActivityParameterBoolean(EventHandlerContext, String, String, boolean)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Retrieves a boolean value from the afm_activity_params table.
getActivityParameterDouble(EventHandlerContext, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Retrieves a double value from the afm_activity_params table.
getActivityParameterDouble(EventHandlerContext, String, String, double)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Retrieves a double value from the afm_activity_params table.
getActivityParameterInt(EventHandlerContext, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Retrieves an integer value from the afm_activity_params table.
getActivityParameterInt(EventHandlerContext, String, String, int)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Retrieves an integer value from the afm_activity_params table.
getActivityParameterString(EventHandlerContext, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Retrieves a string value from the afm_activity_params table.
getAllFieldNames(EventHandlerContext, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Find a table's field names
getAllFields()
- Method in interface com.archibus.datasource.
DataSource
Returns a list of field definitions for visible and/or virtual fields.
getAllFields()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns a list of field definitions for visible and/or virtual fields.
getAllRecords()
- Method in interface com.archibus.datasource.
DataSource
Retrieves records that contains values for all fields defined in the data source, using no record limit.
getAllRecords()
- Method in class com.archibus.datasource.
DataSourceImpl
Retrieves records that contains values for all fields defined in the data source, using no record limit.
getBoolean(String)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
Returns parameter value converted to boolean type.
getBoolean(String, boolean)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
getCalculatedFieldDef(String, String)
- Method in interface com.archibus.datasource.
DataSource
Returns specified virtual field definition.
getCalculatedFieldDef(String, String)
- Method in class com.archibus.datasource.
DataSourceImpl
Return the virtual field definition.
getCode()
- Method in class com.archibus.jobmanager.
JobStatus
getContext()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns parent context.
getCurrentNumber()
- Method in class com.archibus.jobmanager.
JobStatus
getDatabaseRole()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns database role.
getDataRecordValues(DataRecord)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
Set specified DataRecordDTO values from "fieldValues" and "oldFieldValues" input parameters.
getDataSet()
- Method in class com.archibus.jobmanager.
JobStatus
getDate(String)
- Method in class com.archibus.datasource.data.
DataRecord
Returns date value of specified field.
getDate(String, String, String, Restrictions.Restriction)
- Static method in class com.archibus.datasource.
DataStatistics
Returns aggregated date value.
getDate(String, String, String, Restrictions.Restriction.Clause)
- Static method in class com.archibus.datasource.
DataStatistics
getDate(String, String, String)
- Static method in class com.archibus.datasource.
DataStatistics
getDateValue(EventHandlerContext, Object)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Converts the database-dependent date value into Date object.
getDbConnection(EventHandlerContext)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Returns database connection associated with this event handler.
getDbFieldsForNewRecord()
- Method in interface com.archibus.datasource.
DataSource
Returns a list of DB field definitions for default new record.
getDbFieldsForNewRecord()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns a list of DB field definitions for default new record.
getDbFieldsForPrimaryKeys()
- Method in class com.archibus.datasource.
DataSourceImpl
getDbFieldsForPrimaryKeysAsMap()
- Method in interface com.archibus.datasource.
DataSource
Returns a map of DB field definitions for key fields.
getDbFieldsForPrimaryKeysAsMap()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns a map of DB field definitions for key fields.
getDbFieldsForSubtotals(String)
- Method in class com.archibus.datasource.
DataSourceGroupingImpl
getDbFieldsForTotals()
- Method in class com.archibus.datasource.
DataSourceGroupingImpl
getDbFieldsForVisibleFields()
- Method in interface com.archibus.datasource.
DataSource
Returns a list of DB field definitions for all fields defined in the data source.
getDbFieldsForVisibleFields()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns a list of DB field definitions for all fields defined in the data source.
getDbValue()
- Method in class com.archibus.datasource.data.
DataValue
Formats and returns this object value for SQL.
getDefaultRecord(String)
- Method in interface com.archibus.datasource.
DataSource
Returns DataRecord with default values for all fields defined in the data source.
getDefaultRecord(String)
- Method in class com.archibus.datasource.
DataSourceImpl
Returns default values for all fields defined in the data source.
getDetails()
- Method in class com.archibus.jobmanager.
JobStatus
getDouble(String)
- Method in class com.archibus.datasource.data.
DataRecord
Returns double value of specified field.
getDouble(String, String, String, Restrictions.Restriction)
- Static method in class com.archibus.datasource.
DataStatistics
Returns aggregated numeric value.
getDouble(String, String, String, Restrictions.Restriction.Clause)
- Static method in class com.archibus.datasource.
DataStatistics
getDouble(String, String, String)
- Static method in class com.archibus.datasource.
DataStatistics
getDouble(String)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
Returns parameter value converted to double type.
getDouble(String, double)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
getElapsedTime()
- Method in class com.archibus.jobmanager.
JobStatus
Returns the job elapsed time.
getEmailAddress(EventHandlerContext, String, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Gets email address from specified table.
getEmailAddress(EventHandlerContext, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Returns email address from em table for specified em_id.
getEmailFrom(EventHandlerContext)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Returns administrator email address from WebCentral preferences.
getEmailHost(EventHandlerContext)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Returns mail server host string from WebCentral preferences.
getEmailPassword(EventHandlerContext)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Returns email server SMTP password from WebCentral preferences.
getEmailPort(EventHandlerContext)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Returns mail server port string from WebCentral preferences.
getEmailUserId(EventHandlerContext)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Returns email server SMTP userId from WebCentral preferences.
getEnumFieldDisplayedValue(EventHandlerContext, String, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Find an Enum field's corresponding localized displayed value given one of its stored values \ (e.g.
getEnumFieldStoredValues(EventHandlerContext, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Find an Enum field's stored values
getFieldAfmType(EventHandlerContext, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Find a field's afm type (e.g.
getFieldDef()
- Method in class com.archibus.datasource.data.
DataValue
Returns field definition.
getFieldMultiLineHeadings(EventHandlerContext, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Find a field's multiLine headings
getFieldMultiLineHeadingsAsString(EventHandlerContext, String, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Find a field's multiLine headings and concatenated by provided characters into a single string (e.g.
getFieldNames()
- Method in interface com.archibus.datasource.
DataSource
getFieldNames()
- Method in class com.archibus.datasource.
DataSourceImpl
getFields()
- Method in class com.archibus.datasource.data.
DataRecord
Returns list of fields.
getFieldSingleLineHeading(EventHandlerContext, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Find a field's single line heading
getFieldSqlType(EventHandlerContext, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Find a field's sql type ((e.g.
getFieldValues()
- Method in class com.archibus.datasource.data.
DataRecord
Returns map of field object values.
getForeignFieldNames(EventHandlerContext, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Deprecated.
getId()
- Method in interface com.archibus.datasource.
DataSource
getId()
- Method in class com.archibus.datasource.
DataSourceImpl
getInputs()
- Method in interface com.archibus.jobmanager.
EventHandlerContext
Returns immutable Map of input parameters.
getInt(String)
- Method in class com.archibus.datasource.data.
DataRecord
Returns integer value of specified field.
getInt(String, String, String, Restrictions.Restriction)
- Static method in class com.archibus.datasource.
DataStatistics
Returns aggregated integer value.
getInt(String, String, String, Restrictions.Restriction.Clause)
- Static method in class com.archibus.datasource.
DataStatistics
getInt(String, String, String)
- Static method in class com.archibus.datasource.
DataStatistics
getInt(String)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
Returns parameter value converted to int type.
getInt(String, int)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
getIntegerValue(EventHandlerContext, Object)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Converts the database-dependent decimal value into Integer object.
getJDBCString(EventHandlerContext)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
getJobManager(EventHandlerContext)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Returns the JobManager instance.
getJobStatus(String)
- Method in interface com.archibus.jobmanager.
JobManager.Immutable
Returns specified job status.
getJobStatusesForUser(String)
- Method in interface com.archibus.jobmanager.
JobManager.Immutable
Returns a list of job statuses for specified user.
getJSONArray(String)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
Returns parameter value as JSON array.
getJSONObject(String)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
Returns parameter value as JSON object.
getJSONObject(String, JSONObject)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
getLicensesAvailable(EventHandlerContext, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Returns the number of available licenses for specified activity.
getLicensesInUse(EventHandlerContext, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Returns the number of in-use licenses for specified activity.
getLocalizedValue()
- Method in class com.archibus.datasource.data.
DataValue
Returns the value formatted as locale-specific string, suitable for display in reports.
getMainTableDef()
- Method in interface com.archibus.datasource.
DataSource
Returns main table definition.
getMainTableDef()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns main table definition.
getMainTableName()
- Method in interface com.archibus.datasource.
DataSource
Returns main table name.
getMainTableName()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns main table name.
getMessage()
- Method in class com.archibus.jobmanager.
JobStatus
getName()
- Method in class com.archibus.datasource.data.
DataValue
Returns the field name.
getNeutralValue(String)
- Method in class com.archibus.datasource.data.
DataRecord
Returns ARCHIBUS locale-neutral value of specified field.
getNeutralValue()
- Method in class com.archibus.datasource.data.
DataValue
Returns the value formatted as ARCHIBUS locale-neutral string.
getNeutralValueForChart(EventHandlerContext, String)
- Method in class com.archibus.datasource.data.
DataRecord
Returns the value formatted as ARCHIBUS locale-neutral string without data separator for numbers.
getNeutralValueForChart(EventHandlerContext)
- Method in class com.archibus.datasource.data.
DataValue
Returns the value formatted as ARCHIBUS locale-neutral string without data separator for numbers.
getOldDbValue()
- Method in class com.archibus.datasource.data.
DataValue
Formats and returns the old object value for SQL.
getOldFieldValues()
- Method in class com.archibus.datasource.data.
DataRecord
Returns map of old object values.
getOldValue()
- Method in class com.archibus.datasource.data.
DataValue
Returns the old object value.
getOldValues()
- Method in class com.archibus.datasource.data.
DataRecord
Returns map of old object values.
getParameter(String)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
Returns formatted parameter value as Java object by name.
getParameter(String, Object)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
getParameters()
- Method in interface com.archibus.datasource.
DataSource
Returns all parameters.
getParameters()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns all parameters.
getParameters(String)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
Returns a named group of parameter values.
getParentContext(EventHandlerContext)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Deprecated.
getPartialResults()
- Method in class com.archibus.jobmanager.
JobStatus
Returns the list of partial job results.
getPKeyFieldNamesForTable(String)
- Static method in class com.archibus.datasource.
DataSourceImpl
Returns a canonical list of primary key field names for a specified table.
getPrimaryKeyFieldNamesForTable(String)
- Method in interface com.archibus.datasource.
DataSource
Returns a collection of the main table's primary key field names.
getPrimaryKeyFieldNamesForTable(String)
- Method in class com.archibus.datasource.
DataSourceImpl
Returns a canonical list of primary key field names for a specified table.
getPrimaryKeyFields()
- Method in interface com.archibus.datasource.
DataSource
Returns a list of primary key fields.
getPrimaryKeyFields()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns a list of primary key fields.
getProperties()
- Method in class com.archibus.jobmanager.
JobStatus
Returns a reference to the property map.
getQueries()
- Method in interface com.archibus.datasource.
DataSource
Returns al custom queries.
getQueries()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns al custom queries.
getRecord(int)
- Method in class com.archibus.datasource.data.
DataSetList
Returns record by index.
getRecord()
- Method in interface com.archibus.datasource.
DataSource
Retrieves a single record that contains values for all fields defined in the data source.
getRecord(String)
- Method in interface com.archibus.datasource.
DataSource
Retrieves a single record that contains values for all fields defined in the data source.
getRecord()
- Method in class com.archibus.datasource.
DataSourceImpl
Retrieves a single record that contains values for all fields defined in the data source.
getRecord(String)
- Method in class com.archibus.datasource.
DataSourceImpl
Retrieves a single record that contains values for all fields defined in the data source.
getRecords()
- Method in class com.archibus.datasource.data.
DataSetList
Returns immutable record list.
getRecords()
- Method in interface com.archibus.datasource.
DataSource
Retrieves records that contains values for all fields defined in the data source.
getRecords(String)
- Method in interface com.archibus.datasource.
DataSource
Retrieves records that contains values for all fields defined in the data source.
getRecords()
- Method in class com.archibus.datasource.
DataSourceImpl
Retrieves records that contains values for all fields defined in the data source.
getRecords(String)
- Method in class com.archibus.datasource.
DataSourceImpl
Retrieves records that contains values for all fields defined in the data source.
getReferenceTableName(EventHandlerContext, String, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Deprecated.
getResponse()
- Method in interface com.archibus.jobmanager.
EventHandlerContext
Returns immutable Map of response parameters.
getRestrictions()
- Method in interface com.archibus.datasource.
DataSource
Returns a list of restriction definitions.
getRestrictions()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns a list of restriction definitions.
getRestrictionValues()
- Method in interface com.archibus.datasource.
DataSource
Returns restrictions values passed in from the client.
getRestrictionValues()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns client-side restriction values.
getResult()
- Method in class com.archibus.jobmanager.
JobStatus
getSize()
- Static method in class com.archibus.datasource.
DataSourceFactory
Returns the number of objects in the cache.
getSortFieldDef(String)
- Method in class com.archibus.datasource.data.
DataSetList
Returns sort field def by full name.
getSortFields()
- Method in interface com.archibus.datasource.
DataSource
Returns a list of sort field definitions.
getSortFields()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns a list of sort field definitions.
getStatus()
- Method in interface com.archibus.jobmanager.
Job
Returns the current job status.This method is called by the Job Manager which runs in a different thread.
getStatus()
- Method in class com.archibus.jobmanager.
JobBase
Returns the current job status.This method is called by the Job Manager which runs in a different thread.
getString(String)
- Method in class com.archibus.datasource.data.
DataRecord
Returns string value of specified field.
getString(String, String, String, Restrictions.Restriction)
- Static method in class com.archibus.datasource.
DataStatistics
Returns aggregated text value.
getString(String, String, String, Restrictions.Restriction.Clause)
- Static method in class com.archibus.datasource.
DataStatistics
getString(String, String, String)
- Static method in class com.archibus.datasource.
DataStatistics
getString(String)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
Returns parameter value cast to String type.
getString(String, String)
- Method in interface com.archibus.jobmanager.
EventHandlerContext
getSubtotals(String, String)
- Method in class com.archibus.datasource.
DataSourceGroupingImpl
Retrieve records that contains subtotals for all calculated fields and specified grouping field.
getTableFkFieldNames(EventHandlerContext, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Deprecated.
getTablePkFieldNames(EventHandlerContext, String)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Deprecated.
getTablesAndRoles()
- Method in interface com.archibus.datasource.
DataSource
Returns a list of table names and roles.
getTablesAndRoles()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns a list of table names and roles.
getTimeCompleted()
- Method in class com.archibus.jobmanager.
JobStatus
getTimeStarted()
- Method in class com.archibus.jobmanager.
JobStatus
getTimeValue(EventHandlerContext, Object)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Converts the database-dependent time value into Time object.
getTitle()
- Method in interface com.archibus.datasource.
DataSource
getTitle()
- Method in class com.archibus.datasource.
DataSourceImpl
getTotalNumber()
- Method in class com.archibus.jobmanager.
JobStatus
getTotals(String)
- Method in class com.archibus.datasource.
DataSourceGroupingImpl
Retrieve records that contains totals for all calculated fields.
getTranslatableFieldName(EventHandlerContext, String, String, Locale)
- Static method in class com.archibus.app.solution.common.eventhandler.
EventHandlerBase
Deprecated.
getValue(String)
- Method in class com.archibus.datasource.data.
DataRecord
Returns object value for specified field.
getValue()
- Method in class com.archibus.datasource.data.
DataValue
Returns the object value.
getValue()
- Method in class com.archibus.datasource.
DataSourceImpl.Parameter
getValues()
- Method in class com.archibus.datasource.data.
DataRecord
Returns map of field object values.
getViewFormatVersion()
- Method in interface com.archibus.jobmanager.
EventHandlerContext
Returns view format version (1 for 1.0 views, 2 for 2.0 views) if specified in the context.
getVirtualFieldDef(String, String)
- Method in interface com.archibus.datasource.
DataSource
Returns specified virtual field definition.
getVirtualFieldDef(String, String)
- Method in class com.archibus.datasource.
DataSourceImpl
Return the virtual field definition.
getVirtualFields()
- Method in interface com.archibus.datasource.
DataSource
Returns a list of virtual fields.
getVirtualFields()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns a list of virtual fields.
getVisibleFields()
- Method in interface com.archibus.datasource.
DataSource
Returns a list of visible fields.
getVisibleFields()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns a list of visible fields.
getVisibleFieldsByName()
- Method in interface com.archibus.datasource.
DataSource
Returns a map of visible fields.
getVisibleFieldsByName()
- Method in class com.archibus.datasource.
DataSourceImpl
Returns a map of visible fields.
gt(String, String, String)
- Static method in class com.archibus.datasource.restriction.
Restrictions
gt(String, String, Object)
- Static method in class com.archibus.datasource.restriction.
Restrictions
gte(String, String, String)
- Static method in class com.archibus.datasource.restriction.
Restrictions
gte(String, String, Object)
- Static method in class com.archibus.datasource.restriction.
Restrictions
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV LETTER
NEXT LETTER
FRAMES
NO FRAMES
All Classes
A
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
Copyright © 2009 ARCHIBUS, Inc. All Rights Reserved.