com.filenet.api.constants

Class IndexingFailureCode

  • java.lang.Object
    • com.filenet.api.constants.IndexingFailureCode
  • All Implemented Interfaces:
    java.io.Serializable


    public final class IndexingFailureCode
    extends java.lang.Object
    implements java.io.Serializable
    Provides a set of constants that identifies the types of failures that have occurred as a result of an index request for a CBR-enabled object. A constant identifying each type of indexing failure is added to the bitmask returned by the CmIndexingFailureCode property of the CBR-enabled object and its associated index request. If there are no indexing failures, the CmIndexingFailureCode property returns a value of zero.
    See Also:
    Serialized Form
    • Field Detail

      • MALFORMED_AS_INT

        public static final int MALFORMED_AS_INT
        An int value associated with the MALFORMED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • MALFORMED

        public static final IndexingFailureCode MALFORMED
        Indicates some or all of the text to be extracted for the full text index is missing and the content was not read correctly.
      • OTHER_AS_INT

        public static final int OTHER_AS_INT
        An int value associated with the OTHER instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • OTHER

        public static final IndexingFailureCode OTHER
        Indicates an uncommon error occurred. Check the value of the LastFailureReason property on CmIndexRequest to determine the cause.
      • TRUNCATED_AS_INT

        public static final int TRUNCATED_AS_INT
        An int value associated with the TRUNCATED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • ENCRYPTED_AS_INT

        public static final int ENCRYPTED_AS_INT
        An int value associated with the ENCRYPTED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • ENCRYPTED

        public static final IndexingFailureCode ENCRYPTED
        Indicates some or all of the text to be indexed was not indexed because it was encrypted.
      • TIME_OUT_AS_INT

        public static final int TIME_OUT_AS_INT
        An int value associated with the TIME_OUT instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • TIME_OUT

        public static final IndexingFailureCode TIME_OUT
        Indicates that the indexing operation has timed out.
      • SIZE_LIMIT_EXCEEDED_AS_INT

        public static final int SIZE_LIMIT_EXCEEDED_AS_INT
        An int value associated with the SIZE_LIMIT_EXCEEDED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • SIZE_LIMIT_EXCEEDED

        public static final IndexingFailureCode SIZE_LIMIT_EXCEEDED
        Indicates the size of the binary or XML content has exceeded a maximum value.
      • PASSWORD_PROTECTED_AS_INT

        public static final int PASSWORD_PROTECTED_AS_INT
        An int value associated with the PASSWORD_PROTECTED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • PASSWORD_PROTECTED

        public static final IndexingFailureCode PASSWORD_PROTECTED
        Indicates some or all of the text to be extracted for the full text index was not indexed because it was password-protected.
      • CONTENT_NOT_FOUND_AS_INT

        public static final int CONTENT_NOT_FOUND_AS_INT
        An int value associated with the CONTENT_NOT_FOUND instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • CONTENT_NOT_FOUND

        public static final IndexingFailureCode CONTENT_NOT_FOUND
        Indicates that the CBR-enabled object does not have any content elements. Therefore, no text can be indexed.
      • PARTIALLY_INDEXED_CONTENT_AS_INT

        public static final int PARTIALLY_INDEXED_CONTENT_AS_INT
        An int value associated with the PARTIALLY_INDEXED_CONTENT instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • PARTIALLY_INDEXED_CONTENT

        public static final IndexingFailureCode PARTIALLY_INDEXED_CONTENT
        Indicates one of the content elements was only partially indexed.
      • UNRECOGNIZED_ENCODING_AS_INT

        public static final int UNRECOGNIZED_ENCODING_AS_INT
        An int value associated with the UNRECOGNIZED_ENCODING instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • UNRECOGNIZED_ENCODING

        public static final IndexingFailureCode UNRECOGNIZED_ENCODING
        Indicates the code page for the content was not identified.
      • FALLBACK_PARSER_INVOKED_AS_INT

        public static final int FALLBACK_PARSER_INVOKED_AS_INT
        An int value associated with the FALLBACK_PARSER_INVOKED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • FALLBACK_PARSER_INVOKED

        public static final IndexingFailureCode FALLBACK_PARSER_INVOKED
        Indicates the text extracted from the content for the full text index may be incorrect. The primary parser was unable to parse the content and the fallback parser was invoked. The content may have been partially indexed.
      • CONVERSION_DISABLED_AS_INT

        public static final int CONVERSION_DISABLED_AS_INT
        An int value associated with the CONVERSION_DISABLED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • CONVERSION_DISABLED

        public static final IndexingFailureCode CONVERSION_DISABLED
        Indicates the text extraction process used to convert content to plain text is disabled.
      • NO_TEXT_EXTRACTED_AS_INT

        public static final int NO_TEXT_EXTRACTED_AS_INT
        An int value associated with the NO_TEXT_EXTRACTED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • NO_TEXT_EXTRACTED

        public static final IndexingFailureCode NO_TEXT_EXTRACTED
        Indicates an empty file was found during indexing.
      • MARKED_AS_SKIPPED_AS_INT

        public static final int MARKED_AS_SKIPPED_AS_INT
        An int value associated with the MARKED_AS_SKIPPED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • MARKED_AS_SKIPPED

        public static final IndexingFailureCode MARKED_AS_SKIPPED
        Indicates that an administrator or an application (via the IndexingOperation property of a CmIndexRequest object) has marked a CBR-enabled object to be skipped for full-text indexing. If the indexing failure code of a CBR-enabled object is set to MARKED_AS_SKIPPED, the server will not index the object. If any additional index requests exist for the object, they will be deleted.
      • UNSUPPORTED_TYPE_AS_INT

        public static final int UNSUPPORTED_TYPE_AS_INT
        An int value associated with the UNSUPPORTED_TYPE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • UNSUPPORTED_TYPE

        public static final IndexingFailureCode UNSUPPORTED_TYPE
        Indicates some or all of the text to be extracted for the full text index was not indexed because the content type is not supported.

        For IBM® Legacy Content Search Engine, this failure code is also returned for files that are password-protected.

      • MALFORMED_XML_AS_INT

        public static final int MALFORMED_XML_AS_INT
        An int value associated with the MALFORMED_XML instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • MALFORMED_XML

        public static final IndexingFailureCode MALFORMED_XML
        Indicates the XML to be extracted for the full text index was not well-formed XML.
    • Method Detail

      • getValue

        public int getValue()
        Returns the internal integer value associated with a specific instance of this class.
        Returns:
        The enumeration instance's ordinal value.
        See Also:
        getInstanceFromInt(int)
      • toString

        public java.lang.String toString()
        Returns a String representation of this enumeration instance.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The enumeration instance's description.
      • getInstanceFromInt

        public static IndexingFailureCode getInstanceFromInt(int value)
        Returns an instance of this class using its associated integer value.
        Parameters:
        value - The integer value. (See the *_AS_INT fields.)
        Returns:
        The enumeration instance with the given ordinal value.
        Throws:
        EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
        See Also:
        getValue()

© Copyright IBM Corporation 2006, 2015. All rights reserved.