com.filenet.rm.bds

Class ConfigItemType



  • public class ConfigItemType
    extends ConstantObject
    ConfigItemType is an enumerated constant object class that defines the allowed Configuration collection item members.
    • Field Detail

      • MINIMUM_CACHE_TTL

        public static final int MINIMUM_CACHE_TTL
        Minimum cache time-to-live value in minutes.
        See Also:
        Constant Field Values
      • 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:
        Constant Field Values
      • EXCEPTION_LOG_INCLUDE_ERRORSTACK

        public static final int EXCEPTION_LOG_INCLUDE_ERRORSTACK
        Exception logging includes localized message string and abbreviated ErrorStack.
        See Also:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • STOP_ON_FIRST_ERROR

        public static final ConfigItemType STOP_ON_FIRST_ERROR
        Designates the boolean configuration item concerning whether or not an error during batch validation should immediately terminate the batch execution process or allow any remaining operation validation steps to continue.

        When set to true, any BDS batch operation that fails validation causes the entire execution process to terminate immediately and a BDSException is thrown. When set to false, validation of any remaining batch operations continues and the throw of the BDSException is delayed until all operations have been validated.

        By retrieving the resulting collection of BatchResultItem instances (using BaseBulkService.getBatchResultItems()), the caller can examine the ResultItemStatus property of each operation to determine which operations passed validation, which failed validation and which did not have validation performed yet.

      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • VALIDATE_RECORDS_AS_INT

        public static final int VALIDATE_RECORDS_AS_INT
        See Also:
        Constant Field Values
      • 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.

© Copyright IBM Corp. 2006, 2013. All Rights Reserved.