com.filenet.rm.bds.impl

Class BulkDeclarationFactory

  • java.lang.Object
    • com.filenet.rm.bds.impl.BulkDeclarationFactory


  • public class BulkDeclarationFactory
    extends java.lang.Object
    This factory class provides various static methods required to instantiate various interface implementations needed by the BDS API.
    • Method Detail

      • getBulkDeclarationService

        public static BulkDeclarationService getBulkDeclarationService(java.util.Map contextInfo)
        Static method to return an instance of BulkDeclarationService that has been validated. Validation implies a connection to the underlying CE server has been successfully established using the supplied contextInfo.
        Parameters:
        contextInfo - a Map of connection context items, user credentials, etc. See BaseBulkService.getContextInfo() for details.
        Returns:
        an instance of BulkDeclarationService.
      • newRecordDefinition

        public static RecordDefinition newRecordDefinition(java.lang.String objectStoreIdent,
                                           java.lang.String classIdent)
        Static method to return a new instance of a RecordDefinition. A RecordDefinition is used to provide all information necessary in order to perform record declaration.
        Parameters:
        objectStoreIdent - String Id or Name identifier of the containing FilePlan ObjectStore.
        classIdent - String Id or Name of class to base record upon.
        Returns:
        new RecordDefinition instance.
      • newDocumentDefinition

        public static DocumentDefinition newDocumentDefinition(java.lang.String objectStoreIdent,
                                               java.lang.String classIdent)
        Static method to return a new instance of a DocumentDefinition. A DocumentDefinition is used to provide all information necessary in order to perform document committal.
        Parameters:
        objectStoreIdent - String Id or Name identifier of the containing Record ObjectStore.
        classIdent - String Id or Name of class to base document upon.
        Returns:
        new DocumentDefinition instance.
      • newPropertyValue

        public static PropertyValue newPropertyValue(java.lang.String symbolicName,
                                     DataType dataType,
                                     boolean multiValued)
        Static method to return a new instance of a PropertyValue. A PropertyValue is used to provide the value for a specific property to be stored on a document or record during committal or declaration.
        Parameters:
        symbolicName - of the associated CE property.
        dataType - DataType of this instance.
        multiValued - true if this instance is multi-valued; false if is single-valued.
        Returns:
        new PropertyValue instance.
      • newPermissionValue

        public static PermissionValue newPermissionValue(int accessMask,
                                         int accessType,
                                         java.lang.String granteeName,
                                         int granteeType,
                                         int inheritableDepth)
        Static method to return a new instance of a PermissionValue. A PermissionValue is used to define a single permission to be stored on a document or record during committal or declaration.
        Parameters:
        accessMask - a bit-field integer representing the type of permission assigned to a user or group. See the various PermissionValue.RIGHT_x and PermissionValue.LEVEL_x constants for allowed values.
        accessType - defines if the access rights are to allow or deny for the given grantee. Either of the PermissionValue.TYPE_ALLOW or .TYPE_DENY constants.
        granteeName - User or Group name.
        granteeType - whether granteeName refers to a user or a group. See PermissionValue.GRANTEE_TYPE_x constants.
        inheritableDepth - defines the # of levels this permission can be inherited. See PermissionValue.INHERITABLE_DEPTH_x constants.
        Returns:
        new PermissionValue instance.
      • newPermissionValue

        public static PermissionValue newPermissionValue(int accessMask,
                                         int accessType,
                                         java.lang.String granteeName,
                                         int granteeType,
                                         int inheritableDepth,
                                         int permissionSource)
        Static method to return a new instance of a PermissionValue. A PermissionValue is used to define a single permission to be stored on a document or record during committal or declaration.
        Parameters:
        accessMask - a bit-field integer representing the type of permission assigned to a user or group. See the various PermissionValue.RIGHT_x and PermissionValue.LEVEL_x constants for allowed values.
        accessType - defines if the access rights are to allow or deny for the given grantee. Either of the PermissionValue.TYPE_ALLOW or .TYPE_DENY constants.
        granteeName - User or Group name.
        granteeType - whether granteeName refers to a user or a group. See PermissionValue.GRANTEE_TYPE_x constants.
        inheritableDepth - defines the # of levels this permission can be inherited. See PermissionValue.INHERITABLE_DEPTH_x constants.
        permissionSource - defines the source of this permission.
        Returns:
        new PermissionValue instance.
      • newObjectReference

        public static ObjectReference newObjectReference(java.lang.String objectStoreIdent,
                                         java.lang.String classIdent,
                                         java.lang.String objectIdent)
        Static method to return a new instance of an ObjectReference. An ObjectReference is used to provide a reference to an existing CE object for the value of an object-typed PropertyValue.
        Parameters:
        objectStoreIdent - String Id or Name identifier of the containing ObjectStore.
        classIdent - String Id or Name of object's class.
        objectIdent - String Id, Name or Path identifying the object.
        Returns:
        new instance.
      • newContainerReference

        public static ContainerReference newContainerReference(java.lang.String objectStoreIdent,
                                               java.lang.String classIdent,
                                               java.lang.String containerIdent)
        Static method to return a new instance of a ContainerReference. An ContainerReference is used to represent any type of document or record container.
        Parameters:
        objectStoreIdent - String Id or Name identifier of the containing ObjectStore.
        classIdent - String Id or Name of container's class.
        containerIdent - String Id, Name or Path identifying the container.
        Returns:
        new instance.
      • newContentTransfer

        public static ContentTransfer newContentTransfer(java.io.InputStream inputStream,
                                         java.lang.String mimeType)
        Static method to return a new instance of ContentTransfer. ContentTransfer is used to define a content element for a DocumentDefinition.
        Parameters:
        inputStream - an InputStream representing the binary content. Cannot be null.
        mimeType - The MimeType value for the associated content defined by the url. Cannot be null nor empty.
        Returns:
        new ContentTransfer instance.
      • newContentReference

        public static ContentReference newContentReference(java.lang.String url,
                                           java.lang.String mimeType)
        Static method to return a new instance of ContentReference. ContentReference is used to define a content element for a DocumentDefinition.
        Parameters:
        url - The url String that defines this content. Cannot be null nor empty.
        mimeType - The MimeType value for the associated content defined by the url. Cannot be null nor empty.
        Returns:
        new ContentReference instance.
      • newDocumentReference

        public static DocumentReference newDocumentReference(java.lang.String objectStoreIdent,
                                             java.lang.String classIdent,
                                             java.lang.String documentIdent)
        Static method to return a new instance of DocumentReference that references an existing CE document or document version.

        This type of DocumentReference is used to establish the relationship between an existing document or document version and its associated electronic record during a declare operation.

        Parameters:
        objectStoreIdent - String Id or Name identifier of the containing ObjectStore.
        classIdent - String Id or Name of document's class.
        documentIdent - String Id or Path identifying the document.
        Returns:
        new DocumentReference instance.
        See Also:
        BulkDeclarationService.declareRecord(String, RecordDefinition, List)
      • getVersion

        public static java.lang.String getVersion()
        Returns the implementation version string as found in the JAR manifest.
        Returns:
        String containing version information.

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