com.filenet.rm.bds.impl

Class BulkDeclarationFactory

  1. java.lang.Object
  2. extended bycom.filenet.rm.bds.impl.BulkDeclarationFactory

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

Method Summary

Modifier and Type Method and Description
  1. static
  2. BulkDeclarationService
getBulkDeclarationService(java.util.Map contextInfo)
Static method to return an instance of BulkDeclarationService that has been validated.
  1. static
  2. java.lang.String
getVersion()
Returns the implementation version string as found in the JAR manifest.
  1. static
  2. ContainerReference
newContainerReference(java.lang.String objectStoreIdent,java.lang.String classIdent,java.lang.String containerIdent)
Static method to return a new instance of a ContainerReference.
  1. static
  2. ContentReference
newContentReference(java.lang.String url,java.lang.String mimeType)
Static method to return a new instance of ContentReference.
  1. static
  2. ContentTransfer
newContentTransfer(java.io.InputStream inputStream,java.lang.String mimeType)
Static method to return a new instance of ContentTransfer.
  1. static
  2. DocumentDefinition
newDocumentDefinition(java.lang.String objectStoreIdent,java.lang.String classIdent)
Static method to return a new instance of a DocumentDefinition.
  1. static
  2. 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.
  1. static
  2. ObjectReference
newObjectReference(java.lang.String objectStoreIdent,java.lang.String classIdent,java.lang.String objectIdent)
Static method to return a new instance of an ObjectReference.
  1. static
  2. PermissionValue
newPermissionValue(int accessMask,int accessType,java.lang.String granteeName,int granteeType,int inheritableDepth)
Static method to return a new instance of a PermissionValue.
  1. static
  2. 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.
  1. static
  2. PropertyValue
newPropertyValue(java.lang.String symbolicName,DataType dataType,boolean multiValued)
Static method to return a new instance of a PropertyValue.
  1. static
  2. RecordDefinition
newRecordDefinition(java.lang.String objectStoreIdent,java.lang.String classIdent)
Static method to return a new instance of a RecordDefinition.
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBulkDeclarationService

  1. 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

  1. public static RecordDefinition newRecordDefinition( java.lang.String objectStoreIdent,
  2. 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

  1. public static DocumentDefinition newDocumentDefinition( java.lang.String objectStoreIdent,
  2. 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

  1. public static PropertyValue newPropertyValue( java.lang.String symbolicName,
  2. DataType dataType,
  3. 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

  1. public static PermissionValue newPermissionValue( int accessMask,
  2. int accessType,
  3. java.lang.String granteeName,
  4. int granteeType,
  5. 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

  1. public static PermissionValue newPermissionValue( int accessMask,
  2. int accessType,
  3. java.lang.String granteeName,
  4. int granteeType,
  5. int inheritableDepth,
  6. 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

  1. public static ObjectReference newObjectReference( java.lang.String objectStoreIdent,
  2. java.lang.String classIdent,
  3. 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

  1. public static ContainerReference newContainerReference( java.lang.String objectStoreIdent,
  2. java.lang.String classIdent,
  3. 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

  1. public static ContentTransfer newContentTransfer( java.io.InputStream inputStream,
  2. 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

  1. public static ContentReference newContentReference( java.lang.String url,
  2. 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

  1. public static DocumentReference newDocumentReference( java.lang.String objectStoreIdent,
  2. java.lang.String classIdent,
  3. 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:

getVersion

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