Package com.filenet.rm.bds

This package contains the majority of interfaces and classes that makeup the public API of the RM Bulk Declaration Service.

See: Description

  • Interface Summary 
    Interface Description
    BaseBulkService
    This base interface exposes the major public entry points offered by the Bulk Base Service.
    BaseDefinition
    This abstract interface definition represents the common methods belonging to both the RecordDefinition and DocumentDefinition interfaces.
    BatchResultItem
    This interface is used to represent the result of a single member operation that is executed using the BulkDeclarationService batching mechanism.
    BulkDeclarationService
    This interface exposes the major public entry points offered by the Bulk Declaration Service.
    BulkDisposeService
    This interface defines the major public entry points offered by the Bulk Dispose Service.
    Configuration
    This interface represents the collection of Bulk Declaration Service configuration items that are used to control its runtime behavior.
    ContainerReference
    This interface represents a container of either record or document objects.
    ContentElement
    This abstract interface represents a single content element for a document.
    ContentReference
    This interface represents URL-based document content.
    ContentTransfer
    This interface represents stream-based document content.
    DocumentDefinition
    This interface represents the definition of a single document to be committed.
    DocumentReference
    This interface represents an existing document/document version that is to be associated with a new record.
    ObjectReference
    The ObjectReference interface represents an existing CE object.
    PermissionValue
    This interface represents an individual CE security permission.
    PropertyValue
    This interface defines a value for a specified property that will apply to a new document or record object.
    RecordDefinition
    This interface represents the definition of a single record object that is to be declared on a FilePlan ObjectStore.
    Terminator
    This interface is used to get and set service termination flag.
  • Class Summary 
    Class Description
    BDSConstants
    Public constant definitions for Bulk Declaration Service.
    ConfigItemType
    ConfigItemType is an enumerated constant object class that defines the allowed Configuration collection item members.
    ConstantObject
    ConstantObject is the abstract base class for all enumerated type classes.
    DataType
    DataType is an enumerated constant object class that defines a set of allowed data types for PropertyValue and ConfigItemType.
    GUID
    This class encapsulates the concept of a GUID
    ResultItemStatus
    ResultItemStatus is an enumerated constant object class that defines the set of possible return values for the for the BatchResultItem.getResultStatus() method.

Package com.filenet.rm.bds Description

This package contains the majority of interfaces and classes that makeup the public API of the RM Bulk Declaration Service.

Included are the interfaces and classes needed to create a batch, to create operations to place into the batch and to request that the batch be executed. Additional interfaces and classes are used to describe the new documents and records to be created. These include items such as:

  • The ObjectStore class description to base a document or record upon.
  • Property and permission values to assign to each new document or record.
  • Content items to assign to a new document.
  • Specification of ObjectStore folders to file new documents into.
  • Specification of RM FilePlan locations to file new records into.

© Copyright IBM Corp. 2006, 2013. All Rights Reserved.