org.alfresco.bm.dataload.rm.services

Interface RecordsManagementDataService

public interface RecordsManagementDataService

Access of Records Management file plan

Since:

2.6

Author:

Frank Becker

Method Summary

Modifier and Type	Method and Description
void	addFilePlan(FilePlanData data) Adds a file plan.
void	addRecordCategory(RecordCategoryData recordCategory) Adds a record category to MongoDB.
long	countFilePlans() Returns the total number of file plans independent from the creation status.
long	countFilePlans(org.alfresco.bm.data.DataCreationState creationState) Returns the number of file plans with the given creations state.
long	countRecordCategories() Counts the number of record categories independent from the creation status - returns the number of all known record categories.
long	countRecordCategories(org.alfresco.bm.data.DataCreationState creationState) Returns the number of record categories with the given creations state.
FilePlanData	getDefaultFilePlan() Returns the default file plan.
FilePlanData	getFilePlan(String filePlanName) Returns the file plan by it's unique name.
List<FilePlanData>	getFilePlans() Returns all file plans in a collection.
List<FilePlanData>	getFilePlans(org.alfresco.bm.data.DataCreationState creationState) Returns all file plans of a given creation state in a collection.
FilePlanData	getRandomFilePlan() Returns a random file plan data object.
RecordCategoryData	getRandomRecordCategory() Returns a random record category.
List<RecordCategoryData>	getRecordCategories() Returns all record categories.
List<RecordCategoryData>	getRecordCategories(org.alfresco.bm.data.DataCreationState creationState) Returns all record categories of the chosen data category.
RecordCategoryData	getRecordCategory(String categoryName) Returns the record category in a file plan by name.

Method Detail

getFilePlan

FilePlanData getFilePlan(String filePlanName)
                  throws RecordsManagementBenchmarkException

Returns the file plan by it's unique name.

Parameters:

filePlanName - (String) name of the file plan to retrieve.

Returns:

(FilePlanData) file plan by it's unique name.

Throws:

RecordsManagementBenchmarkException - if file plan not available or error

getDefaultFilePlan

FilePlanData getDefaultFilePlan()
                         throws RecordsManagementBenchmarkException

Returns the default file plan.

Returns:

(FilePlanData) default file plan.

Throws:

RecordsManagementBenchmarkException - if no default file plan available or error

getRandomFilePlan

FilePlanData getRandomFilePlan()
                        throws RecordsManagementBenchmarkException

Returns a random file plan data object.

Returns:

(FilePlanData) random file plan data object.

Throws:

RecordsManagementBenchmarkException - if no file plan available or error

addFilePlan

void addFilePlan(FilePlanData data)

Adds a file plan.

Parameters:

data - (FilePlanData, required) file plan to add.

countFilePlans

long countFilePlans()

Returns the total number of file plans independent from the creation status.

Returns:

the total number of file plans independent from the creation status.

countFilePlans

long countFilePlans(org.alfresco.bm.data.DataCreationState creationState)

Returns the number of file plans with the given creations state.

Parameters:

creationState - (DataCreationState, optional) creation state, if null number of all file plans will be returned.

Returns:

number of file plans with the given creations state.

getFilePlans

List<FilePlanData> getFilePlans()

Returns all file plans in a collection.

Returns:

(List) all file plans in a collection.

getFilePlans

List<FilePlanData> getFilePlans(org.alfresco.bm.data.DataCreationState creationState)

Returns all file plans of a given creation state in a collection.

Parameters:

creationState - (DataCreationState, optional) creation state, if null all file plans will be returned.

Returns:

(List) all file plans of a given creation state in a collection.

getRecordCategory

RecordCategoryData getRecordCategory(String categoryName)
                              throws RecordsManagementBenchmarkException

Returns the record category in a file plan by name.

Parameters:

categoryName - (String) name of the record category to retrieve.

Returns:

(RecordCategoryData) the record category in a file plan by name.

Throws:

RecordsManagementBenchmarkException - if record category not available or error

getRandomRecordCategory

RecordCategoryData getRandomRecordCategory()

Returns a random record category.

Returns:

(RecordCategoryData) random record category.

Throws:

RecordsManagementBenchmarkException - if no record category available or error

addRecordCategory

void addRecordCategory(RecordCategoryData recordCategory)

Adds a record category to MongoDB.

Parameters:

recordCategory - (RecordCategoryData, required) record category to add.

countRecordCategories

long countRecordCategories()

Counts the number of record categories independent from the creation status - returns the number of all known record categories.

Returns:

the number of all known record categories

countRecordCategories

long countRecordCategories(org.alfresco.bm.data.DataCreationState creationState)

Returns the number of record categories with the given creations state.

Parameters:

creationState - (DataCreationState, required) creation state.

Returns:

number of record categories with the given creations state.

getRecordCategories

List<RecordCategoryData> getRecordCategories()

Returns all record categories.

Returns:

(List) all record categories.

getRecordCategories

List<RecordCategoryData> getRecordCategories(org.alfresco.bm.data.DataCreationState creationState)

Returns all record categories of the chosen data category.

Parameters:

creationState - (DataCreationState, optional) data creation state or null to return all record categories.

Returns:

(List) all record categories of the chosen data category.