au.edu.archer.service.icat.api
Interface ICATService

All Known Implementing Classes:

ICATServiceImpl

public interface ICATService

ICAT service managing ICAT installation.

Method Summary

au.edu.archer.domain.icat.api.DataSet	addDatasetToAnExpr(DatasetRequest request) Persist dataset.
au.edu.archer.domain.icat.api.Investigation	addExperimentToProject(ExperimentRequest request) Persist experiment.
au.edu.archer.domain.icat.api.Study	addProject(ProjectRequest request) Persist project.
au.edu.archer.domain.icat.api.Sample	addSampleToExperiment(SampleRequest request) Add sample to experiment.
au.edu.archer.domain.icat.api.DataSet	copyDataset(int datasetId, int experimentId, java.lang.String handle) Copy DataSet to another experiment.
void	deleteDataFile(int id) Delete DataFile by id.
void	deleteDataset(DatasetRequest request) Delete dataset.
void	deleteExperiment(ExperimentRequest request) Delete experiment.
void	deleteProject(ProjectRequest request) Delete project.
void	deleteSample(SampleRequest request) Delete sample.
java.util.List<au.edu.archer.domain.icat.api.DataFileFormat>	getAllDataFileFormat() Get all existing DataFileFormats.
java.util.List<au.edu.archer.domain.icat.api.DataFile>	getAllDatasetFiles(int datasetId) Get all associated datafiles for a dataset.
java.util.List<au.edu.archer.domain.icat.api.DataSet>	getAllDatasetsByExpr(int experimentId) Get all associasted datasets.
java.util.List<au.edu.archer.domain.icat.api.DataSet>	getAllDatasetsBySampleId(int sampleId) Get all associasted datasets with a sample.
java.util.List<au.edu.archer.domain.icat.api.DataSetStatus>	getAllDatasetStatus() Get all available DataSet status.
java.util.List<au.edu.archer.domain.icat.api.DataSetType>	getAllDatasetType() Get all available Dataset Types.
java.util.List<au.edu.archer.domain.icat.api.Investigation>	getAllExperimentsByProjectId(int projId) Get all experiments by a project id.
java.util.List<au.edu.archer.domain.icat.api.InvestigationType>	getAllExperimentTypes() Get all available experiment types.
java.util.List<au.edu.archer.domain.icat.api.FacilityUser>	getAllFacilityUsers() Get list of all available facility users.
java.util.List<au.edu.archer.domain.icat.api.Keyword>	getAllKeywordsByExperimentId(int expId) Get all keywords by the experiment id.
java.util.List<au.edu.archer.domain.icat.api.DataSet>	getAllNonPackagedDatasetByExpId(int experimentId) Get all non-packaged datasets.
java.util.List<au.edu.archer.domain.icat.api.DataSetType>	getAllNonPackagedDatasetType() Get all non-package DataSet status.
java.util.List<au.edu.archer.domain.icat.api.Study>	getAllProjects() Get all projects.
java.util.List<au.edu.archer.domain.icat.api.StudyStatus>	getAllProjectStatus() Retrieve all available project status.
java.util.List<au.edu.archer.domain.icat.api.Sample>	getAllSamplesByExpId(SampleRequest request) Get all samples by experiment id.
java.util.List<au.edu.archer.domain.icat.api.Sample>	getAllSamplesByExpName(SampleRequest request) Get all samples by experiment name.
au.edu.archer.domain.icat.api.DataFile	getDataFile(int dfId) Get DataFile by id.
au.edu.archer.domain.icat.api.DataFile	getDataFile(java.lang.String projectName, java.lang.String experimentName, java.lang.String datasetName, java.lang.String datafileName) Get DataFile by name.
java.util.List<au.edu.archer.domain.icat.api.DataFileParameter>	getDataFileParametersById(DatafileRequest request) Retrieve datafile parameters.
java.util.Map<java.lang.String,DatafileSliceResponse>	getDatafileSliceByDatasetId(int datasetId) Get all datafile slices by a dataset id.
au.edu.archer.domain.icat.api.DataSet	getDataSetById(int datasetId) Get DataSet by Id.
au.edu.archer.domain.icat.api.DataSet	getDataSetByName(java.lang.String projectName, java.lang.String exprName, java.lang.String datasetName) Get Dataset by Name.
int	getDatasetIdByHandle(java.lang.String handleId) Get dataset id by dataset handle id.
java.util.List<au.edu.archer.domain.icat.api.DataSetParameter>	getDataSetParametersById(DatasetRequest request) Retrieve dataset parameters.
au.edu.archer.domain.icat.api.DataSetStatus	getDatasetStatusByName(java.lang.String datasetStatus) Get Dataset status by name.
au.edu.archer.domain.icat.api.DataSetType	getDatasetTypeByName(java.lang.String datasetType) Get Dataset type by name.
au.edu.archer.domain.icat.api.Investigation	getExperimentById(int expId) Get experiment by experiment id.
au.edu.archer.domain.icat.api.Investigation	getExperimentByName(java.lang.String invName, java.lang.String projectName) Retrieve a experiment by name.
au.edu.archer.domain.icat.api.InvestigationType	getExperimentTypeByName(java.lang.String type) Get the InvestigationType object by name.
au.edu.archer.domain.icat.api.FacilityUser	getFacilityUserById(int mgrId) Get facility user by Id.
java.util.List<au.edu.archer.domain.icat.api.DataSet>	getPackagedDatasetsByExpId(int experimentId) Get all packaged datasets.
au.edu.archer.domain.icat.api.Study	getProjectById(int projectId) Retrieve a project by id.
au.edu.archer.domain.icat.api.Study	getProjectByName(java.lang.String projectName) Retrieve a project by name.
au.edu.archer.domain.icat.api.StudyStatus	getProjectStatusByName(java.lang.String studyStatus) Get the StudyStatus object by name.
au.edu.archer.domain.icat.api.Sample	getSampleById(SampleRequest request) Get sample by sample id.
java.util.List<au.edu.archer.domain.icat.api.SampleParameter>	getSampleParametersById(SampleRequest request) Retrieve sample parameters.
au.edu.archer.domain.icat.api.Topic	getTopicById(int id) Get the Topic by Topic Id.
au.edu.archer.domain.icat.api.DataFile	insertMetadata(byte[] xmlMetadata, long fileSize, java.lang.String srbLocation, int datasetId) Insert the extracted meta data.
java.util.List<au.edu.archer.domain.icat.api.Investigator>	listAllInvestigatorsByExperimentId(int expid) List all investigators by experiment id.
java.util.List<au.edu.archer.domain.icat.api.TopicList>	listAllTopicListsByExperimentId(int expid) List all TopicLists by ExperimentId.
java.util.List<au.edu.archer.domain.icat.api.Topic>	listAllTopics() List of all Topics.
au.edu.archer.domain.icat.api.DataSet	moveDataset(int datasetId, int experimentId) Move DataSet to another experiment.
au.edu.archer.domain.icat.api.DataFile	retrieveMetadata(java.lang.String srbLocation) Retrieve Metadata information based on srbLocation.
au.edu.archer.domain.icat.impl.DataFileImpl	updateDataFile(au.edu.archer.domain.icat.api.DataFile df) Update Datafile object.
void	updateDatafileParameteres(DatafileRequest request) Add datafile parameteres.
au.edu.archer.domain.icat.api.DataSet	updateDataset(DatasetRequest request) Update dataset.
void	updateDatasetParameteres(DatasetRequest request) Update dataset parameters.Also referred as dataset variable metadata.
au.edu.archer.domain.icat.api.Investigation	updateExperiment(ExperimentRequest request) Update experiment.
au.edu.archer.domain.icat.api.Study	updateProject(ProjectRequest request) Update project.
au.edu.archer.domain.icat.api.Sample	updateSample(SampleRequest request) Update sample.
void	updateSampleParameters(SampleRequest request) Add sample parameteres.

Method Detail

getFacilityUserById

au.edu.archer.domain.icat.api.FacilityUser getFacilityUserById(int mgrId)
                                                               throws ICATServiceException

Get facility user by Id.

Parameters:

mgrId - user id.

Returns:

FacilityUser object.

Throws:

ICATServiceException - if an error occurs while processing icat request.

getAllFacilityUsers

java.util.List<au.edu.archer.domain.icat.api.FacilityUser> getAllFacilityUsers()
                                                                               throws ICATServiceException

Get list of all available facility users.

Returns:

list of FacilityUser object.

Throws:

ICATServiceException - if an error occurs while processing icat request.

getProjectStatusByName

au.edu.archer.domain.icat.api.StudyStatus getProjectStatusByName(java.lang.String studyStatus)
                                                                 throws ICATServiceException

Get the StudyStatus object by name.

Parameters:

studyStatus - study statuc name.

Returns:

StudyStatus object

Throws:

ICATServiceException - if an error occurs while processing icat request.

getAllProjectStatus

java.util.List<au.edu.archer.domain.icat.api.StudyStatus> getAllProjectStatus()
                                                                              throws ICATServiceException

Retrieve all available project status.

Returns:

Map of project status.

Throws:

ICATServiceException - if an error occurs while processing icat request.

getProjectById

au.edu.archer.domain.icat.api.Study getProjectById(int projectId)
                                                   throws ICATServiceException

Retrieve a project by id.

Parameters:

projectId - id.

Returns:

Study object.

Throws:

ICATServiceException - if an error occurs while processing icat request.

getProjectByName

au.edu.archer.domain.icat.api.Study getProjectByName(java.lang.String projectName)
                                                     throws ICATServiceException

Retrieve a project by name.

Parameters:

projectName - name.

Returns:

Study object.

Throws:

ICATServiceException - if an error occurs while processing icat request.

addProject

au.edu.archer.domain.icat.api.Study addProject(ProjectRequest request)
                                               throws InvalidICATRequestException,
                                                      ICATServiceException

Persist project.

Parameters:

request - ProjectRequest object.

Returns:

newly created project object.

Throws:

InvalidICATRequestException - if invalid request received for processing.

ICATServiceException - if an error occurs while processing icat request.

updateProject

au.edu.archer.domain.icat.api.Study updateProject(ProjectRequest request)
                                                  throws InvalidICATRequestException,
                                                         ICATServiceException

Update project.

Parameters:

request - ProjectRequest object.

Returns:

updated Project object.

Throws:

InvalidICATRequestException - if invalid request received for processing.

ICATServiceException - if an error occurs while processing icat request.

deleteProject

void deleteProject(ProjectRequest request)
                   throws InvalidICATRequestException,
                          ICATServiceException

Delete project.

Parameters:

request - ProjectRequest object.

Throws:

InvalidICATRequestException - if invalid request received for processing.

ICATServiceException - if an error occurs while processing icat request.

getDatasetIdByHandle

int getDatasetIdByHandle(java.lang.String handleId)

Get dataset id by dataset handle id.

Parameters:

handleId - dataset handle id.

Returns:

dataset id.

getDatasetStatusByName

au.edu.archer.domain.icat.api.DataSetStatus getDatasetStatusByName(java.lang.String datasetStatus)
                                                                   throws ICATServiceException

Get Dataset status by name.

Parameters:

datasetStatus - status name.

Returns:

DataSetStatus object.

Throws:

ICATServiceException - if an error occurs while processing icat request.

getAllDatasetStatus

java.util.List<au.edu.archer.domain.icat.api.DataSetStatus> getAllDatasetStatus()
                                                                                throws ICATServiceException

Get all available DataSet status.

Returns:

List of DataSetType

Throws:

ICATServiceException - if an error occurs while processing icat request.

getDatasetTypeByName

au.edu.archer.domain.icat.api.DataSetType getDatasetTypeByName(java.lang.String datasetType)
                                                               throws ICATServiceException

Get Dataset type by name.

Parameters:

datasetType - type

Returns:

DataSetType object.

Throws:

ICATServiceException - if an error occurs while processing icat request.

getAllNonPackagedDatasetType

java.util.List<au.edu.archer.domain.icat.api.DataSetType> getAllNonPackagedDatasetType()
                                                                                       throws ICATServiceException

Get all non-package DataSet status.

Returns:

List of DataSetType

Throws:

ICATServiceException - if an error occurs while processing icat request.

getAllNonPackagedDatasetByExpId

java.util.List<au.edu.archer.domain.icat.api.DataSet> getAllNonPackagedDatasetByExpId(int experimentId)
                                                                                      throws ICATServiceException

Get all non-packaged datasets.

Parameters:

experimentId - id.

Returns:

List of DataSet objects.

Throws:

ICATServiceException

getAllDatasetType

java.util.List<au.edu.archer.domain.icat.api.DataSetType> getAllDatasetType()
                                                                            throws ICATServiceException

Get all available Dataset Types.

Returns:

List of DataSetType obj.

Throws:

ICATServiceException - if an error occurs while processing icat request.

getDataSetById

au.edu.archer.domain.icat.api.DataSet getDataSetById(int datasetId)
                                                     throws ICATServiceException

Get DataSet by Id.

Parameters:

datasetId - id.

Returns:

DataSet object.

Throws:

ICATServiceException - if an error occurs while processing icat request.

getDataSetByName

au.edu.archer.domain.icat.api.DataSet getDataSetByName(java.lang.String projectName,
                                                       java.lang.String exprName,
                                                       java.lang.String datasetName)
                                                       throws InvalidICATRequestException,
                                                              ICATServiceException

Get Dataset by Name.

Parameters:

projectName - project name.

exprName - experiment name.

datasetName - dataset name.

Returns:

DataSet object.

Throws:

InvalidICATRequestException - thrown when an invalid icat request is received.

ICATServiceException - if an error occurs while processing icat request.

getAllDatasetsByExpr

java.util.List<au.edu.archer.domain.icat.api.DataSet> getAllDatasetsByExpr(int experimentId)

Get all associasted datasets.

Parameters:

experimentId - id.

Returns:

List of DataSet objects.

getPackagedDatasetsByExpId

java.util.List<au.edu.archer.domain.icat.api.DataSet> getPackagedDatasetsByExpId(int experimentId)
                                                                                 throws ICATServiceException

Get all packaged datasets.

Parameters:

experimentId - id.

Returns:

List of DataSet objects.

Throws:

ICATServiceException

getAllDatasetsBySampleId

java.util.List<au.edu.archer.domain.icat.api.DataSet> getAllDatasetsBySampleId(int sampleId)

Get all associasted datasets with a sample.

Parameters:

sampleId - id.

Returns:

List of DataSet objects.

getAllDatasetFiles

java.util.List<au.edu.archer.domain.icat.api.DataFile> getAllDatasetFiles(int datasetId)

Get all associated datafiles for a dataset.

Parameters:

datasetId - dataset id.

Returns:

List of DataFile DataFile object.

addDatasetToAnExpr

au.edu.archer.domain.icat.api.DataSet addDatasetToAnExpr(DatasetRequest request)
                                                         throws InvalidICATRequestException,
                                                                ICATServiceException

Persist dataset.

Parameters:

request - DatasetRequest object.

Returns:

newly persisted dataset object.

Throws:

InvalidICATRequestException - thrown when an invalid icat request is received.

ICATServiceException - if an error occurs while processing icat request.

updateDataset

au.edu.archer.domain.icat.api.DataSet updateDataset(DatasetRequest request)
                                                    throws InvalidICATRequestException,
                                                           ICATServiceException

Update dataset.

Parameters:

request - DatasetRequest object.

Returns:

updated dataset object.

Throws:

InvalidICATRequestException - thrown when an invalid icat request is received.

ICATServiceException - if an error occurs while processing icat request.

deleteDataset

void deleteDataset(DatasetRequest request)
                   throws InvalidICATRequestException,
                          ICATServiceException

Delete dataset.

Parameters:

request - DatasetRequest object.

Throws:

InvalidICATRequestException - thrown when an invalid icat request is received.

ICATServiceException - if an error occurs while processing icat request.

updateDatasetParameteres

void updateDatasetParameteres(DatasetRequest request)
                              throws InvalidICATRequestException,
                                     ICATServiceException

Update dataset parameters.Also referred as dataset variable metadata.

Parameters:

request - DatasetRequest object.

Throws:

InvalidICATRequestException - thrown when an invalid icat request is received.

ICATServiceException - if an error occurs while processing icat request.

getDataSetParametersById

java.util.List<au.edu.archer.domain.icat.api.DataSetParameter> getDataSetParametersById(DatasetRequest request)

Retrieve dataset parameters. Also referred as dataset variable metadata.

Parameters:

request - DatasetRequest object.

Returns:

List of DatasetParameter object.

insertMetadata

au.edu.archer.domain.icat.api.DataFile insertMetadata(byte[] xmlMetadata,
                                                      long fileSize,
                                                      java.lang.String srbLocation,
                                                      int datasetId)
                                                      throws MetadataExtractionException,
                                                             InvalidICATRequestException,
                                                             ICATServiceException

Insert the extracted meta data.

Parameters:

xmlMetadata - meta data content in XML file.

fileSize - file content size.

srbLocation - String location of the file.

datasetId - dataset id.

Returns:

DataFile the DataFile persistent object saved.

Throws:

MetadataExtractionException - thrown when unable to extract the metadata.

InvalidICATRequestException - thrown when an invalid icat request is received.

ICATServiceException - if an error occurs while processing icat request.

retrieveMetadata

au.edu.archer.domain.icat.api.DataFile retrieveMetadata(java.lang.String srbLocation)
                                                        throws InvalidICATRequestException

Retrieve Metadata information based on srbLocation.

Parameters:

srbLocation - String location used when inserting metadata.

Returns:

DataFile the DataFile object.

Throws:

InvalidICATRequestException - thrown when an invalid icat request is received.

getExperimentTypeByName

au.edu.archer.domain.icat.api.InvestigationType getExperimentTypeByName(java.lang.String type)

Get the InvestigationType object by name.

Parameters:

type - investigation type name.

Returns:

InvestigationType object.

getAllExperimentTypes

java.util.List<au.edu.archer.domain.icat.api.InvestigationType> getAllExperimentTypes()

Get all available experiment types.

Returns:

List of Experiment types.

getExperimentByName

au.edu.archer.domain.icat.api.Investigation getExperimentByName(java.lang.String invName,
                                                                java.lang.String projectName)

Retrieve a experiment by name.

Parameters:

invName - String experiment name.

projectName - String project name.

Returns:

Investigation experiment object.

addExperimentToProject

au.edu.archer.domain.icat.api.Investigation addExperimentToProject(ExperimentRequest request)
                                                                   throws ICATServiceException,
                                                                          InvalidICATRequestException

Persist experiment.

Parameters:

request - ExperimentRequest request.

Returns:

Investigation experiment.

Throws:

ICATServiceException - if an error occurs while processing icat request.

InvalidICATRequestException - thrown when an invalid icat request is received.

updateExperiment

au.edu.archer.domain.icat.api.Investigation updateExperiment(ExperimentRequest request)
                                                             throws ICATServiceException,
                                                                    InvalidICATRequestException

Update experiment.

Parameters:

request - ExperimentRequest request.

Returns:

Investigation updated investigation object.

Throws:

ICATServiceException - if an error occurs while processing icat request.

InvalidICATRequestException - if the request is invalid.

deleteExperiment

void deleteExperiment(ExperimentRequest request)
                      throws ICATServiceException,
                             InvalidICATRequestException

Delete experiment.

Parameters:

request - ExperimentRequest request.

Throws:

ICATServiceException - if an error occurs while processing icat request.

ICATServiceException - thrown when an invalid icat request is received.

InvalidICATRequestException - if the request is invalid.

getAllSamplesByExpId

java.util.List<au.edu.archer.domain.icat.api.Sample> getAllSamplesByExpId(SampleRequest request)

Get all samples by experiment id.

Parameters:

request - SampleRequest request object.

Returns:

List<Sample> set of samples that belongs to the experiment.

getExperimentById

au.edu.archer.domain.icat.api.Investigation getExperimentById(int expId)

Get experiment by experiment id.

Parameters:

expId - int experiment id.

Returns:

Investigation experiment object.

getAllExperimentsByProjectId

java.util.List<au.edu.archer.domain.icat.api.Investigation> getAllExperimentsByProjectId(int projId)

Get all experiments by a project id.

Parameters:

projId - The project id.

Returns:

A List of experiments.

addSampleToExperiment

au.edu.archer.domain.icat.api.Sample addSampleToExperiment(SampleRequest request)
                                                           throws InvalidICATRequestException,
                                                                  ICATServiceException

Add sample to experiment.

Parameters:

request - SampleRequest request.

Returns:

Sample sample object.

Throws:

ICATServiceException - if an error occurs while processing icat request.

InvalidICATRequestException - if the request is invalid.

updateSample

au.edu.archer.domain.icat.api.Sample updateSample(SampleRequest request)
                                                  throws InvalidICATRequestException,
                                                         ICATServiceException

Update sample.

Parameters:

request - SampleRequest request object.

Returns:

Sample sample object.

Throws:

ICATServiceException - if an error occurs while processing icat request.

InvalidICATRequestException - if the request is invalid.

deleteSample

void deleteSample(SampleRequest request)
                  throws InvalidICATRequestException,
                         ICATServiceException

Delete sample.

Parameters:

request - SampleRequest request object.

Throws:

ICATServiceException - if an error occurs while processing icat request.

InvalidICATRequestException - if the request is invalid.

getSampleById

au.edu.archer.domain.icat.api.Sample getSampleById(SampleRequest request)
                                                   throws InvalidICATRequestException

Get sample by sample id.

Parameters:

request - SampleRequest request object.

Returns:

Sample sample object.

Throws:

InvalidICATRequestException - if the request is invalid.

getAllSamplesByExpName

java.util.List<au.edu.archer.domain.icat.api.Sample> getAllSamplesByExpName(SampleRequest request)

Get all samples by experiment name.

Parameters:

request - SampleRequest request object.

Returns:

List<Sample> set of samples that belongs to the experiment.

updateSampleParameters

void updateSampleParameters(SampleRequest request)
                            throws InvalidICATRequestException,
                                   ICATServiceException

Add sample parameteres. Also referred as sample variable metadata.

Parameters:

request - SampleRequest object.

Throws:

InvalidICATRequestException - if invalid request received for processing.

ICATServiceException - if an error occurs while processing icat request.

getSampleParametersById

java.util.List<au.edu.archer.domain.icat.api.SampleParameter> getSampleParametersById(SampleRequest request)

Retrieve sample parameters. Also referred as sample variable metadata.

Parameters:

request - SampleRequest object.

Returns:

List of SampleParameter object.

getAllProjects

java.util.List<au.edu.archer.domain.icat.api.Study> getAllProjects()

Get all projects.

Returns:

List<Study> list of projects.

getDataFile

au.edu.archer.domain.icat.api.DataFile getDataFile(int dfId)

Get DataFile by id.

Parameters:

dfId - int DataFile id.

Returns:

DataFile DataFile object to be returned.

getDataFile

au.edu.archer.domain.icat.api.DataFile getDataFile(java.lang.String projectName,
                                                   java.lang.String experimentName,
                                                   java.lang.String datasetName,
                                                   java.lang.String datafileName)

Get DataFile by name.

Parameters:

projectName - String project name.

experimentName - String experiment name.

datasetName - String dataset name.

datafileName - String datafile name.

Returns:

DataFile DataFile object to be returned.

moveDataset

au.edu.archer.domain.icat.api.DataSet moveDataset(int datasetId,
                                                  int experimentId)

Move DataSet to another experiment.

Parameters:

datasetId - int id of the dataset to be moved.

experimentId - int id of the experiment that will hold the dataset.

Returns:

DataSet new DataSet object.

copyDataset

au.edu.archer.domain.icat.api.DataSet copyDataset(int datasetId,
                                                  int experimentId,
                                                  java.lang.String handle)

Copy DataSet to another experiment.

Parameters:

datasetId - int id of the dataset to be copied.

experimentId - int id of the experiment that will hold the dataset.

handle - handle

Returns:

DataSet new DataSet object.

deleteDataFile

void deleteDataFile(int id)

Delete DataFile by id.

Parameters:

id - int DataFile id.

updateDatafileParameteres

void updateDatafileParameteres(DatafileRequest request)
                               throws InvalidICATRequestException,
                                      ICATServiceException

Add datafile parameteres. Also referred as datafile variable metadata.

Parameters:

request - DatafileRequest object.

Throws:

InvalidICATRequestException - if invalid request received for processing.

ICATServiceException - if an error occurs while processing icat request.

getDataFileParametersById

java.util.List<au.edu.archer.domain.icat.api.DataFileParameter> getDataFileParametersById(DatafileRequest request)

Retrieve datafile parameters. Also referred as datafile variable metadata.

Parameters:

request - DatafileRequest object.

Returns:

List of DataFileParameter object.

updateDataFile

au.edu.archer.domain.icat.impl.DataFileImpl updateDataFile(au.edu.archer.domain.icat.api.DataFile df)

Update Datafile object.

Parameters:

df - DataFile datafile to be updated.

Returns:

DataFileImpl updated datafile object.

getAllDataFileFormat

java.util.List<au.edu.archer.domain.icat.api.DataFileFormat> getAllDataFileFormat()

Get all existing DataFileFormats.

Returns:

List<DataFileFormat> list of DataFileFormats.

getDatafileSliceByDatasetId

java.util.Map<java.lang.String,DatafileSliceResponse> getDatafileSliceByDatasetId(int datasetId)

Get all datafile slices by a dataset id.

Parameters:

datasetId - The dataset id.

Returns:

A Collection of DatafileSliceResponse.

getAllKeywordsByExperimentId

java.util.List<au.edu.archer.domain.icat.api.Keyword> getAllKeywordsByExperimentId(int expId)

Get all keywords by the experiment id.

Parameters:

expId - The experiment id.

Returns:

A list of Keywords.

listAllInvestigatorsByExperimentId

java.util.List<au.edu.archer.domain.icat.api.Investigator> listAllInvestigatorsByExperimentId(int expid)

List all investigators by experiment id.

Parameters:

expid - The experiment Id.

Returns:

A list of investigators.

listAllTopicListsByExperimentId

java.util.List<au.edu.archer.domain.icat.api.TopicList> listAllTopicListsByExperimentId(int expid)

List all TopicLists by ExperimentId.

Parameters:

expid - The experiment Id.

Returns:

A list of TopicList of the this experiment.

listAllTopics

java.util.List<au.edu.archer.domain.icat.api.Topic> listAllTopics()
                                                                  throws ICATServiceException

List of all Topics.

Returns:

A list of all Topics.

Throws:

ICATServiceException - if any errors occur.

getTopicById

au.edu.archer.domain.icat.api.Topic getTopicById(int id)

Get the Topic by Topic Id.

Parameters:

id - The Topic Id.

Returns:

A Topic.