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 Summary

Fields
Modifier and Type	Field and Description
`static IndexingFailureCode`	`CONTENT_NOT_FOUND` Indicates that the CBR-enabled object does not have any content elements.
`static int`	`CONTENT_NOT_FOUND_AS_INT` An `int` value associated with the CONTENT_NOT_FOUND instance of this class.
`static IndexingFailureCode`	`CONVERSION_DISABLED` Indicates the text extraction process used to convert content to plain text is disabled.
`static int`	`CONVERSION_DISABLED_AS_INT` An `int` value associated with the CONVERSION_DISABLED instance of this class.
`static IndexingFailureCode`	`ENCRYPTED` Indicates some or all of the text to be indexed was not indexed because it was encrypted.
`static int`	`ENCRYPTED_AS_INT` An `int` value associated with the ENCRYPTED instance of this class.
`static IndexingFailureCode`	`FALLBACK_PARSER_INVOKED` Indicates the text extracted from the content for the full text index may be incorrect.
`static int`	`FALLBACK_PARSER_INVOKED_AS_INT` An `int` value associated with the FALLBACK_PARSER_INVOKED instance of this class.
`static 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.
`static int`	`MALFORMED_AS_INT` An `int` value associated with the MALFORMED instance of this class.
`static IndexingFailureCode`	`MALFORMED_XML` Indicates the XML to be extracted for the full text index was not well-formed XML.
`static int`	`MALFORMED_XML_AS_INT` An `int` value associated with the MALFORMED_XML instance of this class.
`static 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.
`static int`	`MARKED_AS_SKIPPED_AS_INT` An `int` value associated with the MARKED_AS_SKIPPED instance of this class.
`static IndexingFailureCode`	`NO_TEXT_EXTRACTED` Indicates an empty file was found during indexing.
`static int`	`NO_TEXT_EXTRACTED_AS_INT` An `int` value associated with the NO_TEXT_EXTRACTED instance of this class.
`static IndexingFailureCode`	`OTHER` Indicates an uncommon error occurred.
`static int`	`OTHER_AS_INT` An `int` value associated with the OTHER instance of this class.
`static IndexingFailureCode`	`PARTIALLY_INDEXED_CONTENT` Indicates one of the content elements was only partially indexed.
`static int`	`PARTIALLY_INDEXED_CONTENT_AS_INT` An `int` value associated with the PARTIALLY_INDEXED_CONTENT instance of this class.
`static 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.
`static int`	`PASSWORD_PROTECTED_AS_INT` An `int` value associated with the PASSWORD_PROTECTED instance of this class.
`static IndexingFailureCode`	`SIZE_LIMIT_EXCEEDED` Indicates the size of the binary or XML content has exceeded a maximum value.
`static int`	`SIZE_LIMIT_EXCEEDED_AS_INT` An `int` value associated with the SIZE_LIMIT_EXCEEDED instance of this class.
`static IndexingFailureCode`	`TIME_OUT` Indicates that the indexing operation has timed out.
`static int`	`TIME_OUT_AS_INT` An `int` value associated with the TIME_OUT instance of this class.
`static IndexingFailureCode`	`TRUNCATED` Indicates the content text was truncated in the full text index.
`static int`	`TRUNCATED_AS_INT` An `int` value associated with the TRUNCATED instance of this class.
`static IndexingFailureCode`	`UNRECOGNIZED_ENCODING` Indicates the code page for the content was not identified.
`static int`	`UNRECOGNIZED_ENCODING_AS_INT` An `int` value associated with the UNRECOGNIZED_ENCODING instance of this class.
`static 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.
`static int`	`UNSUPPORTED_TYPE_AS_INT` An `int` value associated with the UNSUPPORTED_TYPE instance of this class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static IndexingFailureCode`	`getInstanceFromInt(int value)` Returns an instance of this class using its associated integer value.
`int`	`getValue()` Returns the internal integer value associated with a specific instance of this class.
`java.lang.String`	`toString()` Returns a `String` representation of this enumeration instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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
  - TRUNCATED
```
public static final IndexingFailureCode TRUNCATED
```
    Indicates the content text was truncated in the full text index. The maximum text limit is specified in the max.text.size parameter located in the parser_config.xml file for the document's collection. For more information, see Text extracted from a document during indexing is truncated.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
- 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()

Methods inherited from class java.lang.Object

CONTENT_NOT_FOUND_AS_INT

CONTENT_NOT_FOUND

PASSWORD_PROTECTED_AS_INT

PASSWORD_PROTECTED

UNSUPPORTED_TYPE_AS_INT

UNSUPPORTED_TYPE

MARKED_AS_SKIPPED_AS_INT

MARKED_AS_SKIPPED

UNRECOGNIZED_ENCODING_AS_INT

UNRECOGNIZED_ENCODING

NO_TEXT_EXTRACTED_AS_INT

NO_TEXT_EXTRACTED

SIZE_LIMIT_EXCEEDED_AS_INT

SIZE_LIMIT_EXCEEDED

ENCRYPTED_AS_INT

ENCRYPTED

OTHER_AS_INT

OTHER

CONVERSION_DISABLED_AS_INT

CONVERSION_DISABLED

TRUNCATED_AS_INT

TRUNCATED

MALFORMED_AS_INT

MALFORMED

MALFORMED_XML_AS_INT

MALFORMED_XML

TIME_OUT_AS_INT

TIME_OUT

PARTIALLY_INDEXED_CONTENT_AS_INT

PARTIALLY_INDEXED_CONTENT

FALLBACK_PARSER_INVOKED_AS_INT

FALLBACK_PARSER_INVOKED

getValue

toString

getInstanceFromInt