com.filenet.api.events

Interface DocumentClassificationAction

All Superinterfaces:

Action, EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable

public interface DocumentClassificationAction
extends RepositoryObject, Action

Associates a server-side document classifier with documents of a defined MIME type. When a document of that MIME type is checked in, the classifier assigns a target class to the document. You create a document classifier by implementing the DocumentClassifier interface as a Java or JavaScript component. Each DocumentClassificationAction object that you save in an object store is automatically added to the object store's collection of DocumentClassificationAction objects.

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: Action

See Also:

DocumentClassifier, Document Classification Concepts

Method Summary

Modifier and Type	Method and Description
void	changeClass(java.lang.String className) Changes the class of a Content Engine object.
java.lang.String	get_MimeType() Returns the value of the MimeType property.
void	set_MimeType(java.lang.String value) Sets the value of the MimeType property.

Methods inherited from interface com.filenet.api.events.Action

get_ActiveMarkings, get_AuditedEvents, get_CodeModule, get_Creator, get_DateCreated, get_DateLastModified, get_DescriptiveText, get_DisplayName, get_Id, get_LastModifier, get_Name, get_Owner, get_Permissions, get_ProgId, get_ScriptText, set_CodeModule, set_Creator, set_DateCreated, set_DateLastModified, set_DescriptiveText, set_DisplayName, set_LastModifier, set_Owner, set_Permissions, set_ProgId, set_ScriptText

Methods inherited from interface com.filenet.api.core.RepositoryObject

getObjectStore

Methods inherited from interface com.filenet.api.replication.Replicable

get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup

Methods inherited from interface com.filenet.api.core.Subscribable

raiseEvent

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject

fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

Methods inherited from interface com.filenet.api.core.EngineObject

get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

Method Detail

get_MimeType

java.lang.String get_MimeType()

Returns the value of the MimeType property. For more information, see MimeType Property.

set_MimeType

void set_MimeType(java.lang.String value)

Sets the value of the MimeType property. For more information, see MimeType Property.

changeClass

void changeClass(java.lang.String className)

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.
• Property constraints for the new class (for example, required values, choice lists, ranges) are not enforced.

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.

Changing the document class of a document object has no effect on the storage location of the document's content. For more information, see the Document Storage topic in the "Document Concepts" section of the Content Engine Java and .NET API Developer's Guide.

Parameters:

className - A String specifying the symbolic name, ClassNames constant, ID, or GUIDConstants constant of the class to which this object is to be changed.

Throws:

E_NULL_OR_INVALID_PARAM_VALUE - if className is null or has a length of zero.