Interface DataSetService
-
- All Known Implementing Classes:
DataSetServiceImpl
public interface DataSetService
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
existsDataSet(String dataSetId)
Checks if a data set exists with the given data set idMap<String,DataSet>
getDataSets()
Gets the details of all available data sets.Map<String,DataSet>
getDataSets(org.alfresco.service.cmr.repository.NodeRef filePlan, boolean excludeLoaded)
Gets the details of all available data sets for a file plan depending on the parameter "excludeLoaded".Map<String,DataSet>
getLoadedDataSets(org.alfresco.service.cmr.repository.NodeRef filePlan)
Gets the details of all loaded data sets for a specified file planboolean
isLoadedDataSet(org.alfresco.service.cmr.repository.NodeRef filePlan, String dataSetId)
Checks if a data set with the id "dataSetId" has been loaded into the specified file planvoid
loadDataSet(org.alfresco.service.cmr.repository.NodeRef filePlan, String dataSetId)
Loads the data set with the specified id into the specified file planvoid
register(DataSet dataSet)
Register a data set implementation with the service
-
-
-
Method Detail
-
register
void register(DataSet dataSet)
Register a data set implementation with the service- Parameters:
dataSet
- the data set
-
getDataSets
Map<String,DataSet> getDataSets()
Gets the details of all available data sets.- Returns:
- the Map<String, DataSet> with details of all available data sets
-
getDataSets
Map<String,DataSet> getDataSets(org.alfresco.service.cmr.repository.NodeRef filePlan, boolean excludeLoaded)
Gets the details of all available data sets for a file plan depending on the parameter "excludeLoaded".- Parameters:
filePlan
- the file plan for which the details should be retrievedexcludeLoaded
- if true only data sets will be retrieved which has not been loaded- Returns:
- Map<String, DataSet> with details of the available data sets for a specified file plan depending on the parameter "excludeLoaded". The result could also be an empty map
-
getLoadedDataSets
Map<String,DataSet> getLoadedDataSets(org.alfresco.service.cmr.repository.NodeRef filePlan)
Gets the details of all loaded data sets for a specified file plan- Parameters:
filePlan
- the file plan for which the loaded data sets should be retrieved- Returns:
- Map<String, DataSet> details of all loaded data sets or an empty map if there has not been any data sets loaded for the specified file plan
-
loadDataSet
void loadDataSet(org.alfresco.service.cmr.repository.NodeRef filePlan, String dataSetId)
Loads the data set with the specified id into the specified file plan- Parameters:
filePlan
- the file plan which the data set will load intodataSetId
- the id of the data set which will be imported
-
existsDataSet
boolean existsDataSet(String dataSetId)
Checks if a data set exists with the given data set id- Parameters:
dataSetId
- the id of the data set which will be checked- Returns:
- true if the data set exists, false otherwise
-
isLoadedDataSet
boolean isLoadedDataSet(org.alfresco.service.cmr.repository.NodeRef filePlan, String dataSetId)
Checks if a data set with the id "dataSetId" has been loaded into the specified file plan- Parameters:
filePlan
- the file plan for which the check should be donedataSetId
- the id of the data set which should be checked if it has been loaded to the file plan- Returns:
- true if the data set with the specified id has been loaded into the specified file plan, false otherwise
-
-