The following table lists the types derived from IReplicable .
Derived Types
Type | Description |
---|---|
IChoiceList | Represents a choice list in an object store. Each choice list contains a list collection of objects that, when associated with a property, provides a discrete set of possible values that the property can hold. By using a choice list, you can enforce restrictions on property values. There are two types of choice lists: integer and string. A choice list's type is specified by the following
constants, only and are valid constants for a object's property. A A choice list's display name is stored in its Choice list hierarchy is specified by its For a choice list to be useful, it must be associated with a property. You can either associate a choice list with a property template, therefore causing it to be automatically associated with every property definition created from that property template, or you can associate a choice list with an individual property definition. To associate a choice list with a property template or a property definition, set its To create a new |
IClassDefinition | Represents the class definition (mutable class metadata) of non-versionable, non-subscribable classes. Subclasses of the Subscribable class are defined in objects, except for the class and its subclasses, which are defined in objects, and the class and its subclasses, which are defined in objects. You can modify class definition metadata via its properties and property definitions throughout the life of an instantiated object. Note, however, that you cannot modify a class definition's property. |
ICodeModule | Represents a user-implemented Java event handler that executes when an To create an Note:
object must be of type , not . If you attempt to save an object with an type in the content element list, the object will throw an exception.
, such as by updating the event handler content, then you must set the new version to the CodeModule property of any -based object for which the new version is intended.To instantiate an As an alternative to representing a Java event handler as an For cache configuration considerations, see the applicable code module-related properties in the See also the Javadocs for the following interfaces: |
IDocumentClassDefinition | Represents the class definition (mutable class metadata) of the class and its subclasses. You can modify class definition metadata via its properties and property definitions throughout the life of an instantiated object. Note, however, that you cannot modify a class definition's property. |
IEventClassDefinition | Represents the class definition (mutable class metadata) of event classes whose instances can be subscribed to or audited. To instantiate a object, call the or method on the in a subscription or for auditing, set the property on a You can modify class definition metadata via its properties and property definitions throughout the life of an instantiated object. Note, however, that you cannot modify a class definition's |
IPropertyTemplate | Represents the base class for all property template classes. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
IPropertyTemplateBinary | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding binary values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
IPropertyTemplateBoolean | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding Boolean values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
IPropertyTemplateDateTime | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding DateTime values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
IPropertyTemplateFloat64 | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding Double (Float64) values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
IPropertyTemplateId | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding GUID string values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
IPropertyTemplateInteger32 | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding integer values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
IPropertyTemplateObject | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding Content Engine object values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
IPropertyTemplateString | Represents a property template for creating objects, which you can add to class definitions to create user-defined properties for holding string values. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values. |
IReplicableClassDefinition | Represents the class definition (mutable class metadata) of classes of which an object instance can be replicated. |
IStoragePolicy | Represents a subset of available storage areas that are deemed equivalent based on common, user-specified criteria. If a or object is set to use this , the Content Engine will assign a storage area from this subset (pseudo-randomly, to balance load). |
ISubscribableClassDefinition | Represents the class definition (mutable class metadata) of classes whose instances can be the target of a subscription and can be audited. objects hold the class definitions for all subclasses of the class except for the class and its subclasses, whose class definitions are held by objects. You can modify class definition metadata via its properties and property definitions throughout the life of an instantiated object. Note, however, that you cannot modify a class definition's property. |
IVersionableClassDefinition | Represents the parent of the class, which holds the class definition of a class and its subclasses. |
IXMLPropertyMappingScript | Represents the definition of a subclass for defining XML property mapping scripts. The Content Engine XML Classifier uses XML property mapping scripts to populate document object properties with values based on data extracted from an XML document’s content. Administrators build mapping scripts that associate XML tags in the incoming document to properties, thus enabling the automatic classification of any XML document. An object, in addition to having all of the capabilities of a object, provides a container for user-authored XSL scripts for transforming XML documents of a specified type. The script contains instructions for extracting content from source XML documents of the type identified by the property in order to map it onto property values for the properties associated with the target document class identified by the property. |
IAnnotation | Represents an annotation that can be applied to a document, folder, or custom object. An object allows you to link additional information to a containable object. You can modify and delete annotations independently of their annotated object. However, you cannot create versions of an annotation separately from the object with which it is associated. Document annotations are uniquely associated with a single document version; they are not versioned or carried forward when their document version is updated and a new version created. By design, an annotation is deleted whenever its associated parent object is deleted. Although an annotation receives its default security from both the annotation's class and parent object, you can apply security to an annotation that is different from the security applied to its parent. To create a new |
IComponentRelationship | Defines a hierarchical relationship between two documents as components in a compound document. One document is the designated parent component ( The two documents in a component relationship might be bound to each other as a result of that relationship. Document binding means the child component document exists in the child documents collection ( The two documents in a component relationship do not have to belong to the same object store. Also, these documents can continue to be used and referenced as individual documents, just as if they had never entered into a component relationship with each other. The parent component document determines security for each instance of this class. Users with write permission ( |
IContainmentRelationship | Models containment relationships. These can be either or objects. |
ICustomObject | Represents a general interface that can be subclassed. A object has no inherent semantics, but is independently securable and can be persisted to an object store. A does not carry content, is not versionable, and does not support lifecycle functionality. The |
IDocument | Represents a single version of a document stored in an object store. In addition to being versionable, a object can be subclassed and can carry content, which is stored in one or more content elements. Each content element represents content data, which can either be local to an object store (represented by a object) or external to an object store and therefore outside the control of the Content Engine server (represented by a object). In addition, a object can be associated with a document lifecycle policy. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken when a document's lifecycle state changes. |
IDynamicReferentialContainmentRelationship | Represents a dynamic relationship between two subclasses: a container and the current version of a . The object-valued and properties express the relationship. The tail always references a (the container), while the head references the current version of a . |
IFolder | Represents a container that can hold other subclasses, but cannot have content data of its own. Although objects and their subclasses can be referentially contained, they are the only Containable subclass that can be directly contained (in a ). All other subclasses are referentially contained using the or classes. Note: Folders that are referentially contained cannot participate in hierarchy index searches. The container hierarchy is a one-to-many relationship: a folder can have many child folders, but a child folder can have only one parent folder. At the top of the container hierarchy is an automatically-created root folder. Use Folders are not versionable. |
ILink | Represents a relationship between two objects. The object-valued and properties express the relationship. Use a Link object for many-to-many relationships between any objects, or for referential containment relationships between objects that are not instances of subclasses. Note: This is a weak link relationship: both the |
IReferentialContainmentRelationship | Represents a static relationship between two subclasses: a container and a containee. The object-valued and properties express the relationship. The tail always references a (the container), while the head references the containee: another subclass (such as another , a , or a ). When the head is a object, it represents a specific document version. |
IRelationship | Represents the base class for binary relationships between independently persistable objects of an object store. |
IWorkflowDefinition | Represents a workflow definition, an XML document of class "WorkflowDefinition" that is stored in a Content Engine object store. A workflow definition describes the instructions, paths, and queues available to a workflow, and acts as a processing template that the Process Engine uses each time the workflow runs. Workflow definition documents are versionable, containable, and can have a lifecycle associated with them. The To create a new After you create a workflow definition, you link it to an object that implements the To return all of the workflow subscription objects associated with this You can instantiate a
|
IAction | Represents an extensible, user-implemented action in response to an event triggered on a source object. This interface is the base for subinterfaces representing implemented actions to be taken for specific events, such as changing a document's lifecycle or deleting an object. The Content Engine Java API provides event handling interfaces that you must implement with the actions to be taken, coded as a Java module. You link an -based object to an implemented event handler by setting the property. If you check in the Java module to a Content Engine object store, you must set the property as well (see See also the Javadocs for the following interfaces: |
IActionConsumer | Represents the consumer of -based interfaces and . Generally speaking, objects enable user-implemented actions to execute when specified events fire on a specified Content Engine object. You can instantiate a persisted See also the help for the following interfaces: |
IClassSubscription | Represents a subscription for events generated by all objects of a particular class. The target for these subscriptions must be a class definition. To create a You can instantiate a persisted
|
IClassWorkflowSubscription | Represents a subscription that initiates a workflow in response to events generated by all objects of a particular class. A object provides object properties to link a workflow ( object and persist it. To create a You can instantiate a persisted
|
IDocumentClassificationAction | 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 interface. To specify the content type of the documents for which a object will apply, set the MimeType property. To specify the implemented Java classifier, set the ProgId property. Each object that you create and save in a given object store is automatically added to the object store's collection of objects. |
IDocumentLifecycleAction | Represents the actions to be taken when a document's lifecycle state is changed. A document's lifecycle states are defined in the collection of its associated object. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken when a document's lifecycle state changes. To change the lifecycle state of a document, call its method; you can change a document's current lifecycle state to another predefined state, set it to an exception state, or clear it from an exception state by specifying the appropriate constant in the parameter. To define the actions to take when a document’s lifecycle state is changed, write a Java handler class that implements the
Lastly, set the |
IDocumentLifecyclePolicy | Represents the lifecycle policy for a document. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken and which access permissions to be applied when a document's lifecycle state changes. To define the lifecycle states in a document lifecycle policy, create a |
IEventAction | Represents the actions taken when a subscribed event fires. You associate an event action with a property. To create an You can instantiate an
|
IInstanceSubscription | Represents a subscription for events generated by a single object instance of a particular class. To create a You can instantiate a persisted
|
IInstanceWorkflowSubscription | Represents a subscription that initiates a workflow in response to events generated by a single object instance. A object provides object properties to link a workflow ( object and persist it. To create a You can instantiate a persisted
|
ISubscription | Represents a request to execute an event action when an event is triggered on a target Content Engine object. For example, you can have a subscription that notifies you by email when documents of a certain class are created and saved in the object store. The specified object and persist it.
|
IWorkflowEventAction | Represents a definition of the actions taken when a workflow is initiated via an event that is subscribed to by a workflow subscription. To create a You can instantiate a
|
IPublishStyleTemplate | Represents the style template that defines how a source document will be transformed. A style template serves as a template for a particular kind of transformation and is tied to a specific publishing event handler on a specific object store. (Note that a publishing event handler can have more than one style template associated with it.) Information in the style template can be whatever is meaningful to the publishing event handler. For example, the style template might include an XML-based description of the transformation to be done for this style template, an ID of another document that contains a more detailed template, or a URL for publishing to an external location. A style template also specifies a list of input formats (MIME types) supported for the style template, the output format (MIME type) generated when the style template is applied, and, optionally, passwords used by PDF renditions. A publish style template associated with the HTML publishing event handler does not specify any additional transformation options beyond the basic ones (title, description, input formats, output format, and provider ID). In addition to the basic transformation options (as mentioned above for the HTML publishing event handler), a publish style template associated with the PDF publishing event handler optionally specifies the user and master PDF passwords, as well as other PDF security and watermark settings (stored as XML in the TransformationOptions property). |
IPublishTemplate | Represents a template for publishing a document. A publish template is an XML document that contains information used to automate the selection of options for a publishing request. For example, it contains the properties and security to apply to the destination document, and instructions for republishing a document, such as whether to version the existing destination document or replace it. Also, a publish template's StyleTemplate property might reference a object, which describes how the document is to be transformed. Because |
ISecurityPolicy | Represents an independently persistable, subclassable container for a list of security templates. Through an object's SecurityPolicy property, a object is associated with a , , or object, and subclasses of those objects. When you create an object of one of these types, you can optionally assign a object to it. If not explicitly assigned, the object's SecurityPolicy property is assigned a value provided by the class's default. The security policy defines the set of security templates that can be applied to the objects with which the policy is associated. The templates contained within a security policy can be one of two types: versioning or application templates. (For more information on security template types, see You can create an instance of a |