Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W 

A

addAllFields() - Method in class com.archibus.datasource.ObjectDataSourceImpl
Adds fields specified by getFieldsToProperties() method to the DataSource.
addCalculatedField(VirtualFieldDef) - Method in interface com.archibus.datasource.DataSource
Adds a calculated field to the data source.
addCalculatedField(String, String, String, String, String) - Method in class com.archibus.datasource.DataSourceGroupingImpl
Adds a calculated field.
addCalculatedField(String, String, String, int, int, String, String) - Method in class com.archibus.datasource.DataSourceGroupingImpl
Adds a calculated numeric field.
addCalculatedField(VirtualFieldDef) - Method in class com.archibus.datasource.DataSourceImpl
 
addCalculatedGroupByField(VirtualFieldDef) - Method in class com.archibus.datasource.DataSourceGroupingImpl
Adds a calculated grouping field.
addDisabledEventListenerClass(Class) - Method in class com.archibus.context.Context
 
addField(String) - Method in interface com.archibus.datasource.DataSource
Adds specified main table field to the data source query.
addField(String, String) - Method in interface com.archibus.datasource.DataSource
Adds specified field to the data source query.
addField(String, String[]) - Method in interface com.archibus.datasource.DataSource
Adds specified fields to the data source query.
addField(String[]) - Method in interface com.archibus.datasource.DataSource
Adds specified main table fields to the data source query.
addField(String) - Method in class com.archibus.datasource.DataSourceImpl
 
addField(String[]) - Method in class com.archibus.datasource.DataSourceImpl
 
addField(String, String) - Method in class com.archibus.datasource.DataSourceImpl
 
addField(String, String[]) - Method in class com.archibus.datasource.DataSourceImpl
 
addFileAttachment(String) - Method in class com.archibus.utility.MailMessage
This method adds an attachment to the email to be sent.
addGroupByField(String, String, String) - Method in class com.archibus.datasource.DataSourceGroupingImpl
Adds a simple grouping field.
addIfAbsent(String, String, DataSource) - Static method in class com.archibus.datasource.DataSourceFactory
Adds data source instance to the cache using viewName:dataSourceId as a key.
addInputParameter(String, Object) - Method in interface com.archibus.jobmanager.EventHandlerContext
Adds value to the input parameter map.
addOperation(String, String, String) - Method in class com.archibus.datasource.FieldOperation
Adds an operation to the list of operations.
addOrReplace(String, String, DataSource) - Static method in class com.archibus.datasource.DataSourceFactory
Adds data source instance to the cache using viewName:dataSourceId as a key.
addOrReplace(String, String, DataSource, boolean) - Static method in class com.archibus.datasource.DataSourceFactory
Adds data source instance to the cache using viewName:dataSourceId as a key.
addParameter(String, double, String) - Method in interface com.archibus.datasource.DataSource
 
addParameter(String, int, String) - Method in interface com.archibus.datasource.DataSource
 
addParameter(String, Object, String) - Method in interface com.archibus.datasource.DataSource
 
addParameter(String, String, String) - Method in interface com.archibus.datasource.DataSource
Adds a query parameter.
addParameter(String, String, String) - Method in class com.archibus.datasource.DataSourceImpl
 
addParameter(String, Object, String) - Method in class com.archibus.datasource.DataSourceImpl
 
addParameter(String, int, String) - Method in class com.archibus.datasource.DataSourceImpl
 
addParameter(String, double, String) - Method in class com.archibus.datasource.DataSourceImpl
 
addPartialResult(JobStatus.JobResult) - Method in class com.archibus.jobmanager.JobStatus
Add a partial job result.
addPersistentRestrictions(List) - Method in class com.archibus.datasource.DataSourceImpl
Adds view and/or VPA restrictions to the data source.
addProperty(String, String) - Method in class com.archibus.jobmanager.JobStatus
Adds a property to the map.
addQuery(String) - Method in interface com.archibus.datasource.DataSource
Adds a generic dialect SQL query to the data source.
addQuery(String, String) - Method in interface com.archibus.datasource.DataSource
Adds an SQL query to the data source.
addQuery(String) - Method in class com.archibus.datasource.DataSourceImpl
 
addQuery(String, String) - Method in class com.archibus.datasource.DataSourceImpl
 
addResponseParameter(String, Object) - Method in interface com.archibus.jobmanager.EventHandlerContext
Adds value to the response.
addRestriction(Restrictions.Restriction) - Method in interface com.archibus.datasource.DataSource
Adds a restriction.
addRestriction(Restrictions.Restriction.Clause) - Method in interface com.archibus.datasource.DataSource
Adds a restriction clause.
addRestriction(Restrictions.Restriction) - Method in class com.archibus.datasource.DataSourceImpl
 
addRestriction(Restrictions.Restriction.Clause) - Method in class com.archibus.datasource.DataSourceImpl
 
addRestrictionsToQuery() - Method in class com.archibus.datasource.DataSourceImpl
Adds all (view and VPA) restrictions to the query def.
addSort(String) - Method in interface com.archibus.datasource.DataSource
Adds a main table sort field to the data source query, in SORT_ASC mode.
addSort(String, String) - Method in interface com.archibus.datasource.DataSource
Adds a sort field to the data source query, in SORT_ASC mode.
addSort(String, String, String) - Method in interface com.archibus.datasource.DataSource
Adds a sort field to the data source query.
addSort(String) - Method in class com.archibus.datasource.DataSourceImpl
 
addSort(String, String) - Method in class com.archibus.datasource.DataSourceImpl
 
addSort(String, String, String) - Method in class com.archibus.datasource.DataSourceImpl
 
addTable(String) - Method in interface com.archibus.datasource.DataSource
Adds specified table to the data source query, as a "main" table.
addTable(String, String) - Method in interface com.archibus.datasource.DataSource
Adds specified table in specified role to the data source query.
addTable(String) - Method in class com.archibus.datasource.DataSourceImpl
 
addTable(String, String) - Method in class com.archibus.datasource.DataSourceImpl
 
addTableName(String) - Method in class com.archibus.context.Context
 
addVirtualField(String, String, String) - Method in interface com.archibus.datasource.DataSource
Adds a virtual field to the data source.
addVirtualField(String, String, String, int, int) - Method in interface com.archibus.datasource.DataSource
Adds a virtual field to the data source.
addVirtualField(String, String, String, int, int, String) - Method in interface com.archibus.datasource.DataSource
 
addVirtualField(String, String, String) - Method in class com.archibus.datasource.DataSourceImpl
 
addVirtualField(String, String, String, int, int) - Method in class com.archibus.datasource.DataSourceImpl
 
addVirtualField(String, String, String, int, int, String) - Method in class com.archibus.datasource.DataSourceImpl
 
afterCreate(Object, DataRecord) - Method in interface com.archibus.datasource.DataSourceObjectConverter.AfterCreateCallback
Called for each created object.
applyViewXsl(EventHandlerContext, String, Document, String, boolean) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. This method is for 1.0 views.
applyVpaRestrictions - Variable in class com.archibus.datasource.DataSourceImpl
The applyVpaRestrictions property enables or disables VPA restrictions for all read queries, whether the Data Source uses custom SQL or not.

B

basicRulesLog - Variable in class com.archibus.datasource.DataSourceImpl
Optional logger that is passed in the EventHandlerContext when basic rules are executed.
beanName - Variable in class com.archibus.datasource.ObjectDataSourceImpl
Spring bean name.

C

cacheToString() - Static method in class com.archibus.datasource.DataSourceFactory
Prints the cache state to string.
calculate(String, String, String) - Method in class com.archibus.datasource.FieldOperation
Calculates one operation.
calculatedFieldDefs - Variable in class com.archibus.datasource.DataSourceImpl
List of calculated field definitions.
calculatedGroupingFieldDefs - Variable in class com.archibus.datasource.DataSourceGroupingImpl
List of calculated grouping field definitions.
canCollect() - Method in class com.archibus.jobmanager.JobStatus
Returns true if the job can be removed from the list of active jobs.
canStop() - Method in class com.archibus.jobmanager.JobStatus
Returns true if the job can be stopped.
canTerminate() - Method in class com.archibus.jobmanager.JobStatus
Returns true if the job can be terminated.
CASCADE_HANDLER - Static variable in class com.archibus.datasource.DataSourceImpl
Spring bean name.
cascadeHandler - Variable in class com.archibus.datasource.DataSourceImpl
Optional: cascading update/delete handler.
checkAddInLicense(String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Checks that:
checkAutoCommit() - Method in class com.archibus.datasource.DataSourceImpl
If autoCommit is set, commit pending database changes.
checkEditPermission(String) - Static method in class com.archibus.datasource.SqlUtils
Checks if user has the permission to edit a specified table.
checkSetContext() - Method in class com.archibus.datasource.DataSourceImpl
If the parent Context has not been set, finds and sets it.
clearCache() - Static method in class com.archibus.datasource.DataSourceFactory
Clears the cache.
clearRestrictions() - Method in interface com.archibus.datasource.DataSource
Clears all restrictions defined in AXVW.
clearRestrictions() - Method in class com.archibus.datasource.DataSourceImpl
 
clone() - Method in class com.archibus.context.Context
Returns a copy of this Context instance: some fields are cloned, some are shared.
clone() - Method in class com.archibus.datasource.DataSourceImpl.Parameter
 
com.archibus.context - package com.archibus.context
 
com.archibus.datasource - package com.archibus.datasource
 
com.archibus.eventhandler - package com.archibus.eventhandler
 
com.archibus.jobmanager - package com.archibus.jobmanager
 
com.archibus.utility - package com.archibus.utility
 
com.archibus.view.tablegroup.datasource - package com.archibus.view.tablegroup.datasource
 
commit() - Method in interface com.archibus.datasource.DataSource
Commit current database transaction.
commit() - Method in class com.archibus.datasource.DataSourceImpl
 
commit() - Static method in class com.archibus.datasource.SqlUtils
Commits the current database transaction.
containsBean(String) - Method in class com.archibus.context.Context
Return true if specified bean exists in the Spring application context.
CONTENT_TYPE_TEXT_UFT8 - Static variable in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
 
Context - Class in com.archibus.context
Thread-bound context.
Context() - Constructor for class com.archibus.context.Context
 
ContextStore - Class in com.archibus.context
Stores the current user Context.
ContextStore() - Constructor for class com.archibus.context.ContextStore
 
convertObjectToRecord(T, DataRecord, Map<String, String>, boolean) - Method in class com.archibus.datasource.DataSourceObjectConverter
Sets record field values from bean properties.
convertObjectToRecord(T, T, DataRecord, Map<String, String>, boolean) - Method in class com.archibus.datasource.DataSourceObjectConverter
Sets record field values from bean properties.
convertObjectToRecord(T, DataRecord, boolean) - Method in class com.archibus.datasource.ObjectDataSourceImpl
Converts the bean instance to a data record.
convertObjectToRecord(T, T, DataRecord, boolean) - Method in class com.archibus.datasource.ObjectDataSourceImpl
Converts two bean instances (new and old) to a data record that can be saved to the database.
convertRecordsToObjects(List<DataRecord>, String, Map<String, String>, DataSourceObjectConverter.AfterCreateCallback) - Method in class com.archibus.datasource.DataSourceObjectConverter
Creates a new object from a record retrieved by the DataSource.
convertRecordsToObjects(List<DataRecord>) - Method in class com.archibus.datasource.ObjectDataSourceImpl
Converts the list of data records to the list of bean instances.
convertRecordToObject(DataRecord, String, Map<String, String>, DataSourceObjectConverter.AfterCreateCallback) - Method in class com.archibus.datasource.DataSourceObjectConverter
Creates a new object from a record retrieved by the DataSource.
convertRecordToObject(DataRecord) - Method in class com.archibus.datasource.ObjectDataSourceImpl
Converts the data record to a bean instance.
copyProperties(DataSourceImpl) - Method in class com.archibus.datasource.DataSourceImpl
Copies configuration properties into another DataSource.
createCopy() - Method in class com.archibus.datasource.DataSourceGroupingImpl
Creates and returns a copy of this data source.
createCopy() - Method in class com.archibus.datasource.DataSourceImpl
Creates a copy of this data source.
createCopy() - Method in class com.archibus.jobmanager.JobStatus
Creates a copy of the status object.
createDataSource() - Static method in class com.archibus.datasource.DataSourceFactory
Creates new empty data source instance.
createDataSource(String) - Static method in class com.archibus.datasource.DataSourceFactory
Creates new empty data source instance for specified type.
createDataSourceForFields(String, String[]) - Static method in class com.archibus.datasource.DataSourceFactory
Creates data source instance for specified table name and field names.
createDataSourceForFields(String, String[], boolean) - Static method in class com.archibus.datasource.DataSourceFactory
 
createDataSourceForFields(String[], String[]) - Static method in class com.archibus.datasource.DataSourceFactory
 
createDataSourceForFields(String[], String[], boolean) - Static method in class com.archibus.datasource.DataSourceFactory
 
createDataSourceForTable(String) - Static method in class com.archibus.datasource.DataSourceFactory
Creates a data source for all fields in a specified table.
createFieldToPropertyMapping(String[][]) - Method in class com.archibus.datasource.ObjectDataSourceImpl
Creates full field name-to-property mapping from the supplied fieldsToProperties, which contains field name to property name mapping.
createFieldToPropertyMapping() - Method in class com.archibus.datasource.ObjectDataSourceImpl
Creates field-to-property mapping.
createNewRecord() - Method in interface com.archibus.datasource.DataSource
Creates new DataRecord with default values for all fields defined in the data source.
createNewRecord() - Method in class com.archibus.datasource.DataSourceImpl
 
createPrimaryKeyIds() - Method in interface com.archibus.datasource.DataSource
Creates primary key column definitions in JSON format from the data source.
createPrimaryKeyIds() - Method in class com.archibus.datasource.DataSourceImpl
Creates primary key column definitions in JSON format from the data source.
createRecord() - Method in interface com.archibus.datasource.DataSource
Creates new DataRecord with default values for all fields defined in the data source.
createRecord() - Method in class com.archibus.datasource.DataSourceGroupingImpl
 
createRecord() - Method in class com.archibus.datasource.DataSourceImpl
 
createRecordFromContext() - Method in interface com.archibus.datasource.DataSource
Creates new DataRecord with default values for all fields defined in the data source.
createRecordFromContext() - Method in class com.archibus.datasource.DataSourceImpl
 
createRecordFromJSON(JSONObject) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
createRecordsFromJSON(JSONArray) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
createSqlForLastAddedPK(Map) - Method in class com.archibus.datasource.DataSourceImpl
Generates SQL query that can be used to retrieve the primary key of the last saved record.
createVirtualField(String, boolean) - Method in class com.archibus.datasource.DataSourceImpl
Creates virtual field definition.
createVirtualField(EventHandlerContext, String, String, boolean) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Create virtual field, mapped to javaClass type.
createVirtualViewField(String, String, String, NumberFormat) - Method in interface com.archibus.datasource.DataSource
Creates and returns virtual view field for specified Java field type.
createVirtualViewField(String, String, String, NumberFormat) - Method in class com.archibus.datasource.DataSourceImpl
 
customSqlQueries - Variable in class com.archibus.datasource.DataSourceImpl
Map contains custom SQL queries for database dialects.

D

DATA_TYPE_BOOLEAN - Static variable in interface com.archibus.datasource.DataSource
Constant for unformatted (verbatim) parameter type.
DATA_TYPE_CURRENCY - Static variable in interface com.archibus.datasource.DataSource
Constant for currency type.
DATA_TYPE_DATE - Static variable in interface com.archibus.datasource.DataSource
Constant for date field/parameter type.
DATA_TYPE_DOUBLE - Static variable in interface com.archibus.datasource.DataSource
Constant for numeric field/parameter type.
DATA_TYPE_INTEGER - Static variable in interface com.archibus.datasource.DataSource
Constant for integer field/parameter type.
DATA_TYPE_MEMO - Static variable in interface com.archibus.datasource.DataSource
Constant for memo field/parameter type.
DATA_TYPE_NUMBER - Static variable in interface com.archibus.datasource.DataSource
Constant for numeric field/parameter type.
DATA_TYPE_TEXT - Static variable in interface com.archibus.datasource.DataSource
Constant for text field/parameter type.
DATA_TYPE_TIME - Static variable in interface com.archibus.datasource.DataSource
Constant for time field/parameter type.
DATA_TYPE_VERBATIM - Static variable in interface com.archibus.datasource.DataSource
Constant for unformatted (verbatim) parameter type.
database - Variable in class com.archibus.datasource.DataSourceImpl
Database instance
databaseRole - Variable in class com.archibus.datasource.DataSourceImpl
Database role.
DataSource - Interface in com.archibus.datasource
The DataSource is a programming interface to Web Central data access layer.
DataSource - Interface in com.archibus.view.tablegroup.datasource
Description of the Interface
DataSource.Immutable - Interface in com.archibus.view.tablegroup.datasource
 
DataSource.RecordHandler - Interface in com.archibus.datasource
Callback interface that can be passed as a parameter to getRecords() and getAllRecords().
dataSourceDef - Variable in class com.archibus.datasource.DataSourceImpl
If the data source has been loaded from the view file, this property refers to the data source definition.
DataSourceFactory - Class in com.archibus.datasource
Factory class for data source objects.
DataSourceFactory() - Constructor for class com.archibus.datasource.DataSourceFactory
 
DataSourceGroupingImpl - Class in com.archibus.datasource
DataSource implementation that supports groupBy fields.
DataSourceGroupingImpl() - Constructor for class com.archibus.datasource.DataSourceGroupingImpl
 
DataSourceImpl - Class in com.archibus.datasource
The DataSource is a programming interface to Web Central data access layer.
DataSourceImpl() - Constructor for class com.archibus.datasource.DataSourceImpl
Constructor.
DataSourceImpl(DataSourceImpl) - Constructor for class com.archibus.datasource.DataSourceImpl
Copy constructor.
DataSourceImpl.Parameter - Class in com.archibus.datasource
Defines an SQL query parameter.
DataSourceImpl.SortField - Class in com.archibus.datasource
Represents a sort field.
DataSourceImpl.TableAndRole - Class in com.archibus.datasource
Represents database table and its role in the data source.
DataSourceObjectConverter<T> - Class in com.archibus.datasource
Helper class that converts DataRecords to strongly-typed Java objects.
DataSourceObjectConverter() - Constructor for class com.archibus.datasource.DataSourceObjectConverter
 
DataSourceObjectConverter.AfterCreateCallback - Interface in com.archibus.datasource
This callback interface can be implemented by application classes that wish to be notified when a new object instance is created from a data record.
DataStatistics - Class in com.archibus.datasource
Provides static methods that return aggregated ("statistics") field values, for example:
DataStatistics() - Constructor for class com.archibus.datasource.DataStatistics
 
dataType - Variable in class com.archibus.datasource.DataSourceImpl.Parameter
Parameter data type, e.g.
DB_ROLE_DATA - Static variable in interface com.archibus.datasource.DataSource
Constant for "data" database role.
DB_ROLE_SCHEMA - Static variable in interface com.archibus.datasource.DataSource
Constant for "schema" database role.
DB_ROLE_SECURITY - Static variable in interface com.archibus.datasource.DataSource
Constant for "security" database role.
DbField(String, String, EventHandlerContext) - Constructor for class com.archibus.eventhandler.EventHandlerBase.DbField
Deprecated.
Constructor that takes the Java class name.
DbField(String, ViewField.Immutable) - Constructor for class com.archibus.eventhandler.EventHandlerBase.DbField
Deprecated.
Constructor that takes the field definition.
delete(T) - Method in class com.archibus.datasource.ObjectDataSourceImpl
deleteRecord(DataRecord) - Method in interface com.archibus.datasource.DataSource
Deletes existing record.
deleteRecord(Map) - Method in interface com.archibus.datasource.DataSource
Deletes record specified by field values.
deleteRecord(DataRecord) - Method in class com.archibus.datasource.DataSourceGroupingImpl
Override for DataSourceImpl.deleteRecord().
deleteRecord(Map) - Method in class com.archibus.datasource.DataSourceGroupingImpl
Override for DataSourceImpl.deleteRecord().
deleteRecord(DataRecord) - Method in class com.archibus.datasource.DataSourceImpl
 
deleteRecord(Map) - Method in class com.archibus.datasource.DataSourceImpl
 
determineXsltFilePath(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. This method is for 1.0 views.
doCalculate() - Method in class com.archibus.datasource.FieldOperation
Calculates all operations and formulas.
doNotWrapCustomSql - Variable in class com.archibus.datasource.DataSourceImpl
If true, custom SQL queries are not wrapped inside SELECT * FROM (customQuery) AS tableName
DOT - Static variable in class com.archibus.datasource.ObjectDataSourceImpl
Constant: "." - SQL separator between table and field names.

E

enableIdLookup(boolean) - Method in interface com.archibus.datasource.DataSource
Sets the idLookupEnabled property.
enableIdLookup(boolean) - Method in class com.archibus.datasource.DataSourceImpl
Sets the idLookupEnabled property.
evaluateExpressions(String, boolean) - Method in class com.archibus.datasource.DataSourceImpl
Evaluates #{...} expressions and returns resolved string.
evaluateSqlExpressions() - Method in class com.archibus.datasource.DataSourceGroupingImpl
Evaluates expressions in custom SQL queries.
evaluateSqlExpressions() - Method in class com.archibus.datasource.DataSourceImpl
Evaluates expressions in custom SQL queries, calculated fields, and restrictions.
EventHandler - Interface in com.archibus.jobmanager
EventHandler defines the contract between Web Central and classes that implement workflow rule functionality.
EventHandlerBase - Class in com.archibus.eventhandler
Deprecated.
Do not extend this class in workflow rule service classes or job classes.
EventHandlerBase() - Constructor for class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Parameterless constructor for subclasses.
EventHandlerBase.DbField - Class in com.archibus.eventhandler
Deprecated.
Data structure describing a single JSON field formatting parameters.
eventHandlerContext - Variable in class com.archibus.datasource.DataSourceImpl
EventHandlerContext, not null if the DataSource is used by a workflow rule.
EventHandlerContext - Interface in com.archibus.jobmanager
Describes event handler execution context.
executeDbAdd(EventHandlerContext, String, Map) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource#saveRecord() instead.
executeDbCommit(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use SqlUtils.commit() instead.
executeDbDelete(EventHandlerContext, String, Map) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource#deleteRecord() instead.
executeDbRollback(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use SqlUtils.rollback() instead.
executeDbSave(EventHandlerContext, String, Map) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource#saveRecord() instead.
executeDbSave(EventHandlerContext, String, Map, Map, boolean) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource#saveRecord() instead.
executeDbSql(EventHandlerContext, String, boolean) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use SqlUtils#executeUpdate() instead.
executeDbSql(EventHandlerContext, String, String, boolean) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use SqlUtils#executeUpdate() instead.
executeDbSqlCommands(EventHandlerContext, Vector, boolean) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use SqlUtils#executeUpdate() instead.
executeDbSqlNoParameters(EventHandlerContext, String, boolean) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use SqlUtils#executeUpdate() instead.
executeQuery(String, String[], String) - Static method in class com.archibus.datasource.SqlUtils
Executes SQL query and returns all records (no record limit).
executeTransaction(Element) - Method in interface com.archibus.view.tablegroup.datasource.DataSource.Immutable
 
executeUpdate() - Method in interface com.archibus.datasource.DataSource
Executes SQL update query, set using addQuery().
executeUpdate() - Method in class com.archibus.datasource.DataSourceImpl
 
executeUpdate(String, String) - Static method in class com.archibus.datasource.SqlUtils
Executes SQL update query without checking user's permission to edit specified table.
executeUpdate(String, String, boolean) - Static method in class com.archibus.datasource.SqlUtils
Executes SQL update query with the option to check user's permission to edit specified table.
executeUpdateRequired() - Method in interface com.archibus.datasource.DataSource
Executes SQL update query, set using addQuery().
executeUpdateRequired() - Method in class com.archibus.datasource.DataSourceImpl
 
executeUpdateRequired(String, String) - Static method in class com.archibus.datasource.SqlUtils
Executes SQL update query.
expandParameters(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use # parameters in application code. Use ${} parameters instead.
expandParameters(DbServer.Immutable, ContextCacheable.Immutable, Map, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use # parameters in application code. Use ${} parameters instead.
expireJobsForUser(String) - Method in interface com.archibus.jobmanager.JobManager.Mutable.Synchronized
Terminates all jobs for specified user.
expressionContext - Variable in class com.archibus.datasource.DataSourceImpl
Context for evaluating expressions.

F

fieldDef - Variable in class com.archibus.eventhandler.EventHandlerBase.DbField
Deprecated.
Field definition that defines precise field formatting.
fieldNames - Variable in class com.archibus.datasource.DataSourceImpl
Full names of all fields, for main and standard tables.
fieldNamesForNewRecord - Variable in class com.archibus.datasource.DataSourceImpl
List of field names that have default values for new record.
FieldOperation - Class in com.archibus.datasource
Port of the Nick's FieldFormula class, which was ported from Windows FieldFormula object.
FieldOperation() - Constructor for class com.archibus.datasource.FieldOperation
Constructor.
FieldOperation(String) - Constructor for class com.archibus.datasource.FieldOperation
Constructor for field operation with assigned table.
FieldOperation(String, String) - Constructor for class com.archibus.datasource.FieldOperation
Constructor for field operation with owner table and assigned table.
FieldOperation(String, String, String) - Constructor for class com.archibus.datasource.FieldOperation
Constructor for field operation with owner, assigned, and standard tables.
fieldToPropertyMapping - Variable in class com.archibus.datasource.ObjectDataSourceImpl
Map contains database field names as keys and Cost property names as values.
filterWithPrefix(Map, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
find(AbstractRestrictionDef) - Method in class com.archibus.datasource.ObjectDataSourceImpl
findField(String) - Method in interface com.archibus.datasource.DataSource
Returns a field definition for specified full field name.
findField(String) - Method in class com.archibus.datasource.DataSourceImpl
 
findKeyField(String) - Method in class com.archibus.datasource.DataSourceImpl
Returns a field definition for specified full field name.
findTable(String) - Method in class com.archibus.datasource.DataSourceImpl
Returns the table and role for specific table, or null if the table is not defined in the data source.
findVirtualField(String) - Method in interface com.archibus.datasource.DataSource
Loop through the virtual fields for the current data source and Returns a field definition for specified full field name.
findVirtualField(String) - Method in class com.archibus.datasource.DataSourceImpl
 
formatFieldValue(EventHandlerContext, Object, String, String, boolean) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatJoin(String) - Method in interface com.archibus.datasource.DataSource
Generates a join between the table of specified field and its validating table, if any.
formatJoin(String) - Method in class com.archibus.datasource.DataSourceImpl
Generates a join between the table of specified field and its validating table, if any.
formatMessage(EventHandlerContext, String, Object[]) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Formats text message.
formatSqlAddDays(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlAddDaysToExpression(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlAddMinutes(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlAddMinutesToExpression(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlAddOneMonth(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlConcat(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the sql.concat binding expression instead.
formatSqlConvertIntToChar(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlConvertToInt(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlConvertToString(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlDateTime(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlDaysBetween(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the sql.daysBetween binding expression instead.
formatSqlDbCrLf(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlDbTab(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlDummyTable(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlFieldValue(EventHandlerContext, Object, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the DataSource API instead.
formatSqlForPersistentRestrictions() - Method in interface com.archibus.datasource.DataSource
Generates SQL WHERE clause from VPAs for current user/role applicable to the main table in current DataSource.
formatSqlForPersistentRestrictions() - Method in class com.archibus.datasource.DataSourceImpl
 
formatSqlForPersistentRestrictionsForTable(String) - Method in interface com.archibus.datasource.DataSource
Generates SQL WHERE clause from VPAs for current user/role applicable to the specified table in current DataSource.
formatSqlForPersistentRestrictionsForTable(String) - Method in class com.archibus.datasource.DataSourceImpl
 
formatSqlForPersistentRestrictionsForTableAndRole(String, String) - Method in interface com.archibus.datasource.DataSource
Generates SQL WHERE clause from VPAs applicable to the specified table in current DataSource.
formatSqlForPersistentRestrictionsForTableAndRole(String, String) - Method in class com.archibus.datasource.DataSourceImpl
 
formatSqlForRestriction(String) - Method in interface com.archibus.datasource.DataSource
Generates SQL WHERE clause from a named restriction.
formatSqlForRestriction(String) - Method in class com.archibus.datasource.DataSourceImpl
 
formatSqlHoursBetween(EventHandlerContext, String, String, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the sql.hoursBetween binding expression instead.
formatSqlHoursBetweenFields(EventHandlerContext, String, String, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the sql.hoursBetween binding expression instead.
formatSqlIsNull(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the sql.isNull binding expression instead.
formatSqlIsoToNativeDate(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlIsoToNativeTime(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlMonthsBetween(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatSqlQuery(String, boolean) - Method in interface com.archibus.datasource.DataSource
Formats and returns an SQL query based on: previously added tables, fields, sort fields, restrictions, and custom SQL queries; current user VPA restriction; client-side restriction.
formatSqlQuery(String, List, List, boolean, boolean) - Method in interface com.archibus.datasource.DataSource
Formats and returns an SQL query based on: previously added tables, fields, sort fields, restrictions, and custom SQL queries; current user VPA restriction; client-side restriction.
formatSqlQuery(String, boolean) - Method in class com.archibus.datasource.DataSourceImpl
 
formatSqlQuery(String, List, List, boolean, boolean) - Method in class com.archibus.datasource.DataSourceImpl
 
formatSqlQuery(List<RestrictionSqlBase.Immutable>, List, List, boolean, boolean) - Method in class com.archibus.datasource.DataSourceImpl
Formats and returns an SQL query based on: view tables and fields; view restrictions; view SQL queries; current user VPA restriction; additional restrictions.
formatSqlQuery(List<RestrictionSqlBase.Immutable>, List, List, boolean, boolean, String) - Method in class com.archibus.datasource.DataSourceImpl
Formats and returns an SQL query.
formatSqlQueryForField(String, List, List, boolean, boolean, String) - Method in interface com.archibus.datasource.DataSource
Formats and returns an SQL query that selects a single specified field.
formatSqlQueryForField(String, List, List, boolean, boolean, String) - Method in class com.archibus.datasource.DataSourceImpl
 
formatSqlQueryForSubtotals(String, String) - Method in class com.archibus.datasource.DataSourceGroupingImpl
Formats SQL query for totals.
formatSqlQueryForSubtotals(List<RestrictionSqlBase.Immutable>, String) - Method in class com.archibus.datasource.DataSourceGroupingImpl
Formats SQL query for totals.
formatSqlQueryForTotals(String) - Method in class com.archibus.datasource.DataSourceGroupingImpl
Formats SQL query for totals.
formatSqlReplace0WithDefault(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the sql.replaceZero binding expression instead.
formatSqlReplace0WithHuge(String) - Static method in class com.archibus.datasource.SqlUtils
Replaces any expression that returns a 0 result with a very large number (9999999999)
formatSqlReplace0WithHuge(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the sql.replaceZero binding expression instead.
formatSqlWeeksBetween(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
formatValue(EventHandlerContext, Object) - Method in class com.archibus.eventhandler.EventHandlerBase.DbField
Deprecated.
Formats specified value for presentation layer.
formatValueForSql(Object) - Static method in class com.archibus.datasource.SqlUtils
Formats field value for SQL.
FORMULA_AVG - Static variable in class com.archibus.datasource.DataSourceGroupingImpl
 
FORMULA_COUNT - Static variable in class com.archibus.datasource.DataSourceGroupingImpl
 
FORMULA_COUNT_PERCENT - Static variable in class com.archibus.datasource.DataSourceGroupingImpl
 
FORMULA_DAY - Static variable in class com.archibus.datasource.DataSourceGroupingImpl
 
FORMULA_MAX - Static variable in class com.archibus.datasource.DataSourceGroupingImpl
 
FORMULA_MIN - Static variable in class com.archibus.datasource.DataSourceGroupingImpl
 
FORMULA_MONTH - Static variable in class com.archibus.datasource.DataSourceGroupingImpl
 
FORMULA_QUARTER - Static variable in class com.archibus.datasource.DataSourceGroupingImpl
 
FORMULA_SUM - Static variable in class com.archibus.datasource.DataSourceGroupingImpl
Supported aggregate field formulas.
FORMULA_SUM_PERCENT - Static variable in class com.archibus.datasource.DataSourceGroupingImpl
Additional aggregate formulas not supported by SQL-99.
FORMULA_WEEK - Static variable in class com.archibus.datasource.DataSourceGroupingImpl
 
FORMULA_YEAR - Static variable in class com.archibus.datasource.DataSourceGroupingImpl
Supported aggregate field formulas for temporal groupings.
fromJSONArray(JSONArray) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
fromJSONArray(String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
fromJSONObject(JSONObject) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
fromJSONObject(String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.

G

generateViewXml(EventHandlerContext, String, Element) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. This method is for 1.0 views.
get(String) - Method in class com.archibus.context.Context
 
get() - Static method in class com.archibus.context.ContextStore
Get the user context for the currently executing thread.
get(PrimaryKeysValues) - Method in interface com.archibus.datasource.ObjectDataSource
Returns the persistent object with the given PK values, or null if there is no such object.
get(Object) - Method in class com.archibus.datasource.ObjectDataSourceImpl
get(PrimaryKeysValues) - Method in class com.archibus.datasource.ObjectDataSourceImpl
Returns the persistent object with the given PK values, or null if there is no such object.
getActivityId() - Method in class com.archibus.utility.MailMessage
 
getActivityLicensesAvailable() - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
getActivityLicensesInUse() - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
getActivityParameterBoolean(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use ActivityParameterManager instead.
getActivityParameterBoolean(EventHandlerContext, String, String, boolean) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use ActivityParameterManager instead.
getActivityParameterDouble(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use ActivityParameterManager instead.
getActivityParameterDouble(EventHandlerContext, String, String, double) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use ActivityParameterManager instead.
getActivityParameterInt(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use ActivityParameterManager instead.
getActivityParameterInt(EventHandlerContext, String, String, int) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use ActivityParameterManager instead.
getActivityParameterString(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use ActivityParameterManager instead.
getAllFieldNames(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
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.
getAllGroupingFieldNames() - Method in class com.archibus.datasource.DataSourceGroupingImpl
Returns the list of full names for calculated and non-calculated grouping 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
 
getApplicationContext() - Method in class com.archibus.context.Context
 
getAttachments() - Method in class com.archibus.utility.MailMessage
 
getBaseURL() - Method in class com.archibus.context.Context
Getter for the baseURL property.
getBcc() - Method in class com.archibus.utility.MailMessage
 
getBean(String) - Method in class com.archibus.context.Context
Returns an instance, which may be shared or independent, of the specified bean.
getBeanNamesToObjects() - Method in class com.archibus.context.Context
 
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
 
getCc() - Method in class com.archibus.utility.MailMessage
 
getCode() - Method in class com.archibus.jobmanager.JobStatus
 
getConfigManager() - Method in class com.archibus.context.Context
 
getContentType() - Method in class com.archibus.utility.MailMessage
 
getContext() - Method in class com.archibus.datasource.DataSourceImpl
Returns parent context.
getContextForChainedRule(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
getContextPath() - Method in class com.archibus.context.Context
 
getCurrentContext() - Method in class com.archibus.context.Context
Gets the currentContext attribute of the Context object
getCurrentNumber() - Method in class com.archibus.jobmanager.JobStatus
 
getDatabase() - Method in class com.archibus.context.Context
 
getDatabase(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Applications do not need access to Database.Immutable.
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
 
getDataSourceDef() - Method in interface com.archibus.datasource.DataSource
 
getDataSourceDef() - Method in class com.archibus.datasource.DataSourceImpl
 
getDataSourceRead() - Method in interface com.archibus.view.tablegroup.datasource.DataSource.Immutable
 
getDataSourceUpdate() - Method in interface com.archibus.view.tablegroup.datasource.DataSource.Immutable
 
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, String) - Static method in class com.archibus.datasource.DataStatistics
 
getDate(String, String, String) - Static method in class com.archibus.datasource.DataStatistics
 
getDateSent() - Method in class com.archibus.utility.MailMessage
 
getDateValue(EventHandlerContext, Object) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the DataSource API instead.
getDateValueFromNeutral(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the DataSource API instead.
getDbConnection() - Method in class com.archibus.context.Context
 
getDbConnection(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Applications do not need access to DbConnection.ThreadSafe.
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
 
getDbFieldsForPrimaryKeys() - Method in class com.archibus.datasource.DataSourceImpl
Returns the list of fields for primary keys of the main table.
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
Returns the list of fields for the sub-totals query.
getDbFieldsForTotals() - Method in class com.archibus.datasource.DataSourceGroupingImpl
Returns the list of fields for the totals query.
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.
getDbServer(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Applications do not need access to DbServer.Immutable.
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
 
getDetails() - Method in class com.archibus.jobmanager.JobStatus
 
getDisabledEventListenerClasses() - Method in class com.archibus.context.Context
 
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, String) - 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.eventhandler.EventHandlerBase
Deprecated.
Gets email address from specified table.
getEmailAddress(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Returns email address from em table for specified em_id.
getEmailFrom(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
getEmailHost(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
getEmailPassword(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
getEmailPort(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
getEmailUserId(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
getEnumFieldDisplayedValue(EventHandlerContext, String, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
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.eventhandler.EventHandlerBase
Deprecated.
Find an Enum field's stored values
getEventHandler(String) - Method in class com.archibus.context.Context
Returns the event handler specified by name.
getEventHandlerContext() - Method in class com.archibus.context.Context
 
getException() - Method in class com.archibus.context.Context
 
getFieldAfmType(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Find a field's afm type (e.g.
getFieldMultiLineHeadings(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Find a field's multiLine headings
getFieldMultiLineHeadingsAsString(EventHandlerContext, String, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
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
 
getFieldSingleLineHeading(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Find a field's single line heading
getFieldSqlType(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Find a field's sql type ((e.g.
getFieldsToProperties() - Method in class com.archibus.datasource.ObjectDataSourceImpl
Gets field name to property name mapping.
getForeignFieldNames(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated. 
getFrom() - Method in class com.archibus.utility.MailMessage
 
getFullName() - Method in class com.archibus.datasource.DataSourceImpl.SortField
 
getGroupingFieldNames() - Method in class com.archibus.datasource.DataSourceGroupingImpl
Returns the list of full names for non-calculated grouping fields.
getHost() - Method in class com.archibus.utility.MailMessage
 
getHttpSession() - Method in class com.archibus.context.Context
 
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, 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, String) - 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.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the DataSource API instead.
getIntWithoutVpa(String, String, String, Restrictions.Restriction) - Static method in class com.archibus.datasource.DataStatistics
Returns aggregated integer value retrieved without applying per-user VPA restrictions.
getIntWithoutVpa(String, String, String, Restrictions.Restriction.Clause) - Static method in class com.archibus.datasource.DataStatistics
 
getIntWithoutVpa(String, String, String, String) - Static method in class com.archibus.datasource.DataStatistics
 
getIntWithoutVpa(String, String, String) - Static method in class com.archibus.datasource.DataStatistics
 
getJDBCString(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
getJobManager() - Method in class com.archibus.context.Context
Returns the JobManager instance.
getJobManager(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use Context.getJobManager() instead.
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.
getJobStatusMessage(EventHandlerContext, int) - Method in class com.archibus.jobmanager.JobStatus
 
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
 
getKeyFields() - Method in interface com.archibus.view.tablegroup.datasource.DataSource.Immutable
 
getLicenseManager() - Method in class com.archibus.context.Context
 
getLicensesAvailable(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Returns the number of available licenses for specified activity.
getLicensesInUse(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Returns the number of in-use licenses for specified activity.
getLocale() - Method in class com.archibus.context.Context
 
getLocale(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use Context.getLocale() instead.
getLocale() - Method in interface com.archibus.jobmanager.EventHandlerContext
Returns the locale that overrides the current user locale.
getLookupFieldDefs() - Method in class com.archibus.datasource.DataSourceGroupingImpl
Returns all lookup field definitions for this data source.
getMainTable() - Method in interface com.archibus.view.tablegroup.datasource.DataSource.Immutable
 
getMainTableDef() - Method in interface com.archibus.datasource.DataSource
Returns main table definition.
getMainTableDef() - Method in class com.archibus.datasource.DataSourceImpl
 
getMainTableName() - Method in interface com.archibus.datasource.DataSource
Returns main table name.
getMainTableName() - Method in class com.archibus.datasource.DataSourceImpl
 
getMessage() - Method in class com.archibus.jobmanager.JobStatus
 
getNextRequest() - Method in class com.archibus.context.Context
 
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
 
getParameters(EventHandlerContext, String[], String[]) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Instead, declare workflow rule inputs as Java method 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.eventhandler.EventHandlerBase
Deprecated.
Do not use. Applications do not need access to ContextCacheable.Immutable.
getParentContextAttribute(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Applications do not need access to parent context attributes.
getParentContextAttributeXPath(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Applications do not need access to parent context attributes.
getPartialResults() - Method in class com.archibus.jobmanager.JobStatus
Returns the list of partial job results.
getPassword() - Method in class com.archibus.utility.MailMessage
 
getPKeyFieldNamesForTable(String, Project.Immutable) - Static method in class com.archibus.datasource.DataSourceImpl
Returns a canonical list of primary key field names for a specified table.
getPort() - Method in class com.archibus.utility.MailMessage
 
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
 
getPrimaryKeyFields() - Method in interface com.archibus.datasource.DataSource
Returns a list of primary key fields.
getPrimaryKeyFields() - Method in class com.archibus.datasource.DataSourceImpl
 
getProject() - Method in class com.archibus.context.Context
 
getProject(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use Context.getProject() instead:
             ContextStore.get().getProject()
             
getProperties() - Method in class com.archibus.jobmanager.JobStatus
Returns a reference to the property map.
getQueries() - Method in interface com.archibus.datasource.DataSource
Returns all custom queries.
getQueries() - Method in class com.archibus.datasource.DataSourceImpl
 
getQueryInstance(Database.Immutable) - Method in class com.archibus.datasource.DataSourceGroupingImpl
Returns new query instance.
getQueryInstance(Database.Immutable) - Method in class com.archibus.datasource.DataSourceImpl
Returns new query instance.
getRealContextPath() - Method in class com.archibus.context.Context
 
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
 
getRecord(String) - Method in class com.archibus.datasource.DataSourceImpl
 
getRecords() - Method in interface com.archibus.datasource.DataSource
Retrieves records that contains values for all fields defined in the data source.
getRecords(AbstractRestrictionDef) - Method in interface com.archibus.datasource.DataSource
Retrieves records that contains values for all fields defined in the data source.
getRecords(List<RestrictionSqlBase.Immutable>) - Method in interface com.archibus.datasource.DataSource
Retrieves records that contains values for all fields defined in the data source.
getRecords(List<RestrictionSqlBase.Immutable>, int) - 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(String, int) - 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
 
getRecords(String) - Method in class com.archibus.datasource.DataSourceImpl
 
getRecords(List<RestrictionSqlBase.Immutable>) - Method in class com.archibus.datasource.DataSourceImpl
 
getRecords(String, int) - Method in class com.archibus.datasource.DataSourceImpl
 
getRecords(List<RestrictionSqlBase.Immutable>, int) - Method in class com.archibus.datasource.DataSourceImpl
 
getRecords(AbstractRestrictionDef) - Method in class com.archibus.datasource.DataSourceImpl
 
getReferenceTableName(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated. 
getRequest() - Method in class com.archibus.context.Context
 
getRequestURL() - Method in class com.archibus.context.Context
 
getResponse() - Method in class com.archibus.context.Context
 
getResponse() - Method in interface com.archibus.jobmanager.EventHandlerContext
Returns immutable Map of response parameters.
getRestrictionRelativeOperation() - Method in class com.archibus.datasource.DataSourceImpl
Returns relative operation used to combine multiple client restrictions.
getRestrictions() - Method in interface com.archibus.datasource.DataSource
Returns a list of restriction definitions.
getRestrictions() - Method in class com.archibus.datasource.DataSourceImpl
 
getRestrictionValues() - Method in interface com.archibus.datasource.DataSource
Returns restrictions values passed in from the client.
getRestrictionValues() - Method in class com.archibus.datasource.DataSourceImpl
 
getResult() - Method in class com.archibus.jobmanager.JobStatus
 
getRole() - Method in class com.archibus.context.Context
 
getRoles() - Static method in class com.archibus.context.Context
 
getSecurityController() - Method in class com.archibus.context.Context
 
getSession() - Method in class com.archibus.context.Context
 
getSize() - Static method in class com.archibus.datasource.DataSourceFactory
Returns the number of objects in the cache.
getSortFields() - Method in interface com.archibus.datasource.DataSource
Returns a list of sort field definitions.
getSortFields() - Method in class com.archibus.datasource.DataSourceImpl
 
getSourceId() - Method in class com.archibus.utility.MailMessage
Getter for the sourceId property.
getSourceName() - Method in class com.archibus.utility.MailMessage
Getter for the sourceName property.
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.
getStatus() - Method in class com.archibus.utility.MailMessage
 
getStatusMessage() - Method in class com.archibus.utility.MailMessage
 
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, String) - 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
 
getSubject() - Method in class com.archibus.utility.MailMessage
 
getSubtotals(String, String) - Method in class com.archibus.datasource.DataSourceGroupingImpl
Retrieve records that contains subtotals for all calculated fields and specified grouping field.
getSubtotals(List<RestrictionSqlBase.Immutable>, 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.eventhandler.EventHandlerBase
Deprecated. 
getTableNames() - Method in class com.archibus.context.Context
 
getTablePkFieldNames(EventHandlerContext, String) - Static method in class com.archibus.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
 
getText() - Method in class com.archibus.utility.MailMessage
 
getTimeCompleted() - Method in class com.archibus.jobmanager.JobStatus
 
getTimeSent() - Method in class com.archibus.utility.MailMessage
 
getTimeStarted() - Method in class com.archibus.jobmanager.JobStatus
 
getTimeValue(EventHandlerContext, Object) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the DataSource API instead.
getTimeValueFromNeutral(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the DataSource API instead.
getTitle() - Method in interface com.archibus.datasource.DataSource
 
getTitle() - Method in class com.archibus.datasource.DataSourceImpl
 
getTitle() - Method in class com.archibus.jobmanager.JobStatus
Returns formatted status string representation.
getTo() - Method in class com.archibus.utility.MailMessage
 
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.
getTransactionInfos() - Method in class com.archibus.context.Context
 
getTranslatableFieldName(EventHandlerContext, String, String, Locale) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated. 
getUser() - Method in class com.archibus.context.Context
 
getUser() - Method in class com.archibus.utility.MailMessage
 
getUserAccount() - Method in class com.archibus.context.Context
 
getUserAccount(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use Context.getUserAccount() instead:
             ContextStore.get().getUserAccount()
             
getUserRole(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use User.getRole() instead:
             ContextStore.get().getUser().getRole()
             
getUserSession() - Method in class com.archibus.context.Context
 
getUserSessionDto() - Method in class com.archibus.context.Context
 
getValue() - Method in class com.archibus.datasource.DataSourceImpl.Parameter
 
getVersion() - Method in class com.archibus.context.Context
Getter for the version property.
getViewFormatVersion(EventHandlerContext) - Method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Retrieves the view format version from the input parameter.
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.
getViewName() - Method in interface com.archibus.datasource.DataSource
 
getViewName() - Method in class com.archibus.datasource.DataSourceImpl
 
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
 
getVirtualFields() - Method in interface com.archibus.datasource.DataSource
Returns a list of virtual fields.
getVirtualFields() - Method in class com.archibus.datasource.DataSourceImpl
 
getVisibleFields() - Method in interface com.archibus.datasource.DataSource
Returns a list of visible fields.
getVisibleFields() - Method in class com.archibus.datasource.DataSourceImpl
 
getVisibleFieldsByName() - Method in interface com.archibus.datasource.DataSource
Returns a map of visible fields.
getVisibleFieldsByName() - Method in class com.archibus.datasource.DataSourceImpl
 
getWebAppPath() - Method in class com.archibus.context.Context
 
getWebCentralPath(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use Context.getWebAppPath() instead.
getWorkflowRulesContainer(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Applications do not need access to WorkflowRulesContainer.ThreadSafe.
groupingFieldNames - Variable in class com.archibus.datasource.DataSourceGroupingImpl
List of fully qualified names of simple (non-calculated) grouping fields.

H

handle(EventHandlerContext) - Method in interface com.archibus.jobmanager.EventHandler
Performs event handler operation.
handleRecord(DataRecord) - Method in interface com.archibus.datasource.DataSource.RecordHandler
Called by the DataSource for each retrieved record.
hasCustomQuery() - Method in interface com.archibus.datasource.DataSource
Returns true if the data source uses custom SQL qeury.
hasCustomQuery() - Method in class com.archibus.datasource.DataSourceImpl
 
hasMoreRecords() - Method in interface com.archibus.datasource.DataSource
Returns true if preceding call to retrieveRecords() did not read all records due to record limit.
hasMoreRecords - Variable in class com.archibus.datasource.DataSourceImpl
Whether preceding call to retrieveRecords() did not read all records due to record limit.
hasMoreRecords() - Method in class com.archibus.datasource.DataSourceImpl
 
hasVirtualFields() - Method in interface com.archibus.datasource.DataSource
Returns true if the data source defines virtual fields for custom SQL qeury.
hasVirtualFields() - Method in class com.archibus.datasource.DataSourceImpl
 

I

incrementCurrentNumber() - Method in class com.archibus.jobmanager.JobStatus
 
incrementTotalNumber(int) - Method in class com.archibus.jobmanager.JobStatus
 
INPUT_TRANSLATABLE - Static variable in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Input & Output parameters names used in helper methods.
isActivityLicenseEnabled(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Returns whether specified activity license is enabled.
isAscending() - Method in class com.archibus.datasource.DataSourceImpl.SortField
 
isAutoCommit - Variable in class com.archibus.datasource.DataSourceImpl
If autoCommit is set, the DataSource commits changes after each data access call.
isDebug() - Method in class com.archibus.context.Context
 
isDescending() - Method in class com.archibus.datasource.DataSourceImpl.SortField
 
isDistinct() - Method in interface com.archibus.datasource.DataSource
Gets the distinct attribute
isDistinct - Variable in class com.archibus.datasource.DataSourceImpl
True if generated SQL query should include SELECT DISTINCT.
isDistinct() - Method in class com.archibus.datasource.DataSourceImpl
 
isIdLookupEnabled() - Method in interface com.archibus.datasource.DataSource
Whether this data source can use lookup fields.
isIdLookupEnabled() - Method in class com.archibus.datasource.DataSourceImpl
 
isIdLookupEnabled() - Method in class com.archibus.datasource.ObjectDataSourceImpl
Whether this data source can use lookup fields.
isOracle() - Method in interface com.archibus.datasource.DataSource
Returns true if the current database server is Oracle.
isOracle() - Method in class com.archibus.datasource.DataSourceImpl
 
isOracle() - Static method in class com.archibus.datasource.SqlUtils
Returns true if the current database is Oracle.
isOracle(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use SqlUtils.isOracle() instead.
isSqlServer() - Method in interface com.archibus.datasource.DataSource
Returns true if the current database server is SQL Server.
isSqlServer() - Method in class com.archibus.datasource.DataSourceImpl
 
isSqlServer() - Static method in class com.archibus.datasource.SqlUtils
Returns true if the current database is SQL Server.
isSqlServer(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use SqlUtils.isSqlServer() instead.
isStopRequested() - Method in class com.archibus.jobmanager.JobStatus
Returns true if the job should stop.
isSybase() - Method in interface com.archibus.datasource.DataSource
Returns true if the current database server is Sybase.
isSybase() - Method in class com.archibus.datasource.DataSourceImpl
 
isSybase() - Static method in class com.archibus.datasource.SqlUtils
Returns true if the current database is Sybase.
isSybase(EventHandlerContext) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use SqlUtils.isSybase() instead.

J

Job - Interface in com.archibus.jobmanager
Base interface implemented by long-running jobs.
JOB_COMPLETE - Static variable in class com.archibus.jobmanager.JobStatus
The job has been completed successfully.
JOB_CREATED - Static variable in class com.archibus.jobmanager.JobStatus
The job has been created but not yet started.
JOB_FAILED - Static variable in class com.archibus.jobmanager.JobStatus
The job has failed with exception.
JOB_NOT_FOUND - Static variable in class com.archibus.jobmanager.JobStatus
The job is not found on the server; typically means that the job has never been started.
JOB_STARTED - Static variable in class com.archibus.jobmanager.JobStatus
The job has been started.
JOB_STOP_ACKNOWLEDGED - Static variable in class com.archibus.jobmanager.JobStatus
The job has been requested to stop, has acknowledged the request, but did not stop yet.
JOB_STOP_REQUESTED - Static variable in class com.archibus.jobmanager.JobStatus
The job has been requested to stop, but did not respond yet.
JOB_STOPPED - Static variable in class com.archibus.jobmanager.JobStatus
The job has been stopped.
JOB_TERMINATED - Static variable in class com.archibus.jobmanager.JobStatus
The job thread has been terminated.
JobBase - Class in com.archibus.jobmanager
Abstract base class for Job implementations.
JobBase() - Constructor for class com.archibus.jobmanager.JobBase
 
JobManager - Interface in com.archibus.jobmanager
Manages running job instances for all users.
JobManager.Immutable - Interface in com.archibus.jobmanager
Methods that do not change the JobManager state.
JobManager.Mutable - Interface in com.archibus.jobmanager
Methods that do change the JobManager state.
JobManager.Mutable.Synchronized - Interface in com.archibus.jobmanager
Methods that change the JobManager state in a thread-safe manner (with internal synchronization).
JobManager.ThreadSafe - Interface in com.archibus.jobmanager
Methods that are safe to call from any thread without additional synchronization.
JobResult(String, String, String) - Constructor for class com.archibus.jobmanager.JobStatus.JobResult
Constructor.
JobResult(String) - Constructor for class com.archibus.jobmanager.JobStatus.JobResult
Constructor for results that do not have output files.
JobStatus - Class in com.archibus.jobmanager
Default job status implementation.
JobStatus() - Constructor for class com.archibus.jobmanager.JobStatus
Constructor.
JobStatus.JobResult - Class in com.archibus.jobmanager
Describes a file or document that is a result of the job execution.

K

KEY_SEPARATOR - Static variable in class com.archibus.datasource.DataSourceFactory
Key separator.
keyFieldsByFullName - Variable in class com.archibus.datasource.DataSourceImpl
Map that contains PK and FK fields keyed by their full names.

L

literal(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use SqlUtils#makeLiteralOrBlank() instead.
loadDataSourceDef(String, String) - Static method in class com.archibus.datasource.DataSourceFactory
Loads a data source definition from a view file.
loadDataSourceFromCache(Object, String, int, String) - Static method in class com.archibus.datasource.DataSourceFactory
Creates data source instance for specified view, group index, and optional data source ID.
loadDataSourceFromFile(String, String) - Static method in class com.archibus.datasource.DataSourceFactory
Creates data source instance for specified view name and data source ID.
loadView(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. This method is for 1.0 views.
loadViewXml(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Loads or retrieves from cache the view object specified by name.
locale - Variable in class com.archibus.datasource.DataSourceImpl
Current user locale
localizeMessage(EventHandlerContext, String, String, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Localizes specified message from the messages database table, using either the current user locale or specified locale.
localizeString(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Localizes text message.
localizeString(EventHandlerContext, String) - Method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Localizes text message.
localizeString(String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Localizes text message.
localizeString(ContextCacheable.Immutable, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Localizes text message.
localizeString(EventHandlerContext, String, String, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Localizes text message.
localizeString(EventHandlerContext, Locale, String, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Localizes text message.
log - Variable in class com.archibus.datasource.DataSourceImpl
Logger for this class and subclasses.
log - Variable in class com.archibus.datasource.DataSourceObjectConverter
Logger for this class and subclasses.
log - Variable in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Logger instance that can be used by subclasses.
logger - Variable in class com.archibus.context.Context
Logger for this class and subclasses

M

MailMessage - Class in com.archibus.utility
Encapsulates the e-mail message parameters.
MailMessage() - Constructor for class com.archibus.utility.MailMessage
Constructor
MailSender - Class in com.archibus.utility
MailSender hides the details of sending email through an SMTP server using the JavaMail API and the Java Activation framework (JAF).
MailSender() - Constructor for class com.archibus.utility.MailSender
Constructor
mainTableDef - Variable in class com.archibus.datasource.DataSourceImpl
Main table definition.
mainTableName - Variable in class com.archibus.datasource.DataSourceImpl
Name of the main table
makeLiteralOrBlank(String) - Static method in class com.archibus.datasource.SqlUtils
Returns literalized version of specified string, or an empty string if specified string is null.
maxRecords - Variable in class com.archibus.datasource.DataSourceImpl
How many records can be retrieved via retrieveRecords().

N

name - Variable in class com.archibus.datasource.DataSourceImpl.Parameter
Parameter name.
name - Variable in class com.archibus.datasource.DataSourceImpl.SortField
The name.
name - Variable in class com.archibus.datasource.DataSourceImpl.TableAndRole
The table name.
name - Variable in class com.archibus.eventhandler.EventHandlerBase.DbField
Deprecated.
Name that the field should have as a the JSON object property.
name - Variable in class com.archibus.jobmanager.JobStatus.JobResult
Example: "Rooms by Department and Floor 2009-12-20-1000.docx"
normalizeValueForSql(Object) - Static method in class com.archibus.datasource.SqlUtils
Converts value to type that is accepted by the SQL layer: java.util.Date --> java.sql.Date
normalizeValuesForSql(Map<String, Object>) - Static method in class com.archibus.datasource.SqlUtils
Converts values to types that are accepted by the SQL layer.
notNull(Object) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use StringUtil#notNull() instead.

O

ObjectDataSource<T> - Interface in com.archibus.datasource
ObjectDataSource is an extension of the DataSource interface.
ObjectDataSourceImpl<T> - Class in com.archibus.datasource
Base class for implementations of the ObjectDataSource interface.
ObjectDataSourceImpl(String, String) - Constructor for class com.archibus.datasource.ObjectDataSourceImpl
Constructor, called from concrete subclasses.
onUserSessionChange(UserSession.Immutable) - Method in class com.archibus.context.Context
Description of the Method
order - Variable in class com.archibus.datasource.DataSourceImpl.SortField
The order: "asc" or "desc".
OUTPUT_TRANSLATABLE - Static variable in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Description of the Field

P

Parameter(String, String, String) - Constructor for class com.archibus.datasource.DataSourceImpl.Parameter
Constructor.
parameterExists(String) - Method in interface com.archibus.jobmanager.EventHandlerContext
Checks whether named event handler parameter exists.
parameterExistsNotEmpty(String) - Method in interface com.archibus.jobmanager.EventHandlerContext
Checks whether named event handler parameter exists and is not an empty string.
parameters - Variable in class com.archibus.datasource.DataSourceImpl
Map of named parameter definitions.
parametersChanged - Variable in class com.archibus.datasource.DataSourceImpl
This flag is set to true by the setParameter() method to indicate that SQL restrictions and SQL queries have to be re-evaluated before next data access call.
parentContext - Variable in class com.archibus.datasource.DataSourceImpl
Web Central context.
parseClientRestrictions(String) - Method in interface com.archibus.datasource.DataSource
Creates parsed or SQL restriction from the string input parameter.
parseClientRestrictions(String) - Method in class com.archibus.datasource.DataSourceImpl
Creates parsed or SQL restriction from the string input parameter.
parseFieldValue(EventHandlerContext, String, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
parseFieldValue(EventHandlerContext, String, String, String, boolean) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
parseJSONArray(EventHandlerContext, JSONArray) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Parses field names and values from the JSON array of records.
parseJSONObject(EventHandlerContext, JSONObject) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Parses field names and values from the JSON object.
parseRecord(EventHandlerContext, Element) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Parses field names and values from specified XML record.
parseSqlFieldValue(EventHandlerContext, String, String, String, boolean) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
parseSqlValue(EventHandlerContext, String) - Method in class com.archibus.eventhandler.EventHandlerBase.DbField
Deprecated.
Parses value obtained from the database.
parseValue(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Parsed unformatted field value.
persistentRestrictions - Variable in class com.archibus.datasource.DataSourceImpl
AXVW and VPA restrictions.
PREFERENCES_MAIL_HOST - Static variable in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
 
PREFERENCES_MAIL_HOST_PASSWORD - Static variable in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
 
PREFERENCES_MAIL_HOST_PORT - Static variable in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
 
PREFERENCES_MAIL_HOST_USER_ID - Static variable in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
 
prepareMessage(EventHandlerContext, String, Object[]) - Method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Localizes and formats text message.
prepareMessage(EventHandlerContext, String, String, String, String, Object[]) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Localizes and formats specified message from the messages database table, using either the current user locale or specified locale.
primaryKeyFields - Variable in class com.archibus.datasource.DataSourceImpl
List of primary key field definitions.
project - Variable in class com.archibus.datasource.DataSourceImpl
Project instance
put(String, Object) - Method in class com.archibus.context.Context
 
putAll(Map<? extends String, ? extends Object>) - Method in class com.archibus.context.Context
 

Q

query - Variable in class com.archibus.datasource.DataSourceImpl
SQL query implementation for the main table.
queryDbRecords(EventHandlerContext, String, List, Map, DataSource.RecordHandler) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource#queryRecords() instead.
queryDbRecords(EventHandlerContext, String, String, List, Map, DataSource.RecordHandler) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource#queryRecords() instead.
queryRecords(DataSource.RecordHandler) - Method in interface com.archibus.datasource.DataSource
Executes SQL query and calls specified callback for each retrieved record.
queryRecords(String, DataSource.RecordHandler) - Method in interface com.archibus.datasource.DataSource
Executes SQL query and calls specified callback for each retrieved record.
queryRecords(DataSource.RecordHandler) - Method in class com.archibus.datasource.DataSourceImpl
 
queryRecords(String, DataSource.RecordHandler) - Method in class com.archibus.datasource.DataSourceImpl
 

R

remove(String) - Method in class com.archibus.context.Context
 
remove(String, String) - Static method in class com.archibus.datasource.DataSourceFactory
Removes object from the cache if it exists.
removeDisabledEventListenerClass(Class) - Method in class com.archibus.context.Context
 
removeResponseParameter(String) - Method in interface com.archibus.jobmanager.EventHandlerContext
Removes value from the response.
RESPONSE - Static variable in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Key for the HttpServletResponse value in the Map
restrictions - Variable in class com.archibus.datasource.DataSourceImpl
List of restrictions defined in the view.
restrictionValues - Variable in class com.archibus.datasource.DataSourceImpl
Map contains names and values of fields from the applied client-side restriction.
retrieveDbDataRecords(EventHandlerContext, String, List, Map, int, BooleanHolder, Element) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource instead.
retrieveDbRecords(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource instead.
retrieveDbRecords(EventHandlerContext, String, List, Map, int, BooleanHolder, Element) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource instead.
retrieveRecords(Message, boolean) - Method in interface com.archibus.view.tablegroup.datasource.DataSource.Immutable
 
retrieveStatistic(EventHandlerContext, String, String, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use DataStatistics instead.
role - Variable in class com.archibus.datasource.DataSourceImpl.TableAndRole
The role name.
ROLE_MAIN - Static variable in interface com.archibus.datasource.DataSource
Constant for "main" table role.
ROLE_STANDARD - Static variable in interface com.archibus.datasource.DataSource
Constant for "standard" table role.
rollback() - Method in interface com.archibus.datasource.DataSource
Rollback current database transaction.
rollback() - Method in class com.archibus.datasource.DataSourceImpl
 
rollback() - Static method in class com.archibus.datasource.SqlUtils
Rolls back the current database transaction.
run() - Method in interface com.archibus.jobmanager.Job
Starts the job.
run() - Method in class com.archibus.jobmanager.JobBase
Default run() implementation does not do anything.
runWorkflowRule(EventHandlerContext, String, boolean) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Invoke workflow rules either directly as Java classes, or as long-running jobs using JobManager.

S

save(T) - Method in class com.archibus.datasource.ObjectDataSourceImpl
saveRecord(DataRecord) - Method in interface com.archibus.datasource.DataSource
Saves new or updates existing record.
saveRecord(DataRecord) - Method in class com.archibus.datasource.DataSourceGroupingImpl
Override for DataSourceImpl.saveRecord().
saveRecord(DataRecord) - Method in class com.archibus.datasource.DataSourceImpl
 
SCRIPT_INJECTION_HANDLER - Static variable in class com.archibus.datasource.DataSourceImpl
Spring bean name.
scriptInjectionHandler - Variable in class com.archibus.datasource.DataSourceImpl
Optional: Script injection handler.
searchAndRetrieve(EventHandlerContext, String, String[], String[], String[][], RestrictionBase.Immutable[]) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use the DataSource API instead.
selectDbRecords(EventHandlerContext, String, String[], String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource instead.
selectDbRecords(EventHandlerContext, String, String[], String[], String[][], String, boolean, int) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource instead.
selectDbRecords(EventHandlerContext, String, String[], String[], String[][], String, Map, boolean, int) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource instead.
selectDbRecords(EventHandlerContext, String, String[], String[], String[][], RestrictionBase.Immutable[], boolean, int) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource instead.
selectDbRecords(EventHandlerContext, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource instead.
selectDbValue(EventHandlerContext, String, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource instead.
selectDbValues(EventHandlerContext, String, String[], String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use. Use DataSource instead.
send(MailMessage) - Method in class com.archibus.utility.MailSender
This method does all the dirty work of actually sending the email.
send() - Method in class com.archibus.utility.MailSender
Deprecated.
sendEmail(String, String, String, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use MailSender instead.
sendEmail(String, String, String, String, String, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use MailSender instead.
sendEmail(String, String, String, String, String, ArrayList, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use MailSender instead.
sendEmail(String, String, String, String, String, ArrayList, ArrayList, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use MailSender instead.
sendEmail(String, String, String, String, String, ArrayList, ArrayList, String, String, ArrayList) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use MailSender instead.
sendEmail(String, String, String, String, String, String, ArrayList, ArrayList, String, String, ArrayList) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use MailSender instead.
sendEmail(String, String, String, String, String, String, ArrayList, ArrayList, String, String, ArrayList, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use MailSender instead.
sendEmail(String, String, String, String, String, String, ArrayList, ArrayList, String, String, ArrayList, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Use MailSender instead.
set(Context) - Static method in class com.archibus.context.ContextStore
Set the context for the currently executing thread.
setActivityId(String) - Method in class com.archibus.utility.MailMessage
 
setApplicationContext(ApplicationContext) - Method in class com.archibus.context.Context
 
setApplyVpaRestrictions(boolean) - Method in interface com.archibus.datasource.DataSource
The applyVpaRestrictions property enables or disables VPA restrictions for all read queries, whether the Data Source uses custom SQL or not.
setApplyVpaRestrictions(boolean) - Method in class com.archibus.datasource.DataSourceImpl
 
setAssigned(String) - Method in class com.archibus.datasource.FieldOperation
Sets the assigned table name.
setAssignedRestriction(String) - Method in class com.archibus.datasource.FieldOperation
Sets the assigned table restriction (or the input filter).
setAttachments(List<String>) - Method in class com.archibus.utility.MailMessage
 
setAutoCommit(boolean) - Method in interface com.archibus.datasource.DataSource
Sets the autoCommit flag.
setAutoCommit(boolean) - Method in class com.archibus.datasource.DataSourceImpl
 
setBaseURL(String) - Method in class com.archibus.context.Context
Setter for the baseURL property.
setBcc(List<String>) - Method in class com.archibus.utility.MailMessage
 
setCc(List<String>) - Method in class com.archibus.utility.MailMessage
 
setCode(int) - Method in class com.archibus.jobmanager.JobStatus
 
setConfigManager(ConfigManager.Immutable) - Method in class com.archibus.context.Context
 
setContentType(String) - Method in class com.archibus.utility.MailMessage
 
setContentType(String) - Method in class com.archibus.utility.MailSender
Deprecated.
setContext() - Method in interface com.archibus.datasource.DataSource
Sets data source context and initializes context-dependent data source state based on the current thread context.
setContext(ContextCacheable.Immutable) - Method in interface com.archibus.datasource.DataSource
Sets data source context and initializes context-dependent data source state.
setContext(EventHandlerContext) - Method in interface com.archibus.datasource.DataSource
Sets data source context and initializes context-dependent data source state.
setContext(ContextCacheable.Immutable) - Method in class com.archibus.datasource.DataSourceImpl
 
setContext(EventHandlerContext) - Method in class com.archibus.datasource.DataSourceImpl
Sets data source context and initializes context-dependent data source state.
setContext() - Method in class com.archibus.datasource.DataSourceImpl
Sets data source context and initializes context-dependent data source state based on the current thread context.
setContextPath(String) - Method in class com.archibus.context.Context
 
setCurrentNumber(long) - Method in class com.archibus.jobmanager.JobStatus
 
setDatabaseRole(String) - Method in interface com.archibus.datasource.DataSource
Set database role for this DataSource to access.
setDatabaseRole(String) - Method in class com.archibus.datasource.DataSourceImpl
 
setDataSet(DataSet) - Method in class com.archibus.jobmanager.JobStatus
 
setDataSourceDef(AbstractDataSourceDef) - Method in interface com.archibus.datasource.DataSource
 
setDataSourceDef(AbstractDataSourceDef) - Method in class com.archibus.datasource.DataSourceImpl
 
setDateSent(Date) - Method in class com.archibus.utility.MailMessage
 
setDbConnection(DbConnection.ThreadSafe) - Method in class com.archibus.context.Context
 
setDebug(boolean) - Method in class com.archibus.context.Context
 
setDetails(String) - Method in class com.archibus.jobmanager.JobStatus
 
setDistinct(boolean) - Method in interface com.archibus.datasource.DataSource
Sets isDistinct flag.
setDistinct(boolean) - Method in class com.archibus.datasource.DataSourceImpl
 
setDoNotWrapCustomSql(boolean) - Method in class com.archibus.datasource.DataSourceImpl
Sets the doNotWrapCustomSql property.
setEventHandlerContext(EventHandlerContext) - Method in class com.archibus.context.Context
 
setException(Throwable) - Method in class com.archibus.context.Context
 
setFrom(String) - Method in class com.archibus.utility.MailMessage
 
setFrom(String) - Method in class com.archibus.utility.MailSender
Deprecated.
setHost(String) - Method in class com.archibus.utility.MailMessage
 
setHost(String) - Method in class com.archibus.utility.MailSender
Deprecated.
setHttpSession(HttpSession) - Method in class com.archibus.context.Context
 
setId(String) - Method in interface com.archibus.datasource.DataSource
 
setId(String) - Method in class com.archibus.datasource.DataSourceImpl
 
setLicenseManager(LicenseManager) - Method in class com.archibus.context.Context
 
setLocale(Locale) - Method in class com.archibus.context.Context
 
setLocale(Locale) - Method in interface com.archibus.jobmanager.EventHandlerContext
Sets a locale to use in the workflow rule to localize database values.
setMailLogger(MailLogger) - Method in class com.archibus.utility.MailSender
Sets mail logger.
setMaxRecords(int) - Method in interface com.archibus.datasource.DataSource
Sets the max number of records that can be retrieved by consequent calls to retrieveRecords().
setMaxRecords(int) - Method in class com.archibus.datasource.DataSourceImpl
 
setMessage(String) - Method in class com.archibus.jobmanager.JobStatus
 
setNextRequest(String) - Method in class com.archibus.context.Context
 
setOwner(String) - Method in class com.archibus.datasource.FieldOperation
Sets the owner table name.
setOwnerRestriction(String) - Method in class com.archibus.datasource.FieldOperation
Sets the owner table restriction (or the output filter).
setParameter(String, Object) - Method in interface com.archibus.datasource.DataSource
Sets new value for specified parameter.
setParameter(String, Object) - Method in class com.archibus.datasource.DataSourceImpl
 
setPartialResults(List<JobStatus.JobResult>) - Method in class com.archibus.jobmanager.JobStatus
Sets the new list of partial results.
setPassword(String) - Method in class com.archibus.utility.MailMessage
 
setPassword(String) - Method in class com.archibus.utility.MailSender
Deprecated.
setPort(int) - Method in class com.archibus.utility.MailMessage
 
setPort(String) - Method in class com.archibus.utility.MailMessage
 
setProject(Project.Immutable) - Method in class com.archibus.context.Context
 
setRealContextPath(String) - Method in class com.archibus.context.Context
 
setRequest(HttpServletRequest) - Method in class com.archibus.context.Context
 
setRequestURL(String) - Method in class com.archibus.context.Context
 
setResponse(HttpServletResponse) - Method in class com.archibus.context.Context
 
setResponse(DataRecord) - Method in interface com.archibus.jobmanager.EventHandlerContext
Adds single record to the response using JSON format.
setResponse(DataSet) - Method in interface com.archibus.jobmanager.EventHandlerContext
Adds dataset to the response using JSON format.
setResponse(List) - Method in interface com.archibus.jobmanager.EventHandlerContext
Adds a list of values to the response using JSON format.
setResponse(Map) - Method in interface com.archibus.jobmanager.EventHandlerContext
Adds a map of values to the response using JSON format.
setResponse(JSONObject) - Method in interface com.archibus.jobmanager.EventHandlerContext
Adds a JSON object to the response as "jsonExpression" parameter.
setResponse(JSONArray) - Method in interface com.archibus.jobmanager.EventHandlerContext
Adds a JSON array to the response as "jsonExpression" parameter.
setRestrictionRelativeOperation(ClauseDef.RelativeOperation) - Method in class com.archibus.datasource.DataSourceImpl
Sets relative operation used to combine multiple client restrictions.
setResult(JobStatus.JobResult) - Method in class com.archibus.jobmanager.JobStatus
 
setResult(String) - Method in class com.archibus.jobmanager.JobStatus
 
setRole(DatabaseRole) - Method in class com.archibus.context.Context
 
setSecurityController(SecurityController) - Method in class com.archibus.context.Context
 
setSession(Session) - Method in class com.archibus.context.Context
 
setSourceId(String) - Method in class com.archibus.utility.MailMessage
Setter for the sourceId property.
setSourceName(String) - Method in class com.archibus.utility.MailMessage
Setter for the sourceName property.
setStandard(String) - Method in class com.archibus.datasource.FieldOperation
Sets the standard table name.
setStatus(String) - Method in class com.archibus.utility.MailMessage
 
setStatusMessage(String) - Method in class com.archibus.utility.MailMessage
 
setSubject(String) - Method in class com.archibus.utility.MailMessage
 
setSubject(String) - Method in class com.archibus.utility.MailSender
Deprecated.
setText(String) - Method in class com.archibus.utility.MailMessage
 
setText(String) - Method in class com.archibus.utility.MailSender
Deprecated.
setTimeCompleted(Date) - Method in class com.archibus.jobmanager.JobStatus
 
setTimeSent(Time) - Method in class com.archibus.utility.MailMessage
 
setTimeStarted(Date) - Method in class com.archibus.jobmanager.JobStatus
 
setTitle(String) - Method in interface com.archibus.datasource.DataSource
 
setTitle(String) - Method in class com.archibus.datasource.DataSourceImpl
 
setTo(String) - Method in class com.archibus.utility.MailMessage
 
setTo(String) - Method in class com.archibus.utility.MailSender
Deprecated.
setTotalNumber(long) - Method in class com.archibus.jobmanager.JobStatus
 
setTransactionInfos(TransactionInfos) - Method in class com.archibus.context.Context
 
setUseHierarchicalSecurityRestriction(boolean) - Method in interface com.archibus.datasource.DataSource
Sets the useHierarchicalSecurityRestriction property.
setUseHierarchicalSecurityRestriction(boolean) - Method in class com.archibus.datasource.DataSourceImpl
 
setUser(User) - Method in class com.archibus.context.Context
 
setUser(String) - Method in class com.archibus.utility.MailMessage
 
setUser(String) - Method in class com.archibus.utility.MailSender
Deprecated.
setUserAccount(UserAccount.Immutable) - Method in class com.archibus.context.Context
 
setUserSession(UserSession.Immutable) - Method in class com.archibus.context.Context
 
setUserSessionDto(UserSessionDto) - Method in class com.archibus.context.Context
 
setValue(Object) - Method in class com.archibus.datasource.DataSourceImpl.Parameter
Sets the parsed parameter value.
setVersion(Version) - Method in class com.archibus.context.Context
Setter for the version property.
setViewName(String) - Method in interface com.archibus.datasource.DataSource
 
setViewName(String) - Method in class com.archibus.datasource.DataSourceImpl
 
setWebAppPath(String) - Method in class com.archibus.context.Context
 
SORT_ASC - Static variable in interface com.archibus.datasource.DataSource
Constant for ascending sort order.
SORT_DESC - Static variable in interface com.archibus.datasource.DataSource
Constant for descending sort order.
SortField(String, String, String) - Constructor for class com.archibus.datasource.DataSourceImpl.SortField
Constructor.
SortField(String, String, boolean) - Constructor for class com.archibus.datasource.DataSourceImpl.SortField
Constructor.
sortFields - Variable in class com.archibus.datasource.DataSourceImpl
List of sort order fields.
SQL_INJECTION_HANDLER - Static variable in class com.archibus.datasource.DataSourceImpl
Spring bean name.
sqlInjectionHandler - Variable in class com.archibus.datasource.DataSourceImpl
Optional: SQL injection handler.
SqlUtils - Class in com.archibus.datasource
Provides static methods to execute SQL queries and format values for SQL.
SqlUtils() - Constructor for class com.archibus.datasource.SqlUtils
 
standardQueries - Variable in class com.archibus.datasource.DataSourceImpl
SQL query implementations for standard tables.
startJob(Job) - Method in interface com.archibus.jobmanager.JobManager.Mutable.Synchronized
Starts specified job instance.
status - Variable in class com.archibus.jobmanager.JobBase
Job status.
stop() - Method in interface com.archibus.jobmanager.Job
Requests the job to stop.
stop() - Method in class com.archibus.jobmanager.JobBase
Requests the job to stop.
stopJob(String) - Method in interface com.archibus.jobmanager.JobManager.Mutable.Synchronized
Requests specified job instance to stop.
stopRequested - Variable in class com.archibus.jobmanager.JobBase
Set to true when stop is requested.
stripPrefix(Map) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.

T

table - Variable in class com.archibus.datasource.DataSourceImpl.SortField
The table.
TableAndRole(String, String) - Constructor for class com.archibus.datasource.DataSourceImpl.TableAndRole
Constructor.
tableName - Variable in class com.archibus.datasource.ObjectDataSourceImpl
Database table name.
tablesAndRoles - Variable in class com.archibus.datasource.DataSourceImpl
List containing names and roles of all tables.
terminateJob(String) - Method in interface com.archibus.jobmanager.JobManager.Mutable.Synchronized
Terminates specified job instance thread.
title - Variable in class com.archibus.jobmanager.JobStatus.JobResult
Example: "First 1000 Records"
toJSONArray(List) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
toJSONObject(Map) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Do not use.
toString() - Method in class com.archibus.jobmanager.JobStatus
Returns formatted status string representation, with the custom message if present.
toString() - Method in class com.archibus.utility.MailMessage
 
toString() - Method in interface com.archibus.view.tablegroup.datasource.DataSource.Immutable
 
TYPE_GROUPING - Static variable in class com.archibus.datasource.DataSourceFactory
Constant for type="grouping".
TYPE_NONE - Static variable in class com.archibus.datasource.DataSourceFactory
Constant for type="none" (stock data source).

U

update(T) - Method in class com.archibus.datasource.ObjectDataSourceImpl
update(T, T) - Method in class com.archibus.datasource.ObjectDataSourceImpl
update(Element, Element, String) - Method in interface com.archibus.view.tablegroup.datasource.DataSource.Immutable
 
updateLastPartialResult(JobStatus.JobResult) - Method in class com.archibus.jobmanager.JobStatus
Updates the last added partial job result.
updateRecord(DataRecord) - Method in interface com.archibus.datasource.DataSource
Updates existing record specified by the primary key values.
updateRecord(DataRecord) - Method in class com.archibus.datasource.DataSourceImpl
 
url - Variable in class com.archibus.jobmanager.JobStatus.JobResult
Example:"\\\\archsrv:8080\\archibus\\projects\\users\\abernathy\\Rooms by Department and Floor 2009-12-20-1000.docx"
useCascadeHandler() - Method in class com.archibus.datasource.DataSourceImpl
 
useHierarchicalSecurityRestriction - Variable in class com.archibus.datasource.DataSourceImpl
True if generated SQL query should include per-user hierarchical security restriction.
useVirtualFields() - Method in class com.archibus.datasource.DataSourceGroupingImpl
Returns true if virtual fields must be used instead of visible fields to handle JDBC resultset (always for grouping DataSource).
useVirtualFields() - Method in class com.archibus.datasource.DataSourceImpl
Returns true if virtual fields must be used instead of visible fields to handle JDBC resultset.

V

validate() - Method in class com.archibus.utility.MailMessage
Validates this message integrity.
value - Variable in class com.archibus.datasource.DataSourceImpl.Parameter
Parameter value specified in the view.
virtualFieldDefs - Variable in class com.archibus.datasource.DataSourceImpl
List of virtual field definitions.
virtualFields - Variable in class com.archibus.datasource.DataSourceImpl
List of virtual fields.
visibleFields - Variable in class com.archibus.datasource.DataSourceImpl
List of visible field definitions.
visibleFieldsByName - Variable in class com.archibus.datasource.DataSourceImpl
Map that contains visible fields keyed by their full names.

W

writeStringToResponse(EventHandlerContext, String, String) - Static method in class com.archibus.eventhandler.EventHandlerBase
Deprecated.
Write string to HttpServletResponse
A B C D E F G H I J K L M N O P Q R S T U V W 
Skip navigation links