com.filenet.rm.api
Interface RMRecordContainer
- public interface RMRecordContainer
- extends RMFolder
RecordCategory
,
RecordFolder
, and Volume
. The RMRecordContainer
interface defines the
generic declaration and validation methods that are used by these interfaces.
Field Summary
Fields inherited from interface com.filenet.rm.api.RMObject |
---|
AGGREGATION_RECORD, AGGREGATION_RECORD_CATEGORY, AGGREGATION_RECORD_FOLDER, AGGREGATION_VOLUME, CLEAR_INHERITED_CHILDREN, INHERIT_IMMEDIATE_CHILDREN, INHERITED_CHILDREN, NON_INHERITED_CHILDREN, WORK_FLOW_STATUS_COMPLETED, WORK_FLOW_STATUS_NOT_STARTED, WORK_FLOW_STATUS_STARTED |
Fields inherited from interface com.filenet.wcm.api.BaseObject |
---|
EXPORT_DEFAULT, EXPORT_ENCODED_CONTENT, EXPORT_FULL, EXPORT_OBJECT_ID, EXPORT_OBJECT_SECURITY, IMPORT_DEFAULT, IMPORT_OBJECT_ID, IMPORT_OWNER, IMPORT_PERMISSIONS, TYPE_ACTIVE_MARKING, TYPE_ANNOTATION, TYPE_ANY, TYPE_AUDIT_DEFINITION, TYPE_CBR_ENGINE_TYPE, TYPE_CHOICE, TYPE_CHOICELIST, TYPE_CLASS_SUBSCRIPTION, TYPE_CLASSDEFINITION, TYPE_CLASSDESCRIPTION, TYPE_COLUMN_DEFINITION, TYPE_COMPUTER, TYPE_CONTENT_CACHE_SERVICE, TYPE_CONTENT_MGR_SERVICE, TYPE_CONTENT_REFERENCE, TYPE_CONTENT_TRANSFER, TYPE_CUSTOMOBJECT, TYPE_DOCUMENT, TYPE_DOCUMENT_CLASSIFICATION_ACTION, TYPE_DOCUMENT_LIFECYCLE_ACTION, TYPE_DOCUMENT_LIFECYCLE_POLICY, TYPE_DOCUMENTSTATE, TYPE_DOMAIN, TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_ENTIRENETWORK, TYPE_EVENT, TYPE_EVENT_ACTION, TYPE_FEATURE_ADD_ON, TYPE_FILESTORE, TYPE_FOLDER, TYPE_GROUP, TYPE_INSTANCE_SUBSCRIPTION, TYPE_LINK, TYPE_LOCALIZED_STRING, TYPE_MARKING_SET, TYPE_MULTIPLEVALUES, TYPE_OBJECT_STORE, TYPE_OBJECTSET, TYPE_OBJSTORE_SERVICE, TYPE_PERMISSION, TYPE_PROPERTY_DEFINITION, TYPE_PROPERTYDESCRIPTION, TYPE_PROPERTYDESCRIPTIONS, TYPE_PUBLISH_REQUEST, TYPE_PUBLISH_TEMPLATE, TYPE_READONLY_OBJECT_SET, TYPE_REALM, TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_SECURITY_POLICY, TYPE_SECURITY_TEMPLATE, TYPE_STORAGE_POLICY, TYPE_STORED_SEARCH, TYPE_STYLE_TEMPLATE, TYPE_SUBSCRIBED_EVENT, TYPE_SUBSCRIPTION, TYPE_TABLE_DEFINITION, TYPE_TRANSIENT, TYPE_USER, TYPE_VERSIONSERIES, TYPE_WORKFLOW_CLASS_SUBSCRIPTION, TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION, TYPE_WORKFLOWDEFINITION, TYPE_XML_PROPERTY_MAPPING_SCRIPT |
Method Summary
Modifier and Type | Method and Description |
---|---|
|
canDeclare(java.lang.String asURL,java.lang.String[] asArrVersion)
Verifies whether the specified documents or versions of a document can be declared as records
in this container object.
|
|
clearDispositionSchedule(int aiClearSchedule)
Clears the disposition schedule and disposition data from this container object and,
optionally, from its children.
|
declare(DocumentStore aoDocumentStore,java.lang.String[] asDocumentsID,RMFolder[] aoFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname)
Declares the specified documents as a single record and files the new record in the specified folders.
|
|
declare(DocumentStore aoDocumentStore,java.lang.String[] asDocumentsID,RMFolder[] aoFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,boolean abValidate)
Declares the specified documents as a single record and files the new record in the specified folders.
|
|
declare(java.lang.String asURL,java.lang.String[] asVersion,RMFolder[] aoFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname)
Declares the versions of the specified document as a single record and files the new record in
the specified folders.
|
|
declare(java.lang.String asURL,java.lang.String[] asVersion,RMFolder[] aoFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,boolean abValidate)
Declares the versions of the specified document as a single record and files the new record in
the specified folders.
|
|
declareAllVersions(DocumentStore aoDocumentStore,java.lang.String asArrDocumentsID,boolean abAllVersion,RMFolder[] aoArrFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,java.util.Map aoError)
Declares all versions of the specified documents as either a single record or as separate records,
and files the record or records in the specified folders.
|
|
declareAllVersions(DocumentStore aoDocumentStore,java.lang.String asArrDocumentsID,boolean abAllVersion,RMFolder[] aoArrFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,java.util.Map aoError,boolean abValidate)
Declares all versions of the specified documents as either a single record or as separate records,
and files the record or records in the specified folders.
|
|
declareAllVersions(java.lang.String asURL,boolean abAllVersion,RMFolder[] aoFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,java.util.Map aoErrorMap)
Declares all versions of the documents specified by the
asURL parameter as either a single record or as separate records,
and files the record or records in the specified folders.
|
|
declareAllVersions(java.lang.String asURL,boolean abAllVersion,RMFolder[] aoFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,java.util.Map aoErrorMap,boolean abValidate)
Declares all versions of the documents specified by the
asURL parameter as either a single record or as separate records,
and files the record or records in the specified folders.
|
|
declareAndClassify(DocumentStore aoDocumentStore,java.lang.String[] asArrDocumentsID,RMFolder[] aoArrFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,boolean abValidate)
Declares the specified document as a record with the security classification specified in the
aoRecordProps parameter.
|
|
declareAndClassify(java.lang.String asURL,java.lang.String[] asArrVersion,RMFolder[] aoArrFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,boolean abValidate)
Declares the specified document as a record with the security classification specified in the
aoRecordProps parameter.
|
|
|
delete(boolean abSave,java.lang.String asReasonForDelete)
Deletes this container object provided there is no constraint, such as the object
being on hold, that prevents the object from being deleted.
|
|
getPatternBaseName(int aiEntityType)
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
|
|
getPatternBaseName(int aiEntityType,com.filenet.wcm.api.Properties aoProperties)
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
|
|
getPatternBaseName(int aiEntityType,com.filenet.wcm.api.Properties aoProperties,java.lang.StringBuffer moEntityNameOrId)
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
|
|
getPatternBaseName(int aiEntityType,java.lang.StringBuffer moEntityNameOrId)
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
|
|
setProperties(com.filenet.wcm.api.Properties aoProperties,boolean abFlag)
Sets the properties of this container object to the specified values and, optionally, resets the
RECALCULATE_PHASE_RETENTION property if a sweep has reset the cutOff data
for the object.
|
|
validateCloseProperty(java.util.Date aoDateClosed,java.lang.String asReasonForClose)
Verifies that the ReasonForClose property specified for this container object is not
null
or empty.
|
|
validateInactiveProperty(boolean abIsInActive,java.lang.String asReasonForInactivate)
Verifies that the ReasonForInactivate property specified for this container object is not
null
or empty.
|
Methods inherited from interface com.filenet.rm.api.RMFolder |
---|
getAllAllowedContaineeType, getAllAllowedContaineeType, getAllowedContainee, getAllowedContaineeType, getContainees, getContaineesXML, getDeletedObjects, getDeletedObjectsIds, getFolderType, getLevel, getPattern, isMinimumMetadataRetained |
Methods inherited from interface com.filenet.rm.api.RMObject |
---|
getObjectStore, getRMDeclassificationOffset, getRMEntityType, getRMImplementationType, registerExternalEvent, setState |
Methods inherited from interface com.filenet.wcm.api.Folder |
---|
addSubFolder, addSubFolder, applySecurityTemplate, changeClass, delete, getContainees, getContainees, getContainees, getContainees, getContainees, getContainees, getContaineesXML, getContaineesXML, getHeadLinks, getHeadLinksXML, getParentFolder, getParentFolderXML, getPermissionsXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, move, raiseEvent |
Methods inherited from interface com.filenet.wcm.api.WorkflowTarget |
---|
getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML |
Methods inherited from interface com.filenet.wcm.api.WriteableSecurityObject |
---|
setPermissions, setPermissions |
Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject |
---|
setProperties |
Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject |
---|
getAccessMask, getPermissions, getPermissions |
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject |
---|
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh |
Methods inherited from interface com.filenet.wcm.api.BaseObject |
---|
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject |
Methods inherited from interface com.filenet.wcm.api.LockableObject |
---|
extendLock, extendLock, isLocked, lock, unlock, unlock |
Method Detail
canDeclare
- boolean canDeclare(java.lang.String asURL,
- java.lang.String[] asArrVersion)
- throws RMException
asURL
- A String
that contains either the URL for a single document to be
verified or a comma-separated list of the URLs for multiple documents to be verified. This parameter
cannot be null
or empty. asArrVersion
- A String
array that specifies the versions of a single
document that are to be verified. If this parameter is set to null
and the asURL
parameter contains a single URL, the method verifies only the version at that URL. If the
the asURL
parameter contains multiple URLs, this parameter
must be set to null
. true
if all specified documents and versions can be declared as records.
Returns false
if any document or version cannot be declared as a record. RMException
- If a Records Manager error occurs. declare
- RecordInfo declare(DocumentStore aoDocumentStore,
- java.lang.String[] asDocumentsID,
- RMFolder[] aoFolder,
- com.filenet.wcm.api.Properties aoRecordProps,
- java.lang.String asRecordInfoClassID,
- com.filenet.wcm.api.Permissions aoRecordACLs,
- boolean abAutoname)
- throws RMException
The asDocumentsID
parameter identifies the documents that are to be declared as records.
The aoDocumentStore
parameter identifies the document store in which these documents
are located.
This method files the new record in the folders specified by the aoFolder
parameter.
If a record cannot be filed in a folder, the method cancels the declare operation and removes the record
from any folders in which it was already filed.
The new record inherits the security settings of the folder in which it is filed and, in turn, the documents inherits the security settings from the record. If the record is filed in multiple folders, the record inherits the security settings of the parent folder.
To have this method generate a name for the new record automatically, set the
abAutoname
parameter to true
.
To use the auto-naming feature, you must first register the AutoName implementation class
with the application by calling the registerAutoName
method on an RMDriverManager
object. If the AutoName implementation class is not registered,
the declare
method throws an exception.
aoDocumentStore
- A DocumentStore
object that represents the document store
in which the documents to be declared as record are located. asDocumentsID
- A String
array that contains the IDs of the documents to be
declared as record. aoFolder
- An RMFolder
array that identifies the folders in which the new record is
to be filed. This parameter is optional. aoRecordProps
- A Properties
collection that specifies the property values
for the new record. asRecordInfoClassID
- A String
that specifies the type of record to be created.
The record can be an instance of one of the following classes or their subclasses:
ElectronicRecordInfo
, Marker
, EmailRecordInfo
.
This parameter cannot be null
or empty. aoRecordACLs
- A Permissions
collection that specifies the access values
for the new record. abAutoname
- A boolean
value that indicates whether the Records Manager API
is to generate the name for the new record using the registered auto-naming implementation class. Set
this parameter to true
to generate the record name automatically. Set this parameter
to false
to use the DOCUMENT TITLE metadata value as the record name. RecordInfo
object. RMException
- If a Records Manager error occurs. declare
- RecordInfo declare(DocumentStore aoDocumentStore,
- java.lang.String[] asDocumentsID,
- RMFolder[] aoFolder,
- com.filenet.wcm.api.Properties aoRecordProps,
- java.lang.String asRecordInfoClassID,
- com.filenet.wcm.api.Permissions aoRecordACLs,
- boolean abAutoname,
- boolean abValidate)
- throws RMException
The asDocumentsID
parameter identifies the documents that are to be declared as records.
The aoDocumentStore
parameter identifies the document store in which these documents
are located.
This method files the new record in the folders specified by the aoFolder
parameter.
If a record cannot be filed in a folder, the method cancels the declare operation and removes the record
from any folders in which it was already filed.
The new record inherits the security settings of the folder in which it is filed and, in turn, the documents represented by this record inherit their security settings from the record. If the record is filed in multiple folders, the record inherits the security settings of the parent folder.
To have the Records Manager API generate the name for the new record automatically, set the
abAutoname
parameter to true
.
To use the auto-naming feature, you must first register the AutoName implementation class
with the application by calling the registerAutoName
method on an RMDriverManager
object. If the AutoName implementation class is not registered,
the declare
method throws an exception.
aoDocumentStore
- A DocumentStore
object that represents the document store in
which the documents to be declared as record are located. asDocumentsID
- A String
array that contains the IDs of the documents to be
declared as record. aoFolder
- An RMFolder
array that identifies the folders in which the new record is to
be filed. This parameter is optional. aoRecordProps
- A Properties
collection that specifies the property values for the
new record. asRecordInfoClassID
- A String
that specifies the type of record to be created.
The record can be an instance of one of the following classes or their subclasses:
ElectronicRecordInfo
, Marker
, EmailRecordInfo
.
This parameter cannot be null
or empty. aoRecordACLs
- A Permissions
collection that specifies the access values for
the new record. abAutoname
- A boolean
value that indicates whether the Records Manager API is to
generate the name for the new record using the registered auto-naming implementation class. Set this parameter
to true
to generate the record name automatically. Set this parameter to false
to use the DOCUMENT TITLE metadata value as the record name. abValidate
- A boolean
value that indicates whether the Records Manager API is to
verify that the folders in which the new record is to be filed are open and active. Set this parameter
to true
to verify the state of the folders. RecordInfo
object. RMException
- If a Records Manager error occurs. declare
- RecordInfo declare(java.lang.String asURL,
- java.lang.String[] asVersion,
- RMFolder[] aoFolder,
- com.filenet.wcm.api.Properties aoRecordProps,
- java.lang.String asRecordInfoClassID,
- com.filenet.wcm.api.Permissions aoRecordACLs,
- boolean abAutoname)
- throws RMException
The asURL
parameter identifies the document that is to be declared as a record.
The asVersion
parameter identifies the specific versions of that document
that are to be included in the record. If this parameter
is null or empty, this method declares only latest version is declared as a record.
This method files the new record in the folders specified by the aoFolder
parameter.
If a record cannot be filed in a folder, the method cancels the declare operation and removes the record
from any folders in which it was already filed.
The new record inherits the security settings of the folder in which it is filed and, in turn, the documents represented by this record inherit their security settings from the record. If the record is filed in multiple folders, the record inherits the security settings of the parent folder.
To have this method generate the name for the new record automatically, set the
abAutoname
parameter to true
.
To use the auto-naming feature, you must first register the AutoName implementation class
with the application by calling the registerAutoName
method on an RMDriverManager
object. If the AutoName implementation class is not registered,
the declare
method throws an exception.
asURL
- A String
that identifies the Document URL of the document to be declared
as a record. This parameter cannot be null
or empty. asVersion
- A String
array that contains the numbers of the versions of the
document that are to be declared as record. If this array contains null
or empty values,
only the latest version of the document is declared a record. aoFolder
- An RMFolder
array that identifies the folders in which the new record is to
be filed. This parameter is optional. aoRecordProps
- A Properties
collection that specifies the property values for the
new record. asRecordInfoClassID
- A String
that specifies the type of record to be created.
The record can be an instance of one of the following classes or their subclasses:
ElectronicRecordInfo
, Marker
, EmailRecordInfo
.
This parameter cannot be null
or empty. aoRecordACLs
- A Permissions
collection that specifies the access values for
the new record. abAutoname
- A boolean
value that indicates whether the Records Manager API is to
generate the name for the new record using the registered auto-naming implementation class. Set this parameter
to true
to generate the record name automatically. Set this parameter to false
to use the DOCUMENT TITLE metadata value as the record name. RecordInfo
object. RMException
- If a Records Manager error occurs. declare
- RecordInfo declare(java.lang.String asURL,
- java.lang.String[] asVersion,
- RMFolder[] aoFolder,
- com.filenet.wcm.api.Properties aoRecordProps,
- java.lang.String asRecordInfoClassID,
- com.filenet.wcm.api.Permissions aoRecordACLs,
- boolean abAutoname,
- boolean abValidate)
- throws RMException
The asURL
parameter identifies the document that is to be declared as a record.
The asVersion
parameter identifies the specific versions of that document
that are to be included in the record. If this parameter
is null or empty, this method declares only latest version is declared as a record.
This method files the new record in the folders specified by the aoFolder
parameter.
If a record cannot be filed in a folder, the method cancels the declare operation and removes the record
from any folders in which it was already filed.
The new record inherits the security settings of the folder in which it is filed and, in turn, the documents represented by this record inherit their security settings from the record. If the record is filed in multiple folders, the record inherits the security settings of the parent folder.
To have this method generate the name for the new record automatically, set the
abAutoname
parameter to true
.
To use the auto-naming feature, you must first register the AutoName implementation class
with the application by calling the registerAutoName
method on an RMDriverManager
object. If the AutoName implementation class is not registered,
the declare
method throws an exception.
asURL
- A String
that identifies the Document URL of the document to be declared
as a record. This parameter cannot be null
or empty. asVersion
- A String
array that contains the numbers of the versions of the
document that are to be declared as record. If this array contains null
or empty values,
only the latest version of the document is declared a record. aoFolder
- An RMFolder
array that identifies the folders in which the new record is to
be filed. This parameter is optional. aoRecordProps
- A Properties
collection that specifies the property values for the
new record. asRecordInfoClassID
- A String
that specifies the type of record to be created.
The record can be an instance of one of the following classes or their subclasses:
ElectronicRecordInfo
, Marker
, EmailRecordInfo
.
This parameter cannot be null
or empty. aoRecordACLs
- A Permissions
collection that specifies the access values for
the new record. abAutoname
- A boolean
value that indicates whether the Records Manager API is to
generate the name for the new record using the registered auto-naming implementation class. Set this parameter
to true
to generate the record name automatically. Set this parameter to false
to use the DOCUMENT TITLE metadata value as the record name. abValidate
- A boolean
value that indicates whether the Records Manager API is to
verify that the folders in which the new record is to be filed are open and active. Set this parameter
to true
to verify the state of the folders. RecordInfo
object. RMException
- If a Records Manager error occurs. declareAllVersions
- RecordInfos declareAllVersions( DocumentStore aoDocumentStore,
- java.lang.String asArrDocumentsID,
- boolean abAllVersion,
- RMFolder[] aoArrFolder,
- com.filenet.wcm.api.Properties aoRecordProps,
- java.lang.String asRecordInfoClassID,
- com.filenet.wcm.api.Permissions aoRecordACLs,
- boolean abAutoname,
- java.util.Map aoError)
- throws RMException
List the IDs, separated by commas, of the documents that are to be declared as records in
the asArrDocumentsID
parameter. Identify the document store in which these
documents are located in the aoDocumentStore
parameter.
Set the abAllVersion
parameter to true
to declare each version a separate record. Set this parameter to false
to declare
all versions as a single record.
This method files the new record in the folders specified by the aoFolder
parameter.
If a record cannot be filed in a folder, the method cancels the declare operation and removes the record
from any folders in which it was already filed.
The new record inherits the security settings of the folder in which it is filed and, in turn, the documents represented by this record inherit their security settings from the record. If the record is filed in multiple folders, the record inherits the security settings of the parent folder.
To have the Records Manager API generate the name for the new record automatically, set the
abAutoname
parameter to true
.
To use the auto-naming feature, you must first register the AutoName implementation class
with the application by calling the registerAutoName
method on an RMDriverManager
object. If the AutoName implementation class is not registered,
the declare
method throws an exception.
aoDocumentStore
- A DocumentStore
object that represents the document store
in which the documents to be declared as record are located. asArrDocumentsID
- A String
that contains a comma-separated the IDs of the documents to be
declared as record. abAllVersion
- A boolean
value that indicates whether each version of the
specified document is to be declared a separate record. Set this parameter to true
to declare each version a separate record. Set this parameter to false
to declare
all versions as a single record. aoArrFolder
- An RMFolder
array that identifies the folders in which the new records
are to be filed. This parameter is optional. aoRecordProps
- A Properties
collection that specifies the property values
for the new records. asRecordInfoClassID
- A String
that specifies the type of record to be created.
The record can be an instance of one of the following classes or their subclasses:
ElectronicRecordInfo
, Marker
, EmailRecordInfo
.
This parameter cannot be null
or empty. aoRecordACLs
- A Permissions
collection that specifies the access values
for the new record. abAutoname
- A boolean
value that indicates whether the Records Manager API
is to generate the name for the new record using the registered auto-naming implementation class. Set
this parameter to true
to generate the record name automatically. Set this parameter
to false
to use the DOCUMENT TITLE metadata value as the record name. aoError
- A Map
object in which errors corresponding to any failed declarations
are to be logged. The key value used to log such errors is <DocumentID nos>
, which
identifies the document that was being declared when the failure occurred. RecordInfos
collection containing the new RecordInfo
objects. RMException
- In case of any error, an RMException will be thrown declareAllVersions
- RecordInfos declareAllVersions( DocumentStore aoDocumentStore,
- java.lang.String asArrDocumentsID,
- boolean abAllVersion,
- RMFolder[] aoArrFolder,
- com.filenet.wcm.api.Properties aoRecordProps,
- java.lang.String asRecordInfoClassID,
- com.filenet.wcm.api.Permissions aoRecordACLs,
- boolean abAutoname,
- java.util.Map aoError,
- boolean abValidate)
- throws RMException
List the IDs, separated by commas, of the documents that are to be declared as records in
the asArrDocumentsID
parameter. Identify the document store in which these
documents are located in the aoDocumentStore
parameter.
Set the abAllVersion
parameter to true
to declare each version a separate record. Set this parameter to false
to declare
all versions as a single record.
This method files the new record in the folders specified by the aoFolder
parameter.
If a record cannot be filed in a folder, the method cancels the declare operation and removes the record
from any folders in which it was already filed.
The new record inherits the security settings of the folder in which it is filed and, in turn, the documents represented by this record inherit their security settings from the record. If the record is filed in multiple folders, the record inherits the security settings of the parent folder.
To have the Records Manager API generate the name for the new record automatically, set the
abAutoname
parameter to true
.
To use the auto-naming feature, you must first register the AutoName implementation class
with the application by calling the registerAutoName
method on an RMDriverManager
object. If the AutoName implementation class is not registered,
the declare
method throws an exception.
aoDocumentStore
- A DocumentStore
object that represents the document store
in which the documents to be declared as record are located. asArrDocumentsID
- A String
array that contains the IDs of the documents to be
declared as record. abAllVersion
- A boolean
value that indicates whether each version of the
specified document is to be declared a separate record. Set this parameter to true
to declare each version a separate record. Set this parameter to false
to declare
all versions as a single record. aoArrFolder
- An RMFolder
array that identifies the folders in which the new records
are to be filed. This parameter is optional. aoRecordProps
- A Properties
collection that specifies the property values
for the new records. asRecordInfoClassID
- A String
that specifies the type of record to be created.
The record can be an instance of one of the following classes or their subclasses:
ElectronicRecordInfo
, Marker
, EmailRecordInfo
.
This parameter cannot be null
or empty. aoRecordACLs
- A Permissions
collection that specifies the access values
for the new record. abAutoname
- A boolean
value that indicates whether the Records Manager API
is to generate the name for the new record using the registered auto-naming implementation class. Set
this parameter to true
to generate the record name automatically. Set this parameter
to false
to use the DOCUMENT TITLE metadata value as the record name. aoError
- A Map
object in which errors corresponding to any failed declarations
are to be logged. The key value used to log such errors is <DocumentID nos>
, which
identifies the document that was being declared when the failure occurred. abValidate
- A boolean
value that indicates whether the Records Manager API is to
verify that the folders in which the new record is to be filed are open and active. Set this parameter
to true
to verify the state of the folders. RecordInfos
collection containing the new RecordInfo
objects. RMException
- In case of any error, an RMException will be thrown declareAllVersions
- RecordInfos declareAllVersions( java.lang.String asURL,
- boolean abAllVersion,
- RMFolder[] aoFolder,
- com.filenet.wcm.api.Properties aoRecordProps,
- java.lang.String asRecordInfoClassID,
- com.filenet.wcm.api.Permissions aoRecordACLs,
- boolean abAutoname,
- java.util.Map aoErrorMap)
- throws RMException
asURL
parameter as either a single record or as separate records,
and files the record or records in the specified folders. Declare the specified
documents as a single record and files the new record in the specified folders.
Set the abAllVersion
parameter to true
to declare each version a separate record. Set this parameter to false
to declare
all versions as a single record.
This method files the new record in the folders specified by the aoFolder
parameter.
If a record cannot be filed in a folder, the method cancels the declare operation and removes the record
from any folders in which it was already filed.
The new record inherits the security settings of the folder in which it is filed and, in turn, the documents represented by this record inherit their security settings from the record. If the record is filed in multiple folders, the record inherits the security settings of the parent folder.
To have the Records Manager API generate the name for the new record automatically, set the
abAutoname
parameter to true
.
To use the auto-naming feature, you must first register the AutoName implementation class
with the application by calling the registerAutoName
method on an RMDriverManager
object. If the AutoName implementation class is not registered,
the declare
method throws an exception.
asURL
- A String
that identifies the URL for the document to be verified.
This parameter cannot be null
or empty. abAllVersion
- A boolean
value that indicates whether each version of the specified
document is to be declared a separate record. Set this parameter to true
to declare each
version a separate record. Set this parameter to false
to declare all versions as a
single record. aoFolder
- An RMFolder
array that identifies the folders in which the new records
are to be filed. This parameter is optional. aoRecordProps
- A Properties
collection that specifies the property values
for the new records. asRecordInfoClassID
- A String
that specifies the type of record to be created.
The record can be an instance of one of the following classes or their subclasses:
ElectronicRecordInfo
, Marker
, EmailRecordInfo
.
This parameter cannot be null
or empty. aoRecordACLs
- A Permissions
collection that specifies the access values
for the new record. abAutoname
- A boolean
value that indicates whether the Records Manager API
is to generate the name for the new record using the registered auto-naming implementation class. Set
this parameter to true
to generate the record name automatically. Set this parameter
to false
to use the DOCUMENT TITLE metadata value as the record name. aoErrorMap
- A Map
object in which errors corresponding to any failed declarations
are to be logged. The key value used to log such errors is <DocumentID nos>
, which
identifies the document that was being declared when the failure occurred. RecordInfos
collection containing the new RecordInfo
objects. RMException
- In case of any error, an RMException will be thrown declareAllVersions
- RecordInfos declareAllVersions( java.lang.String asURL,
- boolean abAllVersion,
- RMFolder[] aoFolder,
- com.filenet.wcm.api.Properties aoRecordProps,
- java.lang.String asRecordInfoClassID,
- com.filenet.wcm.api.Permissions aoRecordACLs,
- boolean abAutoname,
- java.util.Map aoErrorMap,
- boolean abValidate)
- throws RMException
asURL
parameter as either a single record or as separate records,
and files the record or records in the specified folders. Declare the specified
documents as a single record and files the new record in the specified folders.
Set the abAllVersion
parameter to true
to declare each version a separate record. Set this parameter to false
to declare
all versions as a single record.
This method files the new record in the folders specified by the aoFolder
parameter.
If a record cannot be filed in a folder, the method cancels the declare operation and removes the record
from any folders in which it was already filed.
The new record inherits the security settings of the folder in which it is filed and, in turn, the documents represented by this record inherit their security settings from the record. If the record is filed in multiple folders, the record inherits the security settings of the parent folder.
To have the Records Manager API generate the name for the new record automatically, set the
abAutoname
parameter to true
.
To use the auto-naming feature, you must first register the AutoName implementation class
with the application by calling the registerAutoName
method on an RMDriverManager
object. If the AutoName implementation class is not registered,
the declare
method throws an exception.
asURL
- A String
that identifies the URL for the document to be verified.
This parameter cannot be null
or empty. abAllVersion
- A boolean
value that indicates whether each version of the specified
document is to be declared a separate record. Set this parameter to true
to declare each
version a separate record. Set this parameter to false
to declare all versions as a
single record. aoFolder
- An RMFolder
array that identifies the folders in which the new records
are to be filed. This parameter is optional. aoRecordProps
- A Properties
collection that specifies the property values
for the new records. asRecordInfoClassID
- A String
that specifies the type of record to be created.
The record can be an instance of one of the following classes or their subclasses:
ElectronicRecordInfo
, Marker
, EmailRecordInfo
.
This parameter cannot be null
or empty. aoRecordACLs
- A Permissions
collection that specifies the access values
for the new record. abAutoname
- A boolean
value that indicates whether the Records Manager API
is to generate the name for the new record using the registered auto-naming implementation class. Set
this parameter to true
to generate the record name automatically. Set this parameter
to false
to use the DOCUMENT TITLE metadata value as the record name. aoErrorMap
- A Map
object in which errors corresponding to any failed declarations
are to be logged. The key value used to log such errors is <DocumentID nos>
, which
identifies the document that was being declared when the failure occurred. abValidate
- A boolean
value that indicates whether the Records Manager API is to
verify that the folders in which the new record is to be filed are open and active. Set this parameter
to true
to verify the state of the folders. RecordInfos
collection containing the new RecordInfo
objects. RMException
- In case of any error, an RMException will be thrown validateCloseProperty
- void validateCloseProperty(java.util.Date aoDateClosed,
- java.lang.String asReasonForClose)
null
or empty. If the ReasonForClose property is null
or empty and this container object is
closed, this method throws an exception.
aoDateClosed
- A Date
object that represents the DateClosed property value for this
container object. asReasonForClose
- A String
that contains the value of the ReasonForClose property
for this container object. RMException
- If the ReasonForClose property is null
or empty
and this container object is closed or if a Records Manager error occurs. validateInactiveProperty
- void validateInactiveProperty(boolean abIsInActive,
- java.lang.String asReasonForInactivate)
null
or empty. If the ReasonForInactivate property is null
or empty and this container object is
inactivated, this method throws an exception.
abIsInActive
- A boolean
value that represents the Inactive property value for this
container object. asReasonForInactivate
- A String
that contains the value of the ReasonForInactivate
property for this container object. RMException
- If the ReasonForInactivate property is null
or empty
and this container object is inactive or if a Records Manager error occurs. delete
- void delete(boolean abSave,
- java.lang.String asReasonForDelete)
- throws RMException
abSave
- A boolean
value that indicates whether minimum metadata
is to be saved. This parameter is used only if the isMinimumMetadataRetained
property for this container object is set to 2. Set the value to true
if the method is to save the minimum metadata when deleting this object.
Set the value to false
if the method is to delete the minimum
metadata along with this object. asReasonForDelete
- A String
that describes the reason this
container object is being deleted. RMException
- If this container object is on hold or if a Records Manager
error occurs. getPatternBaseName
- java.lang.String getPatternBaseName( int aiEntityType)
aiEntityType
- An int
value that specifies the type of entity
for which a name is to be generated. This parameter must specify an
RMType
value that represents a type of entity that can be
placed in this container object. String
that represents the name generated according to
the naming pattern. If no pattern is defined for this container object, the
method returns an empty String
. getPatternBaseName
- java.lang.String getPatternBaseName( int aiEntityType,
- java.lang.StringBuffer moEntityNameOrId)
aiEntityType
- An int
value that specifies the type of entity
for which a name is to be generated. This parameter must specify an
RMType
value that represents a type of entity that can be
placed in this container object. moEntityNameOrId
- A StringBuffer
whose value this method is
to update to indicate whether the naming pattern applies to a name or an identifier. String
that represents the name generated according to
the naming pattern. If no pattern is defined for this container object, the
method returns an empty String
. getPatternBaseName
- java.lang.String getPatternBaseName( int aiEntityType,
- com.filenet.wcm.api.Properties aoProperties)
aiEntityType
- An int
value that specifies the type of entity
for which a name is to be generated. This parameter must specify an
RMType
value that represents a type of entity that can be
placed in this container object. aoProperties
- A Properties
collection that contains any
metadata values that are required in the pattern definition string. String
that represents the name generated according to
the naming pattern. If no pattern is defined for this container object, the
method returns an empty String
. getPatternBaseName
- java.lang.String getPatternBaseName( int aiEntityType,
- com.filenet.wcm.api.Properties aoProperties,
- java.lang.StringBuffer moEntityNameOrId)
aiEntityType
- An int
value that specifies the type of entity
for which a name is to be generated. This parameter must specify an
RMType
value that represents a type of entity that can be
placed in this container object. aoProperties
- A Properties
collection that contains any
metadata values that are required in the pattern definition string. moEntityNameOrId
- A StringBuffer
whose value this method is
to update to indicate whether the naming pattern applies to a name or an identifier. String
that represents the name generated according to
the naming pattern. If no pattern is defined for this container object, the
method returns an empty String
. setProperties
- void setProperties(com.filenet.wcm.api.Properties aoProperties,
- boolean abFlag)
If the abFlag
is set to true
, this method resets
the RECALCULATE_PHASE_RETENTION property for this container object as follows:
If the current value is CUTOFF_RECALCULATION_NOT_REQUIRED_FOR_INTERNAL_EVENT, the method resets the value to CUTOFF_RECALCULATION_REQUIRED_FOR_INTERNAL_EVENT.
If the current value is CUTOFF_RECALCULATION_NOT_REQUIRED_FOR_INTERNAL_EVENT, the method resets the value to CUTOFF_RECALCULATION_REQUIRED_FOR_INTERNAL_EVENT.
setProperties
in interface com.filenet.wcm.api.WriteableMetadataObject
aoProperties
- A Properties
collection that contains the property values to
be set for this container object. abFlag
- A boolean
value that indicates whether this method is to reset
the RECALCULATE_PHASE_RETENTION property for this container object. Set the value to
true
if the method is to reset this property. clearDispositionSchedule
- void clearDispositionSchedule(int aiClearSchedule)
- throws RMException
aiClearSchedule
indicates whether
the schedule and data are to be cleared from any child objects that
inherited the disposition settings from this container object.
aiClearSchedule
- An int
value that indicates whether the
disposition schedule and data are to be cleared from child objects of this
container object. Set this parameter to 2 to clear the disposition schedule
and data from any child objects that inherited the disposition schedule from this
container object. Set this parameter to any other integer to clear
the disposition schedule and data from this container object, but not from
its children. RMException
- If a Records Manager error occurs. declareAndClassify
- RecordInfo declareAndClassify(DocumentStore aoDocumentStore,
- java.lang.String[] asArrDocumentsID,
- RMFolder[] aoArrFolder,
- com.filenet.wcm.api.Properties aoRecordProps,
- java.lang.String asRecordInfoClassID,
- com.filenet.wcm.api.Permissions aoRecordACLs,
- boolean abAutoname,
- boolean abValidate)
- throws RMException
aoRecordProps
parameter. The method validates the classification of the new
record according to the business rules that are applied to the security classification action.
The asDocumentsID
parameter identifies the documents that are to be declared as records.
The aoDocumentStore
parameter identifies the document store in which these documents
are located.
This method files the record in the folder or folders specified by the aoFolder
parameter.
If a record cannot be filed in a folder, the method cancels the declare operation and removes the new record
from any folders in which it was filed.
The new record inherits the security settings of the folder in which it is filed. In turn, the document inherits the security settings from the record. If the record is filed in multiple folders, the record inherits the security settings of the parent folder.
To have the declare
method generate the name for the new record automatically, set the
abAutoname
parameter to true
.
To use the auto-naming feature, you must first create an implementation class for the
RMDriverManager
interface and register this implementation class
by calling the registerAutoName
method. If this implementation class is not registered,
the declare
method throws an exception.
aoDocumentStore
- A DocumentStore
object that represents the document store
in which the documents to be declared as record are located. aoRecordProps
- A Properties
collection that specifies the property values
for the new record. asRecordInfoClassID
- A String
that specifies the type of record to be created.
The record can be an instance of one of the following classes or their subclasses:
ElectronicRecordInfo
, Marker
, EmailRecordInfo
.
This parameter cannot be null
or empty. aoRecordACLs
- A Permissions
collection that specifies the access values
for the new record. abAutoname
- A boolean
value that indicates whether the Records Manager API
is to generate the name for the new record using the registered auto-naming implementation class. Set
this parameter to true
to generate the record name automatically. Set this parameter
to false
to use the DOCUMENT TITLE metadata value as the record name. abValidate
- A boolean
value that indicates whether the Records Manager API is to
verify that the folders in which the new record is to be filed are open and active. Set this parameter
to true
to verify the state of the folders. RecordInfo
object. RMException
- If a Records Manager error occurs. declareAndClassify
- RecordInfo declareAndClassify(java.lang.String asURL,
- java.lang.String[] asArrVersion,
- RMFolder[] aoArrFolder,
- com.filenet.wcm.api.Properties aoRecordProps,
- java.lang.String asRecordInfoClassID,
- com.filenet.wcm.api.Permissions aoRecordACLs,
- boolean abAutoname,
- boolean abValidate)
- throws RMException
aoRecordProps
parameter. The method validates the classification of the new
record according to the business rules that are applied to the security classification action.
The asDocumentsID
parameter identifies the documents that are to be declared as records.
The aoDocumentStore
parameter identifies the document store in which these documents
are located.
This method files the record in the folder or folders specified by the aoFolder
parameter.
If a record cannot be filed in a folder, the method cancels the declare operation and removes the new record
from any folders in which it was filed.
The new record inherits the security settings of the folder in which it is filed. In turn, the document inherits the security settings from the record. If the record is filed in multiple folders, the record inherits the security settings of the parent folder.
To have the declare
method generate the name for the new record automatically, set the
abAutoname
parameter to true
.
To use the auto-naming feature, you must first create an implementation class for the
RMDriverManager
interface and register this implementation class
by calling the registerAutoName
method. If this implementation class is not registered,
the declare
method throws an exception.
asURL
- A String
that identifies the URL for the document to be verified. This
parameter cannot be null
or empty. aoRecordProps
- A Properties
collection that specifies the property values
for the new record. asRecordInfoClassID
- A String
that specifies the type of record to be created.
The record can be an instance of one of the following classes or their subclasses:
ElectronicRecordInfo
, Marker
, EmailRecordInfo
.
This parameter cannot be null
or empty. aoRecordACLs
- A Permissions
collection that specifies the access values
for the new record. abAutoname
- A boolean
value that indicates whether the Records Manager API
is to generate the name for the new record using the registered auto-naming implementation class. Set
this parameter to true
to generate the record name automatically. Set this parameter
to false
to use the DOCUMENT TITLE metadata value as the record name. abValidate
- A boolean
value that indicates whether the Records Manager API is to
verify that the folders in which the new record is to be filed are open and active. Set this parameter
to true
to verify the state of the folders. RecordInfo
object. RMException
- If a Records Manager error occurs.
To verify a single document, set the
only the version of the document at that URL. To verifyasURL
parameter to the URL for that document. To verify multiple versions of the document, set theasArrVersion
parameter to numbers of the versions to be verified. To verify only the version at the specified URL, set theasArrVersion
parameter tonull
.To verify multiple documents, set the
asURL
parameter to the URLs for the document using commas to separate the URLs. You must set theasArrVersion
parameter tonull
when multiple document URLs are listed.