Skip navigation links

oracle.ifs.fdk
Interface RecordsManager

public interface RecordsManager

Records Management operations.

Method Summary

Item	addMetaDataAttribute(long mdscatId, NamedValue attributedef, AttributeRequest[] attrrequest) Given an Attribute description, add the attribute to the given class and return the new Attribute item.
Item	createFilePlan(NamedValue[] attrs, AttributeRequest[] attributes) Create a file plan under current domain.
Item	createRecordCategory(long parentId, NamedValue[] attrs, AttributeRequest[] attributes) create a record category under the parentId.
Item	createRecordFolder(long parentId, NamedValue[] attrs, AttributeRequest[] attributes) create a record folder under the parent record category.
Item	createRecordSeries(long fileplanId, NamedValue[] attrs, AttributeRequest[] attributes) create a record series under the file plan
void	deleteFilePlan(long fileplanId) Delete the fileplan with the given Id.
void	deleteRecordCategory(long rcId) Delete the recordcategory with the given Id.
void	deleteRecordFolder(long rcId) Delete the record folder with the given Id.
void	deleteRecordSeries(long rsId) Delete the recordseries with the given Id.
Item[]	getChildren(long parentId, NamedValue[] def, AttributeRequest[] attreqs) For a given RecordsManagement object return its direct children.
Item	getFilePlan(java.lang.String name, AttributeRequest[] attributes) return FilePlan of the given name if it exists or return null if there is no fileplan by that name
Item	getRecordCategory(long parentId, java.lang.String name, AttributeRequest[] attributes) return RecordCategory of the given name if it exists under the fileplan or record series (in that order) or return null if there is no record category by that name
Item	getRecordFolder(long recordCategoryId, java.lang.String name, AttributeRequest[] attributes) return RecordFolder of the given name if it exists under the record category or return null if there is no record folder by that name
Item	getRecordizedObject(long recordId, AttributeRequest[] attributes) Gets the public object that has been recordized using the record whose id is passed in the argument.
Item	getRecordSeries(long fileplanId, java.lang.String name, AttributeRequest[] attributes) return RecordSeries of the given name if it exists under the fileplan or return null if there is no record series by that name
Item	getRequiredRecordCategory(long folderId, AttributeRequest[] requestedAttributes) Deprecated. Request REQUIRED_RECORD_CATEGORY on RecordConfiguration
Item[]	listFilePlans(NamedValue[] attr, AttributeRequest[] attreqs) Returns the file plans under the current domain.
Item[]	listRecordCategories(long parentId, NamedValue[] def, AttributeRequest[] attreqs) Returns the record categories under the given fileplan or record series (in that order).
Item[]	listRecordFolders(long parentId, NamedValue[] def, AttributeRequest[] attreqs) Returns the record folders under the given record category.
Item[]	listRecordSeries(long fileplanId, NamedValue[] def, AttributeRequest[] attreqs) Returns the record series under the given fileplan.
Item	makeRecord(long parentId, long docId, NamedValue[] attrs, AttributeRequest[] attributes) Make a publicobject a record.
Item	modifyMetaDataAttribute(long attributeId, NamedValue attributedef, AttributeRequest[] attrrequest) Given an Attribute description, modify the attribute to the given class and return the modified classobject id.
void	queueRecordsInErrorForRetry(long parentId) Queues the records in error for the given record category or record folder as ready for retry.
void	removeMetaDataAttribute(long attributeId) Remove an attribute from a MetaDataCategory class.
void	removeRecordConfiguration(long folderId) remove the existing RecordConfiguration for a Folder
void	setRecordConfiguration(long folderId, NamedValue[] config) Sets or updates the RecordConfiguration for a Folder.
void	unRecordize(long parentId, long docId) unRecordize the record from the given recordcategory or recordfolder
Item	updateFilePlan(long fpId, NamedValue[] attrs, AttributeRequest[] attributes) update a file plan under the current domain
Item	updateRecord(long parentId, long recordId, NamedValue[] attrs, AttributeRequest[] attributes) update a record.
Item	updateRecordCategory(long parentId, NamedValue[] attrs, AttributeRequest[] attributes) update a record category with the given ID
Item	updateRecordFolder(long folderId, NamedValue[] attrs, AttributeRequest[] attributes) Update a record folder with the given ID
Item	updateRecordSeries(long rsId, NamedValue[] attrs, AttributeRequest[] attributes) update a record series under the file plan

Method Detail

createFilePlan

public Item createFilePlan(NamedValue[] attrs,
                           AttributeRequest[] attributes)
                    throws FdkException

Create a file plan under current domain.

Parameters:

attrs - array of attributes for creating the fileplan

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.IS_DOD_FILEPLAN, Boolean}
• {Attributes.GUARD_SECURITY, NamedValue[]}, where the attributes are:
  • {Attributes.GRANTS, NamedValueSet[]}, where each row corresponds to a grant whose attributes are:
    • {Attributes.GRANTEE, Long}
    • {Attributes.ROLES, long[]}
    • {Attributes.PROPAGATING, Boolean}

attributes - requested attributes for each item, or null.

Returns:

the fileplan Item that was created

Throws:

FdkException - if the operation fails.

createRecordSeries

public Item createRecordSeries(long fileplanId,
                               NamedValue[] attrs,
                               AttributeRequest[] attributes)
                        throws FdkException

create a record series under the file plan

Parameters:

fileplanId - the ID of the file plan under which to create the record series

attrs - array of attributes for creating the recordcategory

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}

attributes - requested attributes for each item, or null.

Returns:

the recordseries Item that was created

Throws:

FdkException - if the operation fails.

createRecordCategory

public Item createRecordCategory(long parentId,
                                 NamedValue[] attrs,
                                 AttributeRequest[] attributes)
                          throws FdkException

create a record category under the parentId. The parent can be a file plan or record series in that order

Parameters:

parentId - the ID of the file plan or record series under under which to create the record category

attrs - array of attributes for creating the recordcategory

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.DISPOSITION_DESCRIPTION, String}
• {Attributes.CUTOFF_FREQUENCY, Integer}
• {Attributes.INITIAL_CUTOFF_DATE, Date}
• {Attributes.DISPOSITION_PHASES, array of NamedValueSet}
• Its used to describe disposition phases of a record category
• A NamedValueSet is an array of NamedValue objects
• Each element of the NamedValue array is one of
• the following that describes further a single disposition phase
• {Attributes.ACTION, Integer},
• {Attributes.RETENTION, Long},
• {Attributes.DESTINATION_FOLDER, Long},
• {Attributes.DESTINATION_STRING, String},
• {Attributes.WORKFLOW_CONFIGURATION, array of Named Values}
• • {Attributes.WORKFLOW_CONFIGURATION_WORKFLOW,Long Id of Workflow Item}
  • {Attributes.WORKFLOW_CONFIGURATION_RESPONDERS,array of user Item ids}
  • {Attributes.WORKFLOW_CONFIGURATION_RESPONDERS_BYPASS,Boolean}
  • {Attributes.WORKFLOW_CONFIGURATION_PARAMETERS,array of NamedValue Set}
  • • {Attributes.WORKFLOW_PARAMETER_NAME,String}
    • {Attributes.WORKFLOW_PARAMETER_DEFAULT_VALUE,String}
    • {Attributes.WORKFLOW_PARAMETER_REQUIRED,Boolean}
• {Attributes.ATTRIBUTE_DETAIL, NamedValue[][]}
  • each row is an array that describes a custom attribute
    • {Attributes.ATTRIBUTE_NAME, String}
    • {Attributes.DISPLAY_NAME, String}
    • {Attributes.ATTRIBUTE_REQUIRED, Boolean}
    • {Attributes.ATTRIBUTE_SETTABLE, Boolean}
    • {Attributes.ATTRIBUTE_UPDATEABLE, Boolean}
    • {Attributes.ATTRIBUTE_HIDDEN, Boolean}
    • {Attributes.ATTRIBUTE_INDEXED, Boolean}
    • {Attributes.ATTRIBUTE_OVERRIDEABLE, Boolean}
    • {Attributes.ATTRIBUTE_TYPE, String}
    • Where value of ATTRIBUTE_TYPE is
      • FdkConstants.ATTRIBUTE_TYPE_STRING
      • FdkConstants.ATTRIBUTE_TYPE_STRING_ARRAY
      • FdkConstants.ATTRIBUTE_TYPE_DATE
      • FdkConstants.ATTRIBUTE_TYPE_INTEGER
      • FdkConstants.ATTRIBUTE_TYPE_LONG
      • FdkConstants.ATTRIBUTE_TYPE_BOOLEAN
      • FdkConstants.ATTRIBUTE_TYPE_FLOAT
      • FdkConstants.ATTRIBUTE_TYPE_USER
      • FdkConstants.ATTRIBUTE_TYPE_GROUP
    • {Attributes.ATTRIBUTE_DEFAULT, type, where type is String, String [], date, int, long, boolean, float or double}
    • {Attributes.ATTRIBUTE_ENUMERATION, [] type, where type is String, int, or long}
• {Attributes.GUARD_SECURITY, NamedValue[]}, where the attributes are:
  • {Attributes.GRANTS, NamedValueSet[]}, where each row corresponds to a grant whose attributes are:
    • {Attributes.GRANTEE, Long}
    • {Attributes.ROLES, long[]}
    • {Attributes.PROPAGATING, Boolean}

attributes - requested attributes for each item, or null.

Returns:

the recordcategory Item that was created

Throws:

FdkException - if the operation fails.

createRecordFolder

public Item createRecordFolder(long parentId,
                               NamedValue[] attrs,
                               AttributeRequest[] attributes)
                        throws FdkException

create a record folder under the parent record category.

Parameters:

parentId - the ID of the record category under which to create the record folder

attrs - array of attributes for creating the recordFolder

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.INITIAL_CUTOFF_DATE, Date}

attributes - requested attributes for each item, or null.

Returns:

the Record Folder Item that was created

Throws:

FdkException - if the operation fails.

updateFilePlan

public Item updateFilePlan(long fpId,
                           NamedValue[] attrs,
                           AttributeRequest[] attributes)
                    throws FdkException

update a file plan under the current domain

Parameters:

fpId - id of the fileplan to update

attrs - array of attributes for updating the fileplan

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.GUARD_SECURITY, NamedValue[]}, where the attributes are:
  • {Attributes.GRANTS, NamedValueSet[]}, where each row corresponds to a grant whose attributes are:
    • {Attributes.GRANTEE, Long}
    • {Attributes.ROLES, long[]}
    • {Attributes.PROPAGATING, Boolean}

  attributes - requested attributes for each item, or null.

  Returns:

  the item representing the fileplan that was updated

  Throws:

  FdkException - if the operation fails.

updateRecordSeries

public Item updateRecordSeries(long rsId,
                               NamedValue[] attrs,
                               AttributeRequest[] attributes)
                        throws FdkException

update a record series under the file plan

Parameters:

rsId - the ID of the recordseries to update

attrs - array of attributes for updating the record series

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}

  attributes - requested attributes for each item, or null.

  Returns:

  the item representing the recordseries that was updated

  Throws:

  FdkException - if the operation fails.

updateRecordCategory

public Item updateRecordCategory(long parentId,
                                 NamedValue[] attrs,
                                 AttributeRequest[] attributes)
                          throws FdkException

update a record category with the given ID

Parameters:

parentId - the ID of the record category to update

attrs - array of attributes for updating the recordcategory

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.DISPOSITION_DESCRIPTION, String}
• {Attributes.NEXT_CUTOFF_DATE, Date}
• {Attributes.CUTOFF_FREQUENCY, Integer}
• {Attributes.DISPOSITION_PHASES, array of NamedValueSet}
• Its used to describe disposition phases of a record category
• A NamedValueSet is an array of NamedValue objects
• Each element of the NamedValue array is one of
• the following that describes further a single disposition phase
• {Attributes.ACTION, Integer},
• {Attributes.RETENTION, Long},
• {Attributes.DESTINATION_FOLDER, Long},
• {Attributes.DESTINATION_STRING, String},
• {Attributes.WORKFLOW_CONFIGURATION, array of Named Values}
• • {Attributes.WORKFLOW_CONFIGURATION_WORKFLOW,Long Id of Workflow Item}
  • {Attributes.WORKFLOW_CONFIGURATION_RESPONDERS,array of user Item ids}
  • {Attributes.WORKFLOW_CONFIGURATION_RESPONDERS_BYPASS,Boolean}
  • {Attributes.WORKFLOW_CONFIGURATION_PARAMETERS,array of NamedValue Set}
  • • {Attributes.WORKFLOW_PARAMETER_NAME,String}
    • {Attributes.WORKFLOW_PARAMETER_DEFAULT_VALUE,String}
    • {Attributes.WORKFLOW_PARAMETER_REQUIRED,Boolean}
• {Attributes.CLOSED, Boolean}
• {Attributes.FROZEN, Boolean}
• {Attributes.GUARD_SECURITY, NamedValue[]}, where the attributes are:
  • {Attributes.GRANTS, NamedValueSet[]}, where each row corresponds to a grant whose attributes are:
    • {Attributes.GRANTEE, Long}
    • {Attributes.ROLES, long[]}
    • {Attributes.PROPAGATING, Boolean}

attributes - requested attributes for each item, or null.

Returns:

the recordcategory Item that was updated

Throws:

FdkException - if the operation fails.

updateRecordFolder

public Item updateRecordFolder(long folderId,
                               NamedValue[] attrs,
                               AttributeRequest[] attributes)
                        throws FdkException

Update a record folder with the given ID

Parameters:

folderId - the ID of the record folder to update

attrs - array of attributes for updating the recordFolder

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.CLOSED, Boolean}
• {Attributes.FROZEN, Boolean}
• {Attributes.INITIAL_CUTOFF_DATE, Date}
• {Attributes.CUTOFF_FREQUENCY, Integer}

attributes - requested attributes for each item, or null.

Returns:

the record folder Item that was updated

Throws:

FdkException - if the operation fails.

addMetaDataAttribute

public Item addMetaDataAttribute(long mdscatId,
                                 NamedValue attributedef,
                                 AttributeRequest[] attrrequest)
                          throws FdkException

Given an Attribute description, add the attribute to the given class and return the new Attribute item.

Parameters:

mdscatId - id of record category to which to add this attribute

attributedef - array of NamedValue for adding a new attribute

• {Attributes.ATTRIBUTE_DETAIL, NamedValue[]}
  • {Attributes.ATTRIBUTE_NAME, String}
  • {Attributes.DISPLAY_NAME, String}
  • {Attributes.ATTRIBUTE_REQUIRED, Boolean}
  • {Attributes.ATTRIBUTE_SETTABLE, Boolean}
  • {Attributes.ATTRIBUTE_UPDATEABLE, Boolean}
  • {Attributes.ATTRIBUTE_PROMPT, Boolean}
  • {Attributes.ATTRIBUTE_OVERRIDEABLE, Boolean}
  • {Attributes.ATTRIBUTE_TYPE, String}
  • Where value of ATTRIBUTE_TYPE is
    • FdkConstants.ATTRIBUTE_TYPE_STRING
    • FdkConstants.ATTRIBUTE_TYPE_STRING_ARRAY
    • FdkConstants.ATTRIBUTE_TYPE_DATE
    • FdkConstants.ATTRIBUTE_TYPE_INTEGER
    • FdkConstants.ATTRIBUTE_TYPE_LONG
    • FdkConstants.ATTRIBUTE_TYPE_BOOLEAN
    • FdkConstants.ATTRIBUTE_TYPE_FLOAT
    • FdkConstants.ATTRIBUTE_TYPE_USER
    • FdkConstants.ATTRIBUTE_TYPE_GROUP
  • {Attributes.ATTRIBUTE_DEFAULT, type, where type is String, String [], date, int, boolean, long, float or double}
  • {Attributes.ATTRIBUTE_ENUMERATION, [] type, where type is String, int, or long}

  attrrequest - requested attributes for each item, or null.

  Returns:

  id of the newly created attribute

  Throws:

  FdkException - if the operation fails

modifyMetaDataAttribute

public Item modifyMetaDataAttribute(long attributeId,
                                    NamedValue attributedef,
                                    AttributeRequest[] attrrequest)
                             throws FdkException

Given an Attribute description, modify the attribute to the given class and return the modified classobject id.

Parameters:

attributeId - id of attribute to be modified.

attributedef - array of NamedValue for adding a new attribute

• {Attributes.ATTRIBUTE_DETAIL, NamedValue[]}
  • {Attributes.DISPLAY_NAME, String}
  • {Attributes.ATTRIBUTE_SETTABLE, Boolean}
  • {Attributes.ATTRIBUTE_UPDATEABLE, Boolean}
  • {Attributes.ATTRIBUTE_PROMPT, Boolean}
  • {Attributes.ATTRIBUTE_HIDDEN, Boolean}
  • {Attributes.ATTRIBUTE_OVERRIDEABLE, Boolean}
  • {Attributes.ATTRIBUTE_DEFAULT, type}
  • {Attributes.ATTRIBUTE_ENUMERATION, [] type, where type is String, int, or long}

  attrrequest - requested attributes for each item, or null.

  Returns:

  newly modified METADATA_ATTRIBUTE

  Throws:

  FdkException - if the operation fails

removeMetaDataAttribute

public void removeMetaDataAttribute(long attributeId)
                             throws FdkException

Remove an attribute from a MetaDataCategory class. This operation cannot be undone.

Parameters:

attributeId - id of MetaDataAttribute to remove.

Throws:

FdkException

listFilePlans

public Item[] listFilePlans(NamedValue[] attr,
                            AttributeRequest[] attreqs)
                     throws FdkException

Returns the file plans under the current domain.

An attribute request is not required to be sent as the NAME attribute is implicitly returned in the result. The named value array encapsulates sorting information for the result

Parameters:

attr - assumes sorting and filtering information containing any of the following options

• notation: {Attribute name, Attribute type}
• {Options.FILTER_BY_GUARD_SECURITY, Boolean}
• {Options.PRIMARY_SORT_ATTRIBUTE, String}
• {Options.PRIMARY_SORT_DIRECTION, Boolean}
• {Options.SECONDARY_SORT_ATTRIBUTE, String}
• {Options.SECONDARY_SORT_DIRECTION, Boolean}

attreqs - array of attribute request containing the list of attributes the caller is interested in seeing

Returns:

an Item array representing the fileplans under the current domain or null if there are no fileplans

Throws:

FdkException - if the operation fails.

listRecordSeries

public Item[] listRecordSeries(long fileplanId,
                               NamedValue[] def,
                               AttributeRequest[] attreqs)
                        throws FdkException

Returns the record series under the given fileplan.

An attribute request is not required to be sent as the NAME attribute is implicitly returned from the fileplan. The second parameter contains sorting information for the result.

Parameters:

fileplanId - id of the fileplan

def - assumes sorting and filtering information containing any of the following options

• notation: {Attribute name, Attribute type}
• {Options.FILTER_BY_GUARD_SECURITY, Boolean}
• {Options.PRIMARY_SORT_ATTRIBUTE, String}
• {Options.PRIMARY_SORT_DIRECTION, Boolean}
• {Options.SECONDARY_SORT_ATTRIBUTE, String}
• {Options.SECONDARY_SORT_DIRECTION, Boolean}

attreqs - array of attribute request containing the list of attributes the caller is interested in seeing

Returns:

an Item array representing the recordseries under the file plan or null if there are no record series

Throws:

FdkException - if the operation fails.

listRecordCategories

public Item[] listRecordCategories(long parentId,
                                   NamedValue[] def,
                                   AttributeRequest[] attreqs)
                            throws FdkException

Returns the record categories under the given fileplan or record series (in that order).

The attribute request contains the list of attributes that the caller is interested in seeing. Assumes the named value array contains sorting information.

Parameters:

parentId - id of the fileplan or record series under which to create the record category

def - assumes sorting and filtering information containing any of the following options

• notation: {Attribute name, Attribute type}
• {Options.FILTER_BY_GUARD_SECURITY, Boolean}
• {Options.PRIMARY_SORT_ATTRIBUTE, String}
• {Options.PRIMARY_SORT_DIRECTION, Boolean}
• {Options.SECONDARY_SORT_ATTRIBUTE, String}
• {Options.SECONDARY_SORT_DIRECTION, Boolean}

attreqs - array of attribute request containing the list of attributes the caller is interested in seeing

Returns:

an Item array representing the recordcategories under the record series or file plan or null if there are no recordcategories.

Throws:

FdkException - if the operation fails.

listRecordFolders

public Item[] listRecordFolders(long parentId,
                                NamedValue[] def,
                                AttributeRequest[] attreqs)
                         throws FdkException

Returns the record folders under the given record category.

The attribute request contains the list of attributes that the caller is interested in seeing. Assumes the named value array contains sorting information.

Parameters:

parentId - id of the record category of interest.

def - assumes sorting and filtering information containing any of the following options

• notation: {Attribute name, Attribute type}
• {Options.FILTER_BY_GUARD_SECURITY, Boolean}
• {Options.PRIMARY_SORT_ATTRIBUTE, String}
• {Options.PRIMARY_SORT_DIRECTION, Boolean}
• {Options.SECONDARY_SORT_ATTRIBUTE, String}
• {Options.SECONDARY_SORT_DIRECTION, Boolean}

attreqs - array of attribute request containing the list of attributes the caller is interested in seeing

Returns:

an Item array representing the record folders under the record cateory; can be null.

Throws:

FdkException - if the operation fails.

getChildren

public Item[] getChildren(long parentId,
                          NamedValue[] def,
                          AttributeRequest[] attreqs)
                   throws FdkException

For a given RecordsManagement object return its direct children.

For a Fileplan, it returns the recordseries and record categories under it. For a RecordSeries, it returns the recordcategories under it. For a RecordCategory, it returns the records and recordfolders under it. For a RecordFolder, it returns the records filed under it.

The attribute request contains the list of attributes that the caller is interested in seeing. The named value array contains sorting information.

Parameters:

parentId - id of the fileplan, recordseries, recordcategory or record folder

def - sorting and filtering information containing any of the following options

• notation: {Attribute name, Attribute type}
• {Options.FILTER_BY_GUARD_SECURITY, Boolean}
• {Options.PRIMARY_SORT_ATTRIBUTE, String}
• {Options.PRIMARY_SORT_DIRECTION, Boolean}
• {Options.SECONDARY_SORT_ATTRIBUTE, String}
• {Options.SECONDARY_SORT_DIRECTION, Boolean}

attreqs - array of attribute request containing the list of attributes the caller is interested in seeing

Returns:

an Item array representing the fileplan, recordseries, recordcategory or recordfolder and its children

Throws:

FdkException - if the operation fails.

deleteFilePlan

public void deleteFilePlan(long fileplanId)
                    throws FdkException

Delete the fileplan with the given Id. Only an empty fileplan can be deleted i.e there cannot be any record categories or record series under it. That is enforced by the API.

Parameters:

fileplanId - id of the fileplan to be deleted

Throws:

FdkException - if the operation fails.

deleteRecordSeries

public void deleteRecordSeries(long rsId)
                        throws FdkException

Delete the recordseries with the given Id. Only an empty recordseries can be deleted i.e there cannot be any record categories under it. That is enforced by the API.

Parameters:

rsId - id of the recordseries to be deleted

Throws:

FdkException - if the operation fails.

deleteRecordCategory

public void deleteRecordCategory(long rcId)
                          throws FdkException

Delete the recordcategory with the given Id. Only an empty recordcategory can be deleted i.e there cannot be any record folders and records under it. That is enforced by the API.

Parameters:

rcId - id of the recordcategory to be deleted

Throws:

FdkException - if the operation fails.

deleteRecordFolder

public void deleteRecordFolder(long rcId)
                        throws FdkException

Delete the record folder with the given Id. Only an empty recordfolder can be deleted i.e there cannot be any records under it. That is enforced by the API.

Parameters:

rcId - id of the record folder to be deleted

Throws:

FdkException - if the operation fails.

queueRecordsInErrorForRetry

public void queueRecordsInErrorForRetry(long parentId)
                                 throws FdkException

Queues the records in error for the given record category or record folder as ready for retry.

Parameters:

parentId - id of the recordcategory or recordfolder of interest

Throws:

FdkException - if the operation fails.

makeRecord

public Item makeRecord(long parentId,
                       long docId,
                       NamedValue[] attrs,
                       AttributeRequest[] attributes)
                throws FdkException

Make a publicobject a record. COPY_TARGET_NAME option is deprecated. To recordize a document multiple times, create a copy of the document first and then recordize using RecordsManager.makeRecord().

Parameters:

parentId - id of the parent record category or folder

docId - id of the document to be made a record

attrs - array of attributes that apply to the record

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Options.COPY_TARGET_NAME, String}
• {Options.EXTERNAL_RECORD_DEFINITION, NamedValue[]} Where array contains two attributes namely, Attributes.EXTERNAL_RECORD_LOCATOR and Attributes.EXTERNAL_RECORDS_AGENCY

attributes - requested attributes for each item, or null.

Returns:

item representing the record that was created

Throws:

FdkException - if the operation fails.

updateRecord

public Item updateRecord(long parentId,
                         long recordId,
                         NamedValue[] attrs,
                         AttributeRequest[] attributes)
                  throws FdkException

update a record.

Parameters:

parentId - id of the parent record category or folder

recordId - id of the record

attrs - array of attributes that apply to the record

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String} Any other custom attributes applicable to the record

attributes - requested attributes for the record item, or null.

Returns:

item representing the record that was updated

Throws:

FdkException - if the operation fails.

getRecordizedObject

public Item getRecordizedObject(long recordId,
                                AttributeRequest[] attributes)
                         throws FdkException

Gets the public object that has been recordized using the record whose id is passed in the argument.

Parameters:

recordId - id of record

attributes - requested attributes for each item, or null.

Returns:

Item representing the object that was recordized.

Throws:

FdkException - if the operation fails

unRecordize

public void unRecordize(long parentId,
                        long docId)
                 throws FdkException

unRecordize the record from the given recordcategory or recordfolder

Parameters:

parentId - Id of the parent recordcategory or recordfolder

docId - Id of the document that is recordized

Throws:

FdkException - if the operation fails

getFilePlan

public Item getFilePlan(java.lang.String name,
                        AttributeRequest[] attributes)
                 throws FdkException

return FilePlan of the given name if it exists or return null if there is no fileplan by that name

Parameters:

name - name of the fileplan

attributes - requested attributes for each item, or null.

Throws:

FdkException - if the operation fails

getRecordSeries

public Item getRecordSeries(long fileplanId,
                            java.lang.String name,
                            AttributeRequest[] attributes)
                     throws FdkException

return RecordSeries of the given name if it exists under the fileplan or return null if there is no record series by that name

Parameters:

fileplanId - Id of the parent file plan

name - name of the record series

attributes - requested attributes for each item, or null.

Throws:

FdkException - if the operation fails

getRecordCategory

public Item getRecordCategory(long parentId,
                              java.lang.String name,
                              AttributeRequest[] attributes)
                       throws FdkException

return RecordCategory of the given name if it exists under the fileplan or record series (in that order) or return null if there is no record category by that name

Parameters:

parentId - Id of the parent file plan or record series

name - name of the record category

attributes - requested attributes for each item, or null.

Throws:

FdkException - if the operation fails

getRecordFolder

public Item getRecordFolder(long recordCategoryId,
                            java.lang.String name,
                            AttributeRequest[] attributes)
                     throws FdkException

return RecordFolder of the given name if it exists under the record category or return null if there is no record folder by that name

Parameters:

recordCategoryId - Id of the parent record category

name - name of the record folder

attributes - requested attributes for each item, or null.

Throws:

FdkException - if the operation fails

setRecordConfiguration

public void setRecordConfiguration(long folderId,
                                   NamedValue[] config)
                            throws FdkException

Sets or updates the RecordConfiguration for a Folder. The entire configuration will replaced as a set and not added to the existing one. AttributeOverrides are replaced as a set. To change one, you must specify all overrides. To remove all overrides, explicitly set ATTRIBUTE_OVERRIDE to null.

Parameters:

folderId - the folder for which to set the Record configuration

config - the Record configuration options to set; must include one or more of the following Attributes:

• notation: {Attribute name, Attribute type}
• {Attributes.ALLOW_ALL_RECORDS, Boolean}
• {Attributes.ALLOWED_RECORD_CATEGORIES, Array of long, each of which is a record category/folder id.}
• {Attributes.REQUIRED_RECORD_CATEGORY. Valid values are Array of long, with one element or a Long, which is a record category/folder id}
• {Attributes.CONFIGURATION_FINAL, Boolean}
• {Attributes.CONFIGURATION_ENABLED, Boolean}
• {Attributes.ATTRIBUTE_OVERRIDE, NamedValue []}
  • {Attributes.ATTRIBUTE_OVERRIDE_ATTRIBUTE, id}
  • {Attributes.ATTRIBUTE_OVERRIDE_DEFAULT, Object}
  • {Attributes.ATTRIBUTE_OVERRIDE_DEFAULT_SET, Boolean}
  • {Attributes.ATTRIBUTE_OVERRIDE_PROMPT, Boolean}
  • {Attributes.ATTRIBUTE_OVERRIDE_REQUIRED, Boolean}
  • {Attributes.ATTRIBUTE_OVERRIDE_SETTABLE, Boolean}

Throws:

FdkException - if the operation fails.

removeRecordConfiguration

public void removeRecordConfiguration(long folderId)
                               throws FdkException

remove the existing RecordConfiguration for a Folder

Parameters:

folderId - the folder for which to remove the Record configuration

Throws:

FdkException - if the operation fails.

getRequiredRecordCategory

public Item getRequiredRecordCategory(long folderId,
                                      AttributeRequest[] requestedAttributes)
                               throws FdkException

Deprecated. Request REQUIRED_RECORD_CATEGORY on RecordConfiguration

Gets the required record category for a folder.

Parameters:

folderId - folder for to fetch the record categories

requestedAttributes - list of attributes needed for each item

Returns:

Required record category for this folder; null if no record category is marked as required.

Throws:

FdkException - if the operation fails