public interface LibraryOptions
Modifier and Type | Field and Description |
---|---|
static String |
AUDIT_EVENT_AGGREGATE_INNER_COLUMN_LIST
Aggregate AuditEvent search option for the set of
inner columns to select from, instead of simply selecting
from the event table itself.
|
static String |
AUDIT_EVENT_AUXILIARY_ITEM_IDS
IDs of the auxiliary objects associated with the AuditEvent.
|
static String |
AUDIT_EVENT_AUXILIARY_NUMBER
The auxiliary Number associated with the AuditEvent.
|
static String |
AUDIT_EVENT_AUXILIARY_STRING
The auxiliary String associated with the AuditEvent.
|
static String |
AUDIT_EVENT_FILTER_APPLICATION_CONTEXT
AuditEvent search option to restrict Events to those matching
specified application context.
|
static String |
AUDIT_EVENT_FILTER_APPLICATION_USER
AuditEvent search option to restrict Events to those matching
specified application user.
|
static String |
AUDIT_EVENT_FILTER_AUXILIARY_NUMBER
AuditEvent search option to restrict Events to those matching
specified auxiliary number.
|
static String |
AUDIT_EVENT_FILTER_AUXILIARY_STRING
AuditEvent search option to restrict Events to those matching
specified auxiliary string.
|
static String |
AUDIT_EVENT_FILTER_CREATORS
AuditEvent search option for the set of Creator IDs to include.
|
static String |
AUDIT_EVENT_FILTER_END_DATE
AuditEvent search option for the ending Date of a Date range.
|
static String |
AUDIT_EVENT_FILTER_END_ID
AuditEvent search option for the ending ID of an ID range.
|
static String |
AUDIT_EVENT_FILTER_OPERATION_TYPES
AuditEvent search option for the set of Operation Types to include.
|
static String |
AUDIT_EVENT_FILTER_RESULT_SIZE_LIMIT
AuditEvent search option specifying the size limit for the results
of the query.
|
static String |
AUDIT_EVENT_FILTER_START_DATE
AuditEvent search option for the starting Date of a Date range.
|
static String |
AUDIT_EVENT_FILTER_START_ID
AuditEvent search option for the starting ID of an ID range.
|
static String |
AUDIT_EVENT_FILTER_SUCCESS
AuditEvent search option for whether to include Events representing
successful operations.
|
static String |
AUDIT_EVENT_FILTER_TARGETS
AuditEvent search option for the set of Target IDs to include.
|
static String |
AUDIT_EVENT_PROPERTIES
The properties associated with the AuditEvent.
|
static String |
AUDIT_SPECIFICATION_CUSTOM_ID
AuditEvent search option specifying the ID of the custom AuditSpecification
to search when the AUDIT_SPECIFICATION_TYPE option is set to
ExternalConstants.AUDIT_SPECIFICATION_CUSTOM.
|
static String |
AUDIT_SPECIFICATION_OBJECT_TARGET_ID
Deprecated.
use OPT.AUDIT_EVENT_FILTER_TARGETS
|
static String |
AUDIT_SPECIFICATION_TYPE
AuditEvent search option specifying a well-known AuditSpecification from
which to search.
|
static String |
MAX_RESULTS
The maximum number of results to be returned.
|
static String |
SEARCH_DISTINCT
The key used to indicate if a distinct search is required
Name: OPT.SEARCH_DISTINCT
Data Type: Boolean |
static String |
SEARCH_STATEMENT_KEY
The key used for caching of a prepared statement
Name: OPT.SEARCH_STATEMENT_KEY
Data Type: String |
static String |
STARTING_ROW
The starting row index.
|
static final String AUDIT_EVENT_FILTER_START_ID
Note: A value of null is treated as "all IDs before end ID"; a null range is treated as "all IDs".
Name: OPT.AUDIT_EVENT_FILTER_START_ID
Data Type: Long
static final String AUDIT_EVENT_FILTER_END_ID
Note: A value of null is treated as "all IDs after start ID"; a null range is treated as "all IDs".
Name: OPT.AUDIT_EVENT_FILTER_END_ID
Data Type: Long
static final String AUDIT_EVENT_FILTER_START_DATE
Note: A value of null is treated as "all Dates until end Date"; a null range is treated as "all Dates".
Name: OPT.AUDIT_EVENT_FILTER_START_DATE
Data Type: Date
static final String AUDIT_EVENT_FILTER_END_DATE
Note: A value of null is treated as "all Dates since start Date"; a null range is treated as "all Dates".
Name: OPT.AUDIT_EVENT_FILTER_END_DATE
Data Type: Date
static final String AUDIT_EVENT_FILTER_CREATORS
Note: A value of null is treated as "all creators".
Name: OPT.AUDIT_EVENT_FILTER_CREATORS
Data Type: Long[]
static final String AUDIT_EVENT_FILTER_OPERATION_TYPES
Note: A value of null is treated as "all operation types".
Name: OPT.AUDIT_EVENT_FILTER_OPERATION_TYPES
Data Type: String[]
static final String AUDIT_EVENT_FILTER_TARGETS
Notes:
Name: OPT.AUDIT_EVENT_FILTER_TARGETS
Data Type: Long[]
static final String AUDIT_EVENT_FILTER_SUCCESS
Note: A value of null is treated as "both succeeded and failed operations". A value of true is treated as "only successful operations". A value of false is treated as "only failed operations".
Name: OPT.AUDIT_EVENT_FILTER_SUCCESS
Data Type: Boolean
static final String AUDIT_EVENT_FILTER_AUXILIARY_STRING
Note: A value of null is treated as "any auxiliary string".
Name: OPT.AUDIT_EVENT_FILTER_AUXILIARY_STRING
Data Type: String
static final String AUDIT_EVENT_FILTER_AUXILIARY_NUMBER
Note: A value of null is treated as "any auxiliary number".
Name: OPT.AUDIT_EVENT_FILTER_AUXILIARY_NUMBER
Data Type: Long
static final String AUDIT_EVENT_FILTER_APPLICATION_CONTEXT
Note: A value of null is treated as "any application context".
Name: OPT.AUDIT_EVENT_FILTER_APPLICATION_CONTEXT
Data Type: String
static final String AUDIT_EVENT_FILTER_APPLICATION_USER
Note: A value of null is treated as "any application user".
Name: OPT.AUDIT_EVENT_FILTER_APPLICATION_USER
Data Type: String
static final String AUDIT_EVENT_FILTER_RESULT_SIZE_LIMIT
Note: A value of null is treated as "no limit".
Name: OPT.AUDIT_EVENT_FILTER_RESULT_SIZE_LIMIT
Data Type: Integer
static final String AUDIT_EVENT_AGGREGATE_INNER_COLUMN_LIST
Note: A value of null indicates that there is no inner select for the aggregate event column search.
Name: OPT.AUDIT_EVENT_AGGREGATE_INNER_COLUMN_LIST
Data Type: String[]
static final String AUDIT_SPECIFICATION_TYPE
Note: A value of null is treated as the default value: ExternalConstants.AUDIT_SPECIFICATION_DOMAIN
Name: OPT.AUDIT_SPECIFICATION_TYPE
Data Type: Integer
Enumeration: {ExternalConstants.AUDIT_SPECIFICATION_DOMAIN,
ExternalConstants.AUDIT_SPECIFICATION_OBJECT,
ExternalConstants.AUDIT_SPECIFICATION_CUSTOM}
static final String AUDIT_SPECIFICATION_CUSTOM_ID
Note: A value of null is not allowed when searching from a custom AuditSpecification. This option is not allowed when searching from the Domain AuditSpecification or the Object AuditSpecification.
Name: AUDIT_SPECIFICATION_CUSTOM_ID
Data Type: Long
static final String AUDIT_SPECIFICATION_OBJECT_TARGET_ID
Note: this option is deprecated; use AUDIT_EVENT_FILTER_TARGETS instead to specified one or more target objects when searching against the Object AuditSpecification.
Name: AUDIT_SPECIFICATION_OBJECT_TARGET_ID
Data Type: Long
static final String AUDIT_EVENT_AUXILIARY_ITEM_IDS
Name: OPT.AUDIT_EVENT_AUXILIARY_ITEM_IDS
Data Type: Long[]
static final String AUDIT_EVENT_AUXILIARY_STRING
Name: OPT.AUDIT_EVENT_AUXILIARY_STRING
Data Type: String
static final String AUDIT_EVENT_AUXILIARY_NUMBER
Name: OPT.AUDIT_EVENT_AUXILIARY_NUMBER
Data Type: Long
static final String AUDIT_EVENT_PROPERTIES
Name: OPT.AUDIT_EVENT_PROPERTIES
Data Type: NamedValue[]
static final String SEARCH_STATEMENT_KEY
Name: OPT.SEARCH_STATEMENT_KEY
Data Type: String
static final String SEARCH_DISTINCT
Name: OPT.SEARCH_DISTINCT
Data Type: Boolean
static final String STARTING_ROW
Name: OPT.STARTING_ROW
Data Type: Integer
static final String MAX_RESULTS
if MAX_RESULTS = 10 and STARTING_ROW is not specified (or 0 / 1), then
results from row 1 through 10 are returned (if located).
if MAX_RESULTS = 10 and STARTING_ROW = 50, then results from row 50
through 59 are returned (if located).
if MAX_RESULTS = 0 and STARTING_ROW = 50, then results from row 50
onwards are returned (if located).
Name: OPT.MAX_RESULTS
Data Type: Integer
Copyright © 2023. All rights reserved.