All Classes and Interfaces
Class
Description
An exception that occurs when operating on a IDfACL instance.
Using this class, the client application can pass information along with the query.
Signals a problem with authentication of an identity.
An implementation of the IDfClient interface for use in a basic Java environment.
This exception is thrown in case of a possible configuration issue of the ECIS adpaters when doing a search.
This exception is thrown when content has not been stored in a docbase yet.
An unexpected DFC runtime exception.
This exception is used to indicate that the DBOR was not found
An exception thrown when someone tries to access data beyond the end of a collection.
The base class for all DFC checked exceptions.
Factory to create search expressions
Abstract visitor used to visit an IDfExpression.
This class define a facet to be computed by the search service.
Define the order of the facet value in the returned facets.
Factory to create facets and facet values.
An exception raised by a filter.
Type of error
Empty implementation of IDfQueryListener.
A Documentum object identifier.
This exception is thrown when a specific docbase does not have an identity.
Thrown when a requested Docbase object can not be found.
Signals that an I/O exception of some sort has occurred while communicating with the docbase.
A DfLogger object is used to log messages for a specific system or application component.
Thrown when a requested Docbase object can not be found.
Thrown when a qualification failed to match an object.
Thrown when a requested Docbase object can not be found.
Thrown when a requested Docbase object can not be found.
An exception that occurs when operating on a IDfTypedObject instance.
An exception that signals a problem with principal authentication.
This exception is thrown when format of a stored query cannot be recognized.
This exception is thrown when unexpected condition is discovered during query generation process.
Thrown to indicate that the object, attribute or type is read-only (can not be modified).
Signals a restricted session.
This exception is thrown during the retrieval of a result content.
Factory to create IDfResultEntry.
An unexpected DFC runtime exception.
DfScopingException class.
This exception is a base exception for the
com.documentum.fc.client.search package.This exception is thrown when credentials are invalid.
The superclass for all service-based business objects.
This exception is no longer used.
This class provides error information.
This exception is thrown when a Business Object Service is not properly configured in DBOR (Documentum Business
Object registry) and the Java class cannot be instantiated.
This exception is thrown when a Business Object Service is not configured in DBOR (Documentum Business Object
registry).
Thrown when the session referenced by a handle no longer exists.
An exception that occurs when operating on a IDfSysObject instance.
An implementation of the IDfTime interface.
An exception that occurs when operating on a IDfTypedObject instance.
This exception is thrown when the target location is unreachable.
DfValidationException will be thrown when a validation rule is violated.
DfValidationException will be thrown when a validation rule is violated
Exceptions that occur when operating on workflow runtime objects including IDfWorkflow, IDfWorkitem, IDfPackage
Provides access to permission-related data stored in ACL objects.
This interface provides ACS-related functionality.
This interface represents ACS configuration objects.
ProjectionEntry interface encapsulates projection target parameters.
StoreEntry interface encapsulates store type, encryption mode, and compression mode.
UrlEntry interface encapsulates base url and protocol.
Provides ACS content request related data.
Provides ACS request-related data.
Provides methods to set preferences for accelerated content transfer operations.
This interface provides functions to access objects of dm_activity type.
An extension of
IDfClient that is useful for administrative programs.Provides access to business policy aliasing-related data stored in dm_alias_set objects.
This interface provides access to permission-related data stored in ACL objects.
Interface providing aspect operations
This class provides the functionality to interact with dm_assembly objects in the repository.
Callback interface for use with #IDfAspects.attachAspect.
This interface provides access to the following information about
attributes: name, length, type and whether an attribute is repeating.
Defines a base interface for the attribute search expression.
Describes the properties unique to an attribute value transition condition.
The Documentum server can log the occurrence of a predefined set of events to the audit trail.
This interface describes the batch group object used in batch inserts.
This interface provides the functionality for insert batching.
This interface represents BOCS configuration object.
ExternalUrlEntry interface encapsulates external url.
UrlEntry interface encapsulates base url and protocol.
A standard administrative interface that all BOF objects must implement.
Represents a node in a cancel checkout operation.
The cancel checkout operation releases the Docbase lock, deletes the local content file,
and removes registry entries for each node in the operation.
This class is used to maintain information about change description records.
Represents registry information for a checked out object.
Represents a node in a check in operation.
IDfCheckinOperation performs a complete client checkin of one or more nodes.
Represents an object in a checkout operation.
The checkout operation obtains a repository lock, downloads the local content file,
patches compound references (for example, XML external entity references),
and creates registry entries for each node in the operation.
This interface provides functionality to establish and manage sessions with a Documentum server, and provides
information about the server before a session is established.
IDfClientRegistry manages repository object information stored on the local
system rather than in the repository server.
IDfClientRegistryObject is the common base interface for objects written
to the client registry.
An interface that provides factory methods and methods to facilitate DFC access through COM.
This interface provides access to collection objects.
A filter implements this interface to be notify of the query completion.
Provides the functionality to interact with dmr_containment objects in the repository.
IDfContentAvailability
IDfContentTransferCapability
Only DFC is allowed to implement this interface.
Distributed transfer config object
Context for filters.
Represents one object in a copy operation.
IDfCopyOperation performs a copy of one or more nodes.
Used to manage the Documentum Business Objects Registry (DBOR),
provide methods to register and unregister business objects,
and to look up registered business object entries in DBOR.
Allows you to define service properties for DBOR.
Represents an object in a delete operation.
The delete operation destroys specified versions for each object in the operation.
Callback interface for use with #IDfAspects.detachAspect.
Dms config object
This interface provides information about the repositories known to a connection broker.
An interface for interacting with connection brokers for the purpose of obtaining lists of repositories and repository servers.
Provides the functionality for the client to interact with "dm_document" objects in the respository.
Interface for getting and setting values for dm_dump_record objects.
Provides a wrapper for a java.util.Enumeration so that it may be used across COM.
During batch insert, mulitple events would be written into one queue item if oneEventPerBatch were specified.
An interface to all DFC checked exceptions.
Represents a node in an export operation.
The export operation downloads the local content file,
patches compound references (for example, XML external entity references),
and optionally creates registry entries for each node in the operation.
Defines a search expression.
Defines a specific expression within a searched source.
Defines a set of search expressions.
Represents a facet that has been computed by the Indexer.
A filter can implement this interface to transform facets.
Represents a facet value.
DfFile encapsulates a file specification.
Implementing this interface allow a filter to provide execution order information.
This interface provides access to folder-related data stored in folder objects.
Provides access to format information.
IDfFormatRecognizer scans a file's content to make suggestions
on what repository formats might be appropriate for the file.
This interface provides functionality for retrieving fulltext configuration
information that is associated with a docbase.
Represents the capabilities that can be passed to isCapabilitySupported()
Represents the possible engine values returned by getEngine()
Defines a full-text expression for the search expression tree.
Provide context about the generation of the query.
This interface encapsulates options to get an object from the repository.
This interface provides access to group-related data stored in group objects.
A Documentum object identifier.
Represents an object in an import operation.
IDfImportOperation performs a complete client import of one or more nodes.
An interface for passing an InputStream to the operations package.
Interface for a Java method implementing a system-defined action to be taken on entering
a lifecycle state.
Interface for a Java method implementing user defined actions to be taken on entering
a Lifecycle state.
Interface for a Java method implementing user defined entry criteria for a Lifecycle.
Interface for a Java method implementing user defined actions to be taken after
an object has changed Lifecycle state.
Interface for a Java method implementing user defined validation on a Lifecycle
before it can be installed.
Provides access to lightobject related functionality.
This interface provides functionality that encapsulates Vector operations.
Interface for getting and setting values for dm_load_record objects.
IDfLocalObject represents a Desktop Client local file.
This is a marked interface to represent a local transaction.
This interface provides access to location properties.
Defines a specific location within a searched source.
Encapsulates the information needed to validate and login a user to a repository.
This is the interface that is used to plug in different Application Servers'
MBeans with DFC for registering PreferencesMBean with custom MBeanServers.
Defines a more-like-this expression for the search expression tree with the given object id.
A modifiable facet.
A modifiable facet value.
Represents a single result entry from a query execution and defines the methods necessary to modify
and manipulate it.
Represents a list of results and defines the methods necessary to modify and manipulate it.
This interface provides access to mount point-related data stored in dm_mount_point objects.
Represents an object in a move operation.
IDfMoveOperation performs a move of one or more nodes from one source folder to a destination folder.
Represents a mechanism that supports the creation of nodes that an operation is applied against.
This interface provides access to other interfaces that can be used for creating or
building a node tree.
An edge that represents the relationship between a parent IDfOperationNode and a child IDfOperationNode.
This class provides the functionality for the client to interact with "dm_sysobject" objects in the repository.
Representation of user-accessible path to a given object.
A map where the key are objects id and the values are an enumeration of the path where the object is located.
IDfOperation is the base class for all library service operations.
Provides a mechanism for specifying additional contextual information for instantiating a context aware operation.
Stores information about an error detected during operation execution.
Provides access to operation errors as they occur.
Represents a node in an operation.
A factory object used by populators to create a node or an edge for given objects.
Responsible for iterating through a list of populators for building and managing the node tree for the operation.
Represents a step in a multi-step operation.
Interface used to express a sorting constraint on query results.
Interface definition for the type DmiPackage
Description: This object cannot be saved.
the pair interface
Defines a specific partition within a searched source.
Provides a container for passing a query string directly to the search source.
Configures criteria factors for the IPR algorithm (Incremental Perceptual Ranking).
This class provides the interface for defining and viewing security permits applied to documents and ACLs.
Constant definitions for types of permits used with
IDfPermit.Constant String definitions for types of permits used with
IDfPermit.A Documentum object that has typed attributes and is persisted in a repository.
This interface provides access to plugin-related data stored in dm_plugin objects.
Interface for lifecycles.
A predicate is an object which evaluates a boolean condition given some runtime state.
Represents a node in a predictive caching operation.
The predictive caching operation generates content pre-caching BOCS URLs
and sends URLs to BOCS.
An interface supported by classes that can establish sessions using principal-mode authentication.
Methods you use to create and manipulate process objects, the objects that store workflow definitions in the
repository.
This interface provides functionality for manipulating values in a hashable.
This interface provides functionality for running queries against
a repository.
This is a primary interface for building a query that can be executed against sources of different type.
This is a base interface for the query that can be executed by the
IDfQueryProcessor.Provides status information about the execution of a query.
A filter that can transform a query
Has to be implemented by an IDfQueryProcessor client to be asynchronously
notified of new results and events during the query execution.
Provides factory methods for query and interfaces for persistent query management.
Manages the execution of a query accross multiple sources.
This is a base interface for the query scope.
Represents the status of a search execution at a given point in time.
This interface contains the functionality to retrieve information
from a dmi_queue_item object.
Interface definition for the type dm_relation
Description:
Interface definition for the type dm_relation_type.
Defines an expression on a date that is relative to the actual date when the query is executed.
Author: AlexO
Date: Jun 19, 2006
Time: 3:40:37 PM
Represents the actual content corresponding to a result.
Represents a single result entry from a query execution.
A filter that can transform search results.
Defines an interface for the metadata highlight in search results.
Manages result content access.
Rates results depending on their relevancy to a query definition.
Configures factors used by raters when computing results rating.
Creates ResultRater instances.
Performs manipulation of results.
Represents a list of results.
Provides access to dm_retainer objects, used for defining retention applied
to SysObjects.
Defines the way in which disposition rules are enforced.
Defines the way in which retention protection rules are enforced.
This class provides calls to create dmRetainer objects.
Defines updateability rules for objects under retention.
Defines how retention applies to the content of an object under retention control.
Defines possible retainer strategy values for the IDfRetainer class.
Defines the retention rule type for the IDfRetainer class.
This class provides access to retention operations.
Defines the possible status values of an IDfRetainer object.
Deprecated.
This interface provides operations that can be used by a search routine.
Provides a facade to search metadata.
This interface defines the set of operations available for a search
Represents the search results.
This interface is the factory for search objects.
Represents a source for executing a query.
Base interface for the classes that manage a list of selected sources.
Provides a facade to search source discovery.
Provides access to services for search storage.
Provides a facade to search metadata for a given value.
Constants for specifying the root location of a
IDfContentCollection.seek(int, int) operation.Provides information about known Docbase Servers.
Parent interface for all service-based business objects.
This interface encapsulates a session with a Documentum repository.
Manages identities, pooled sessions and transactions.
Allows a client to subscribe to major Session Manager events
Provides statistics and status related to a session manager instance.
Defines a simple search expression on an attribute.
An IDfSmartList is the BOF object representing a saved search.
Defines a smart list.
Represents the status of a query for a specific source.
Interface for policy state extensions.
A customization implements this interface to provide a non node-specific action
such as housekeeping, cleaning the registry, etc.
This class provides the functionality for the client to interact with "dm_sysobject" objects in the repository.
This class provides access to the retention operations of the IDfSysobject class.
This class provides access to the any new public stream/content related api's for the IDfSysobject class.
The IDfTime interface provides functionality for returning information in a time object.
Describes the properties common to all transition conditions.
An interface for obtaining Content server trust credentials.
This interface provides access to type-related data stored in type objects.
Public operations for all typed objects.
This interface provides access to user-related data stored in user objects.
Represents an object in an XML Validation operation.
Represents XML Validation operation.
Interface that provides the data validation functionality.
This interface provides functionality for retrieving values stored in value objects.
Interface to provide information about the value assistance of
an attribute, given the set of attribute name/value pairs of its depending
attributes.
Defines a search expression that requires the attribute value to be included in a list of values.
Defines a search expression that requires the attribute value to be greater than a minimum value and less than a
maximum value (or equal).
This interface provides functionality used to manage
hierarchy numbers for virtual documents displayed in the
Virtual Document Manager.
This class is used to enumerate the possible values of
implicit and symbolic version labels for a SysObject.
This interface provides version-related information about SysObjects.
This interface provides information about the version tree of a SysObject.
IDfViewedObject represents an object that has been "viewed" in the repository.
This class contains the functionality to manage virtual documents.
This interface provides access to the nodes in a
virtual document tree displayed in the Virtual Document Manager.
This interface provides methods that allow you to create, start, and
manage a workflow.
Interface definition for the type DmiWFAttachment.
This interface provides methods to help start a workflow.
This interface contains the methods to manage work items, the runtime objects
that represent the tasks associated with activity instances in a workflow.
IDfXMLDoctype provides access to XML document information such as DTD system identifier,
schemaLocation, and root element name.
This interface provides functionality for running queries against
a repository, returning the results as XML.
Represents a node in an XML transformation operation.
Provides for XSLT transformations on XML objects in the Docbase.
Collection of XML related utility methods.
Describes the properties unique to an XPath transition condition.
This interface adds namespace state to the definition of an XPath condition.
This interface provides functionality for running XQueries against
a repository, returning the results as a XML DOM or byte stream.
These options are used when executing the xquery against a target of IDfXQueryTargets.DF_FULLTEXT.
Specifies the type of the FtQueryOption
Deprecated.
The preferred way is now to deploy the full-text mapping file directly in the Docbase in folder
/System/Search/EOS
This is a marker interface used by Messaging App code to extend inbound/outbound DFC operation related settings
like enable/disable attachments and specifying object type for attachments.
This interface provides methods for evaluating storage policy rules
This operator can be set on a IDfExpressionSet object.