com.filenet.rm.bds
Class ConfigItemType
- java.lang.Object
com.filenet.rm.bds.ConstantObject
com.filenet.rm.bds.ConfigItemType
- public class ConfigItemType
- extends ConstantObject
Field Summary
Modifier and Type | Field and Description |
---|---|
|
APPEND_CURRENT_USER_PERMISSION
Deprecated.
|
|
APPEND_CURRENT_USER_PERMISSION_AS_INT
Deprecated.
|
|
CACHE_TTL
Designates the integer configuration item concerning the BDS Cache Time-To-Live value (in minutes)
|
|
CACHE_TTL_AS_INT
|
|
DEFAULT_CACHE_TTL
Default cache time-to-live value in minutes.
|
|
DEFAULT_EXCEPTION_LOG_DETAIL
Default exception logging value.
|
|
DEFAULT_MAX_DECLASSIFY
Default DoDCh4 max declassify timeframe in years.
|
|
DODCHAPTER4_DECLASSIFY_TIMELIMIT
Designates the integer configuration item concerning the DoD Chapter 4 maximum declassify time limit value (in years).
|
|
DODCHAPTER4_DECLASSIFY_TIMELIMIT_AS_INT
|
|
EXCEPTION_LOG_INCLUDE_DIAG_STACKTRACES
Exception logging includes localized message string and ErrorStack with
Diagnostic stacktraces.
|
|
EXCEPTION_LOG_INCLUDE_ERRORSTACK
Exception logging includes localized message string and abbreviated ErrorStack.
|
|
EXCEPTION_LOG_MSG_ONLY
Exception logging only includes localized message string.
|
|
EXCEPTION_LOGGING_DETAIL
Designates the amount of textual detail to log for instances of
BDSException .
|
|
EXCEPTION_LOGGING_DETAIL_AS_INT
|
|
MINIMUM_CACHE_TTL
Minimum cache time-to-live value in minutes.
|
|
STOP_ON_FIRST_ERROR
Designates the boolean configuration item concerning whether or not an error during
declaration and/or committal should terminate the entire job.
|
|
STOP_ON_FIRST_ERROR_AS_INT
|
|
VALIDATE_RECORD_CONTAINERS
Designates the boolean configuration item concerning whether or not record container validation is performed
during record declaration.
|
|
VALIDATE_RECORD_CONTAINERS_AS_INT
|
|
VALIDATE_RECORDS
Designates the boolean value that determines whether record validation should or should not be
performed during record declaration.
|
|
VALIDATE_RECORDS_AS_INT
|
Method Summary
Modifier and Type | Method and Description |
---|---|
getDataType()
Returns the data type of the configuration item defined by this
ConfigItemType instance.
|
|
|
getDefaultValue()
Returns the default value (if any) for this configuration item.
|
|
getDescription()
Returns the default locale description for this configuration item.
|
|
getDescription(java.util.Locale locale)
Returns the description for this configuration item for the given locale.
|
Methods inherited from class com.filenet.rm.bds.ConstantObject |
---|
getEnumeratedList, getIntValue, getLocalizedStringValue, getLocalizedStringValue, getStringValue |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail
MINIMUM_CACHE_TTL
- public static final int MINIMUM_CACHE_TTL
Minimum cache time-to-live value in minutes.
See Also:
DEFAULT_CACHE_TTL
- public static final java.lang.Integer DEFAULT_CACHE_TTL
Default cache time-to-live value in minutes.
DEFAULT_MAX_DECLASSIFY
- public static final java.lang.Integer DEFAULT_MAX_DECLASSIFY
Default DoDCh4 max declassify timeframe in years.
EXCEPTION_LOG_MSG_ONLY
- public static final int EXCEPTION_LOG_MSG_ONLY
Exception logging only includes localized message string.
See Also:
EXCEPTION_LOG_INCLUDE_ERRORSTACK
- public static final int EXCEPTION_LOG_INCLUDE_ERRORSTACK
Exception logging includes localized message string and abbreviated ErrorStack.
See Also:
EXCEPTION_LOG_INCLUDE_DIAG_STACKTRACES
- public static final int EXCEPTION_LOG_INCLUDE_DIAG_STACKTRACES
Exception logging includes localized message string and ErrorStack with
Diagnostic stacktraces.
See Also:
DEFAULT_EXCEPTION_LOG_DETAIL
- public static final java.lang.Integer DEFAULT_EXCEPTION_LOG_DETAIL
Default exception logging value.
STOP_ON_FIRST_ERROR_AS_INT
- public static final int STOP_ON_FIRST_ERROR_AS_INT
See Also:
STOP_ON_FIRST_ERROR
- public static final ConfigItemType STOP_ON_FIRST_ERROR
Designates the boolean configuration item concerning whether or not an error during
declaration and/or committal should terminate the entire job.
CACHE_TTL_AS_INT
- public static final int CACHE_TTL_AS_INT
See Also:
CACHE_TTL
- public static final ConfigItemType CACHE_TTL
Designates the integer configuration item concerning the BDS Cache Time-To-Live value (in minutes)
VALIDATE_RECORD_CONTAINERS_AS_INT
- public static final int VALIDATE_RECORD_CONTAINERS_AS_INT
See Also:
VALIDATE_RECORD_CONTAINERS
- public static final ConfigItemType VALIDATE_RECORD_CONTAINERS
Designates the boolean configuration item concerning whether or not record container validation is performed
during record declaration.
APPEND_CURRENT_USER_PERMISSION_AS_INT
- public static final int APPEND_CURRENT_USER_PERMISSION_AS_INT
Deprecated.
See Also:
APPEND_CURRENT_USER_PERMISSION
- public static final ConfigItemType APPEND_CURRENT_USER_PERMISSION
Deprecated.
Designates the boolean configuration item concerning whether or not to temporarily append
the necessary permission to each new record to allow the current user to define the
SecurityParent record property during declaration. Once the SecurityParent property has been
set, the added current user permission is removed.
If the CE record class DefaultInstanceSecurity already provides the current user with the necessary rights to define the SecurityParent property, then this configuration item should be set to false in order to improve declaration performance.
DODCHAPTER4_DECLASSIFY_TIMELIMIT_AS_INT
- public static final int DODCHAPTER4_DECLASSIFY_TIMELIMIT_AS_INT
See Also:
DODCHAPTER4_DECLASSIFY_TIMELIMIT
- public static final ConfigItemType DODCHAPTER4_DECLASSIFY_TIMELIMIT
Designates the integer configuration item concerning the DoD Chapter 4 maximum declassify time limit value (in years).
EXCEPTION_LOGGING_DETAIL_AS_INT
- public static final int EXCEPTION_LOGGING_DETAIL_AS_INT
See Also:
EXCEPTION_LOGGING_DETAIL
- public static final ConfigItemType EXCEPTION_LOGGING_DETAIL
Designates the amount of textual detail to log for instances of
BDSException
.
Legal integer values include:
VALIDATE_RECORDS_AS_INT
- public static final int VALIDATE_RECORDS_AS_INT
See Also:
VALIDATE_RECORDS
- public static final ConfigItemType VALIDATE_RECORDS
Designates the boolean value that determines whether record validation should or should not be
performed during record declaration.
Method Detail
getDataType
- public DataType getDataType()
Returns the data type of the configuration item defined by this
ConfigItemType instance.
Returns:
a
DataType
value describing the configuration item's contained data type. getDefaultValue
- public java.lang.Object getDefaultValue( )
Returns the default value (if any) for this configuration item.
Returns:
Object
value. getDescription
- public java.lang.String getDescription( )
Returns the default locale description for this configuration item.
Returns:
String
description value. getDescription
- public java.lang.String getDescription( java.util.Locale locale)
Returns the description for this configuration item for the given locale.
Parameters:
locale
- Locale
to base description on. Returns:
String
description value.