Defines the content type and the server-side Java implementation that automatically classifies a document of the defined content type. You must create the Java classifier by implementing the DocumentClassifier interface. To specify the content type of the documents for which a IDocumentClassificationAction object will apply, set the MimeType property. To specify the implemented Java classifier, set the ProgId property. Each IDocumentClassificationAction object that you create and save in a given object store is automatically added to the object store's collection of IDocumentClassificationAction objects.


The following tables list the members exposed by IDocumentClassificationAction.

Public Properties

  Name Description
Public property MimeType Specifies the Multipurpose Internet Mail Extensions (MIME) format string of the content data carried by this document, annotation, or document classification action.

For Document objects, you can set the MimeType property for a specific document version while it is a reservation object (at creation time and on subsequent check-outs). However, every time you check in a document, its MimeType property value reverts to its system-assigned value unless you explicitly set it again.

For Annotation objects, you can set this property at any time.

For DocumentClassificationAction objects, the MimeType property specifies the type of content that a document must hold in order to allow it to be auto-classified; you can set this property at any time.

Each content element that is attached to a document or annotation has its own MIME type, which is specified by its ContentType property. If you do not set the MimeType property for a document or annotation, it is automatically set by the Content Engine according to the value of each content element's ContentType property and according to the following logic:

  • If the object contains one or more ContentTransfer objects that all have the same value for their ContentType property, MimeType is set to the value of the ContentType property.
  • If the object contains a single ContentReference object, MimeType is set to "application/x-filenet-external".
  • If the object contains multiple ContentReference objects (but no ContentTransfer objects), MimeType is set to "multipart/x-filenet-external".
  • Otherwise, MimeType is set to "multipart/mixed".

MIME is a communications protocol that allows for the transmission of data in many forms, such as audio, binary, or video. A MIME format string consists of a content type, a content subtype, and an optional parameter in the format: "MIME::content type/subtype[;parameter]". For example: "MIME::text/html". MIME defines the following content types:

  • text: Represent textual information in a number of character sets. A charset parameter may be used (for example, "MIME::text/plain;charset=us-ascii"). Some subtypes: plain, html, richtext.
  • image: Represents still images. Some subtypes: jpeg, gif.
  • audio: Represents audio or voice data. Some subtypes: wav, au.
  • video: Represents video data or moving-image data. Some subtypes: mpeg, mp4.
  • message: Encapsulates an entire formatted message. Some subtypes: rfc822, partial, external-body.
  • multipart: Combines several body parts of potentially different types and subtypes. Some subtypes: mixed, alternative, parallel, digest.
  • application: Represents application data (such as executables) or binary data.

The following MIME types are specific to FileNet:

  • application/x-filenet-declarerecordtemplate: Record template.
  • application/x-filenet-documentassembly: Document assembly.
  • application/x-filenet-external: An object that contains a single ContentReference content element.
  • application/x-filenet-external-is: External Image Services document.
  • application/x-filenet-publishtemplate: Publish template.
  • application/x-filenet-scenariodefinition: Scenario definition document.
  • application/x-filenet-search: Stored search.
  • application/x-filenet-searchtemplate: Search template.
  • application/x-filenet-workflowdefinition: Workflow definition document.
  • multipart/x-filenet-external: An object that contains multiple ContentReference content elements only.
Top

Public Methods

  Name Description
Public method ChangeClass Changes the class of a Content Engine object. The new class must already exist and both it and the original class must be subclasses of the same base class. The ChangeClass method does not modify the security for an object, even if the object's current security is derived from the default security for its source class. For the object's user-defined properties, the following rules apply:
  • Any user-defined properties that exist in the new class but not in the original class are set to the default value defined by the new class (or to null if there is no default defined).
  • Any user-defined properties that exist in both the original and the new class that are writable and have the same value (including null) as the default value defined in the original class will be set to the default value defined by the new class. However, any user-defined property that has had its value modified from the default value will retain that modified value in the new class.
  • Any user-defined properties whose definitions exist in the original class but not in the new class will no longer exist on the object when its class is changed.

When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's DocumentLifecyclePolicy property if both of the following scenarios occur:

  • The document has no current lifecycle policy.
  • The document is either a reservation object, or is the current version object and is not reserved.

Top

See Also