public interface RecordsManagementDataService
| 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.
|
FilePlanData getFilePlan(String filePlanName) throws RecordsManagementBenchmarkException
filePlanName - (String) name of the file plan to retrieve.RecordsManagementBenchmarkException - if file plan not available or errorFilePlanData getDefaultFilePlan() throws RecordsManagementBenchmarkException
RecordsManagementBenchmarkException - if no default file plan available or errorFilePlanData getRandomFilePlan() throws RecordsManagementBenchmarkException
RecordsManagementBenchmarkException - if no file plan available or errorvoid addFilePlan(FilePlanData data)
data - (FilePlanData, required) file plan to add.long countFilePlans()
long countFilePlans(org.alfresco.bm.data.DataCreationState creationState)
creationState - (DataCreationState, optional) creation state, if null number of all file plans will be returned.List<FilePlanData> getFilePlans()
List<FilePlanData> getFilePlans(org.alfresco.bm.data.DataCreationState creationState)
creationState - (DataCreationState, optional) creation state, if null all file plans will be returned.RecordCategoryData getRecordCategory(String categoryName) throws RecordsManagementBenchmarkException
categoryName - (String) name of the record category to retrieve.RecordsManagementBenchmarkException - if record category not available or errorRecordCategoryData getRandomRecordCategory()
RecordsManagementBenchmarkException - if no record category available or errorvoid addRecordCategory(RecordCategoryData recordCategory)
recordCategory - (RecordCategoryData, required) record category to add.long countRecordCategories()
long countRecordCategories(org.alfresco.bm.data.DataCreationState creationState)
creationState - (DataCreationState, required) creation state.List<RecordCategoryData> getRecordCategories()
List<RecordCategoryData> getRecordCategories(org.alfresco.bm.data.DataCreationState creationState)
creationState - (DataCreationState, optional) data creation state or null to return all record categories.Copyright © 2016. All rights reserved.