public class BulkDeclarationFactory
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
static BulkDeclarationService |
getBulkDeclarationService(java.util.Map contextInfo)
Static method to return an instance of
BulkDeclarationService that
has been validated. |
static java.lang.String |
getVersion()
Returns the implementation version string as found in the JAR manifest.
|
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 . |
static ContentReference |
newContentReference(java.lang.String url,
java.lang.String mimeType)
Static method to return a new instance of
ContentReference . |
static ContentTransfer |
newContentTransfer(java.io.InputStream inputStream,
java.lang.String mimeType)
Static method to return a new instance of
ContentTransfer . |
static DocumentDefinition |
newDocumentDefinition(java.lang.String objectStoreIdent,
java.lang.String classIdent)
Static method to return a new instance of a
DocumentDefinition . |
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. |
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 . |
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 . |
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 . |
static PropertyValue |
newPropertyValue(java.lang.String symbolicName,
DataType dataType,
boolean multiValued)
Static method to return a new instance of a
PropertyValue . |
static RecordDefinition |
newRecordDefinition(java.lang.String objectStoreIdent,
java.lang.String classIdent)
Static method to return a new instance of a
RecordDefinition . |
public static BulkDeclarationService getBulkDeclarationService(java.util.Map contextInfo)
BulkDeclarationService
that
has been validated. Validation implies a connection to the underlying CE
server has been successfully established using the supplied
contextInfo
.contextInfo
- a Map
of connection context items, user credentials, etc.
See BaseBulkService.getContextInfo()
for details.BulkDeclarationService
.public static RecordDefinition newRecordDefinition(java.lang.String objectStoreIdent, java.lang.String classIdent)
RecordDefinition
.
A RecordDefinition
is used to provide all information necessary in
order to perform record declaration.objectStoreIdent
- String
Id or Name identifier of the containing
FilePlan ObjectStore.classIdent
- String
Id or Name of class to base record upon.RecordDefinition
instance.public static DocumentDefinition newDocumentDefinition(java.lang.String objectStoreIdent, java.lang.String classIdent)
DocumentDefinition
.
A DocumentDefinition
is used to provide all information necessary in
order to perform document committal.objectStoreIdent
- String
Id or Name identifier of the containing
Record ObjectStore.classIdent
- String
Id or Name of class to base document upon.DocumentDefinition
instance.public static PropertyValue newPropertyValue(java.lang.String symbolicName, DataType dataType, boolean multiValued)
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.symbolicName
- of the associated CE property.dataType
- DataType
of this instance.multiValued
- true
if this instance is multi-valued;
false
if is single-valued.PropertyValue
instance.public static PermissionValue newPermissionValue(int accessMask, int accessType, java.lang.String granteeName, int granteeType, int inheritableDepth)
PermissionValue
.
A PermissionValue
is used to define a single permission
to be stored on a document or record during committal or declaration.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.PermissionValue
instance.public static PermissionValue newPermissionValue(int accessMask, int accessType, java.lang.String granteeName, int granteeType, int inheritableDepth, int permissionSource)
PermissionValue
.
A PermissionValue
is used to define a single permission
to be stored on a document or record during committal or declaration.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.PermissionValue
instance.public static ObjectReference newObjectReference(java.lang.String objectStoreIdent, java.lang.String classIdent, java.lang.String objectIdent)
ObjectReference
.
An ObjectReference
is used to provide a reference to an existing CE
object for the value of an object-typed PropertyValue
.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.public static ContainerReference newContainerReference(java.lang.String objectStoreIdent, java.lang.String classIdent, java.lang.String containerIdent)
ContainerReference
.
An ContainerReference
is used to represent any type of document
or record container.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.public static ContentTransfer newContentTransfer(java.io.InputStream inputStream, java.lang.String mimeType)
ContentTransfer
.
ContentTransfer
is used to define a content element for a
DocumentDefinition
.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.ContentTransfer
instance.public static ContentReference newContentReference(java.lang.String url, java.lang.String mimeType)
ContentReference
.
ContentReference
is used to define a content element for a
DocumentDefinition
.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.ContentReference
instance.public static DocumentReference newDocumentReference(java.lang.String objectStoreIdent, java.lang.String classIdent, java.lang.String documentIdent)
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.
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.DocumentReference
instance.BulkDeclarationService.declareRecord(String, RecordDefinition, List)
public static java.lang.String getVersion()
String
containing version information.© Copyright IBM Corp. 2006, 2013. All Rights Reserved.