oracle.ifs.fdk
Interface RecordsManager

public interface RecordsManager

The Records management Facade interface

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	createExternalRecordsAgency(NamedValue[] attrs, AttributeRequest[] attributes) create a external records agency under the current domain.
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 parentId.
Item	createRecordSeries(long fileplanId, NamedValue[] attrs, AttributeRequest[] attributes) create a record series under the file plan
void	deleteExternalRecordsAgency(long agencyId) Delete the ExternalRecordsAgency with the given Id Only an empty ExternalRecordsAgency can be deleted i.e there cannot be any records under it.
void	deleteFilePlan(long fileplanId) 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.
void	deleteRecordCategory(long rcId) 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.
void	deleteRecordFolder(long rcId) Delete the record folder with the given Id Only an empty recordfolder can be deleted i.e there cannot be any records under it.
void	deleteRecordSeries(long rsId) Delete the recordseries with the given Id Only an empty recordseries can be deleted i.e there cannot be any record categories under it.
Item[]	getChildren(long parentId, NamedValue[] def, AttributeRequest[] attreqss) For a given RecordsManagement object return its direct children For a Fileplan, it returns the recordseries and record categories under it For a RecordCategory, it returns the records and recordfolders under it For a RecordSeries, it returns the recordcategories 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 Assumes the attribute contains sorting information
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 fileplanId, 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) Gets the required record category for a folder.
Item[]	listExternalRecordsAgencies(NamedValue[] attr, AttributeRequest[] attributeRequests) Returns the ExternalRecordsAgencies under the current domain.
Item[]	listFilePlans(NamedValue[] attr, AttributeRequest[] attrs) Returns the file plans under the current domain.
Item[]	listRecordCategories(long parentId, NamedValue[] def, AttributeRequest[] attreqss) 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 def array contains sorting information
Item[]	listRecordFolders(long parentId, NamedValue[] def, AttributeRequest[] attreqss) Returns the record folders under the given record category.
Item[]	listRecordSeries(long fileplanId, NamedValue[] attr, AttributeRequest[] attreqs) 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 Assumes the attribute contains sorting information
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 rcId) Queues the records in error for the given record category 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 the RecordConfiguration for a Folder, replacing any existing RecordConfiguration.
void	unRecordize(long parentId, long docId) unRecordize the record from the given recordcategory or recordfolder
Item	updateExternalRecordsAgency(long agencyId, NamedValue[] attrs, AttributeRequest[] attributes) Update attributes of a given external records agency.
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

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:

attributedef - array of NamedValue for adding a new attribute

• {Attributes.ATTRIBUTE_DETAIL, NamedValue[]}
  • {Attributes.ATTRIBUTE_NAME, String}
  • {Attributes.ATTRIBUTE_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_BOOLEAN
    • FdkConstants.ATTRIBUTE_TYPE_FLOAT
    • FdkConstants.ATTRIBUTE_TYPE_USER
    • FdkConstants.ATTRIBUTE_TYPE_GROUP
  • {Attributes.ATTRIBUTE_DEFAULT, type}
  • {Attributes.ATTRIBUTE_ENUMERATION, [] type}

  attrrequest - requested attributes for each item, or null.

  Returns:

  id of the newly created attribute

  Throws:

  FdkException - if the operation fails

  (Published)

createExternalRecordsAgency

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

create a external records agency under the current domain.

Parameters:

attrs - array of attributes for creating the external records agency.

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}, Required
• {Attributes.DESCRIPTION, String}
• {Attributes.EXTERNAL_AGENCY_EMAIL_ADDRESS, String}
• {Attributes.EXTERNAL_AGENCY_PHONE, String}
• {Attributes.EXTERNAL_AGENCY_ADDRESS, String}
• {Attributes.EXTERNAL_AGENCY_CONTACTS, Long []}, Required each corresponding to a directory user id

attributes - requested attributes for each item, or null.

Returns:

Item the ExternalRecordsAgency Item that was created

Throws:

FdkException - if the operation fails.

(Unpublished)

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}, Required
• {Attributes.DESCRIPTION, String}
• {Attributes.IS_DOD_FILEPLAN, Boolean}

attributes - requested attributes for each item, or null.

Returns:

Item the fileplan 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}, Required
• {Attributes.DESCRIPTION, String}
• @nopub {Attributes.RECORD_CATEGORY_ID, String}
• {Attributes.DISPOSITION_DESCRIPTION, String}
• {Attributes.CUTOFF_FREQUENCY, Integer}
• @nopub {Attributes.CUTOFF_FREQUENCY_MULTIPLIER, Integer}
• {Attributes.INITIAL_CUTOFF_DATE, Date}, Required
• {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}, Required.
• {Attributes.RETENTION, Long},
• {Attributes.DESTINATIONFOLDER, Long},
• {Attributes.DESTINATIONSTRING, String},
• @nopub {Attributes.DISPOSITIONEVENT, Long Id of event Item}
• @nopub {Attributes.CUTOFF_EVENT, Long Id of the event Item}
• @nopub {Attributes.CLOSE_EVENT, Long Id of the event Item}

attributes - requested attributes for each item, or null.

Returns:

Item 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 parentId. The parent can be a 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}, Required
• {Attributes.DESCRIPTION, String}
• @nopub {Attributes.RECORD_FOLDER_ID, String}
• {Attributes.INITIAL_CUTOFF_DATE, Date}
• {Attributes.ATTRIBUTE_DETAIL, NamedValue[][]}
  • each row is an array that describes a custom attribute
    • {Attributes.ATTRIBUTE_NAME, String}
    • {Attributes.ATTRIBUTE_DISPLAY_NAME, String}
    • {Attributes.ATTRIBUTE_REQUIRED, Boolean}
    • {Attributes.ATTRIBUTE_SETTABLE, Boolean}
    • {Attributes.ATTRIBUTE_UPDATEABLE, Boolean}
    • {Attributes.ATTRIBUTE_HIDDEN, 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_BOOLEAN
      • FdkConstants.ATTRIBUTE_TYPE_FLOAT
      • FdkConstants.ATTRIBUTE_TYPE_USER
      • FdkConstants.ATTRIBUTE_TYPE_GROUP
    • {Attributes.ATTRIBUTE_DEFAULT, type}
    • {Attributes.ATTRIBUTE_ENUMERATION, [] type}
• @nopub {Attributes.CUTOFF_EVENT, Long Id of the event Item}

attributes - requested attributes for each item, or null.

Returns:

Item the Record Folder 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}, Required
• {Attributes.DESCRIPTION, String}

attributes - requested attributes for each item, or null.

Returns:

Item the recordseries Item that was created

Throws:

FdkException - if the operation fails.

deleteExternalRecordsAgency

public void deleteExternalRecordsAgency(long agencyId)
                                 throws FdkException

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

Parameters:

agencyId - id of the ExternalRecordsAgency to be deleted

Throws:

FdkException - if the operation fails.

(Unpublished)

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.

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.

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.

getChildren

public Item[] getChildren(long parentId,
                          NamedValue[] def,
                          AttributeRequest[] attreqss)
                   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 RecordCategory, it returns the records and recordfolders under it For a RecordSeries, it returns the recordcategories 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 Assumes the attribute contains sorting information

Parameters:

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

def - array of namedvalues containing sorting information

Returns:

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

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

getRecordCategory

public Item getRecordCategory(long fileplanId,
                              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:

name - name of the record category

attributes - requested attributes for each item, or null.

Throws:

FdkException

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

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

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

getRequiredRecordCategory

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

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

(Published)

listExternalRecordsAgencies

public Item[] listExternalRecordsAgencies(NamedValue[] attr,
                                          AttributeRequest[] attributeRequests)
                                   throws FdkException

Returns the ExternalRecordsAgencies under the current domain. An attribute request is not required to be sent as the NAME attribute is implicitly returned from the ExternalRecordsAgency. The attribute parameter encapsulates sorting information for the result

Parameters:

attr - assumes sorting information is specified as an array of attributes

Returns:

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

Throws:

FdkException - if the operation fails.

(Unpublished)

listFilePlans

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

Returns the file plans under the current domain. This will return both DOD and non DOD compliant file plans An attribute request is not required to be sent as the NAME attribute is implicitly returned from the fileplan. The attribute paremeter encapsulates sorting information for the result

Parameters:

attr - assumes sorting information is specified as an attribute

Returns:

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

Throws:

FdkException - if the operation fails.

listRecordCategories

public Item[] listRecordCategories(long parentId,
                                   NamedValue[] def,
                                   AttributeRequest[] attreqss)
                            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 def array contains sorting information

Parameters:

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

def - attribute array containing sorting information

Returns:

item 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[] attreqss)
                         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 attribute contains sorting information

Parameters:

parentId - id of the record category of interest.

def - attribute array containing sorting information

Returns:

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

Throws:

FdkException - if the operation fails.

listRecordSeries

public Item[] listRecordSeries(long fileplanId,
                               NamedValue[] attr,
                               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 Assumes the attribute contains sorting information

Parameters:

fileplanId - id of the fileplan

attr - sorting information is specified as a namedvalue array

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

Returns:

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

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. If the intention is to make an external record, then do not supply a docId (pass in 0). Supply the option Options.EXTERNAL_RECORD_DEFINITION.

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 item representing the record that was created

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.ATTRIBUTE_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}

  attrrequest - requested attributes for each item, or null.

  Returns:

  newly modified METADATA_ATTRIBUTE

  Throws:

  FdkException - if the operation fails

  (Published)

queueRecordsInErrorForRetry

public void queueRecordsInErrorForRetry(long rcId)
                                 throws FdkException

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

Parameters:

rcId - id of the recordcategory of interest

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.

Throws:

FdkException

(Published)

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.

setRecordConfiguration

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

Sets the RecordConfiguration for a Folder, replacing any existing RecordConfiguration.

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_RECORDS, Array of long, each of which is a record category/folder id.}
• {Attributes.REQUIRED_RECORD, Array of long, with one element, which is a record category/folder id.}
• {Attributes.CONFIGURATION_FINAL, Boolean}
• {Attributes.CONFIGURATION_ENABLED, Boolean}
• {Attributes.ATTRIBUTE_OVERRIDE, NamedValue [][]}
  • each row is an array that describes a custom attribute
    • {Attributes.ATTRIBUTE_OVERRIDE_ATTRIBUTE, id}
    • {Attributes.ATTRIBUTE_OVERRIDE_DEFAULT, Object}
    • {Attributes.ATTRIBUTE_OVERRIDE_PROMPT, Boolean}
    • {Attributes.ATTRIBUTE_OVERRIDE_REQUIRED, Boolean}
    • {Attributes.ATTRIBUTE_OVERRIDE_SETTABLE, Boolean}

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

updateExternalRecordsAgency

public Item updateExternalRecordsAgency(long agencyId,
                                        NamedValue[] attrs,
                                        AttributeRequest[] attributes)
                                 throws FdkException

Update attributes of a given external records agency.

Parameters:

agencyId - id of the external agency that needs to be updated.

attrs - array of attributes for creating the external records agency.

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.EXTERNAL_AGENCY_EMAIL_ADDRESS, String}
• {Attributes.EXTERNAL_AGENCY_PHONE, String}
• {Attributes.EXTERNAL_AGENCY_ADDRESS, String}
• {Attributes.EXTERNAL_AGENCY_CONTACTS, Long []} each corresponding to a directory user id

attributes - requested attributes for each item, or null.

Throws:

FdkException - if the operation fails.

(Unpublished)

updateFilePlan

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

update a file plan under the current domain

Parameters:

attrs - array of attributes for updating the fileplan

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

  attributes - requested attributes for each item, or null.

  Returns:

  Item the item representing the fileplan that was updated

  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 item representing the record 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:

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}
• @nopub {Attributes.CUTOFF_FREQUENCY_MULTIPLIER, 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.DESTINATIONFOLDER, Long},
• {Attributes.DESTINATIONSTRING, String},
• @nopub {Attributes.DISPOSITIONEVENT, Long Id of event Item}
• {Attributes.IS_CLOSED, Boolean}
• {Attributes.IS_FROZEN, Boolean}
• @nopub {Attributes.CUTOFF_EVENT, Long Id of event Item}
• @nopub {Attributes.CLOSE_EVENT, Long Id of event Item}

attributes - requested attributes for each item, or null.

Returns:

Item 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:

attrs - array of attributes for updating the recordFolder

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• @nopub {Attributes.RECORD_FOLDER_ID, String}
• {Attributes.IS_CLOSED, Boolean}
• {Attributes.IS_FROZEN, Boolean}
• {Attributes.INITIAL_CUTOFF_DATE, Date}
• {Attributes.CUTOFF_FREQUENCY, Integer}
• @nopub {Attributes.CUTOFF_EVENT, Long Id of the event Item}

attributes - requested attributes for each item, or null.

Returns:

Item the record folder Item 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:

  Item the item representing the recordseries that was updated

  Throws:

  FdkException - if the operation fails.