cst.common.businessLayer
Interface LoggingServiceAPI

All Superinterfaces:

CSTServiceAPI

All Known Implementing Classes:

DemonstrationLoggingService, ProductionLoggingService

public interface LoggingServiceAPI
extends CSTServiceAPI

This is the main API that developers should use if they want to manage the data repository with another front-end (eg: a web application, web service, servlet).

 Copyright 2010 Medical Research Council Unit for Lifelong Health and Ageing
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
      http://www.apache.org/licenses/LICENSE-2.0
 Unless required by applicable law or agreed to in writing, software 
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.  
 

Version:

1.0

Author:

Kevin Garwood (kgarwood@users.sourceforge.net)

Method Summary

java.util.ArrayList<java.lang.String>	applyCoreFieldAndCompletionFilter(User user, SubjectAttributeFilterCommand coreFieldFilter, CompletionFilterCommand completionFilter)
java.util.ArrayList<java.lang.String>	applyCoreFieldAndDataTypeFilter(User user, SubjectAttributeFilterCommand coreFieldFilter, DateFilterCommand dataTypeFilter)
java.util.ArrayList<java.lang.String>	applyOnlyCompletionFilter(User user, CompletionFilterCommand completionFilter)
java.util.ArrayList<java.lang.String>	applyOnlyDataTypeFilter(User user, DateFilterCommand dataTypeFilter)
java.util.ArrayList<java.lang.String>	applyOnlySubjectAttributeFilter(User user, SubjectAttributeFilterCommand subjectAttributeFilter)
java.util.ArrayList<java.lang.String>	applyShowAllFilter(User user)
java.util.ArrayList<TrialActivityModel>	getAllTrialActivityModels(User user, java.lang.String trialActivityDataStorageName)
java.util.ArrayList<TrialActivityChange>	getTrialActivityChangesForSubject(User user, java.lang.String trialSubjectIdentifier)
java.util.ArrayList<TrialActivityChange>	getTrialActivityChangesForUser(User user, User changeAuthor)
TrialActivityModel	getTrialActivityModel(User user, java.lang.String trialSubjectIdentifier, java.lang.String trialActivityDataStorageName)
SubjectInformationReportAPI	getTrialSubjectInformation(User user, java.lang.String trialSubjectIdentifier)
java.lang.String[]	getValuesForSubjectAttribute(User user, java.lang.String subjectAttributeDataStorageName)
int	importTrialActivityData(User user, java.lang.String trialActivityDataStorageName, java.util.ArrayList<TrialActivityModel> trialActivityModels, java.lang.String dataSourceName)
void	initialise(SessionProperties sessionProperties) initialises the service.
boolean	trialSubjectModelExists(User user, java.lang.String trialSubjectIdentifier)
void	updateChangeHistory(User user, TrialActivityChange trialActivityChange)
void	updateTrialActivity(User user, TrialActivityModel trialActivityModel)
void	validateUser(User user)

Methods inherited from interface cst.common.businessLayer.CSTServiceAPI

checkRepositoryIsSynchronised, getTrialSubjectModel

Method Detail

initialise

void initialise(SessionProperties sessionProperties)
                throws CSTException

initialises the service.

Specified by:

initialise in interface CSTServiceAPI

Throws:

CSTException

validateUser

void validateUser(User user)
                  throws CSTException

Throws:

CSTException

getAllTrialActivityModels

java.util.ArrayList<TrialActivityModel> getAllTrialActivityModels(User user,
                                                                  java.lang.String trialActivityDataStorageName)
                                                                  throws CSTException

Throws:

CSTException

getTrialActivityModel

TrialActivityModel getTrialActivityModel(User user,
                                         java.lang.String trialSubjectIdentifier,
                                         java.lang.String trialActivityDataStorageName)
                                         throws CSTException

Throws:

CSTException

applyShowAllFilter

java.util.ArrayList<java.lang.String> applyShowAllFilter(User user)
                                                         throws CSTException

Throws:

CSTException

applyOnlyCompletionFilter

java.util.ArrayList<java.lang.String> applyOnlyCompletionFilter(User user,
                                                                CompletionFilterCommand completionFilter)
                                                                throws CSTException

Throws:

CSTException

applyOnlySubjectAttributeFilter

java.util.ArrayList<java.lang.String> applyOnlySubjectAttributeFilter(User user,
                                                                      SubjectAttributeFilterCommand subjectAttributeFilter)
                                                                      throws CSTException

Throws:

CSTException

applyOnlyDataTypeFilter

java.util.ArrayList<java.lang.String> applyOnlyDataTypeFilter(User user,
                                                              DateFilterCommand dataTypeFilter)
                                                              throws CSTException

Throws:

CSTException

applyCoreFieldAndDataTypeFilter

java.util.ArrayList<java.lang.String> applyCoreFieldAndDataTypeFilter(User user,
                                                                      SubjectAttributeFilterCommand coreFieldFilter,
                                                                      DateFilterCommand dataTypeFilter)
                                                                      throws CSTException

Throws:

CSTException

applyCoreFieldAndCompletionFilter

java.util.ArrayList<java.lang.String> applyCoreFieldAndCompletionFilter(User user,
                                                                        SubjectAttributeFilterCommand coreFieldFilter,
                                                                        CompletionFilterCommand completionFilter)
                                                                        throws CSTException

Throws:

CSTException

getValuesForSubjectAttribute

java.lang.String[] getValuesForSubjectAttribute(User user,
                                                java.lang.String subjectAttributeDataStorageName)
                                                throws CSTException

Throws:

CSTException

trialSubjectModelExists

boolean trialSubjectModelExists(User user,
                                java.lang.String trialSubjectIdentifier)
                                throws CSTException

Throws:

CSTException

importTrialActivityData

int importTrialActivityData(User user,
                            java.lang.String trialActivityDataStorageName,
                            java.util.ArrayList<TrialActivityModel> trialActivityModels,
                            java.lang.String dataSourceName)
                            throws CSTException

Throws:

CSTException

updateTrialActivity

void updateTrialActivity(User user,
                         TrialActivityModel trialActivityModel)
                         throws CSTException

Throws:

CSTException

getTrialSubjectInformation

SubjectInformationReportAPI getTrialSubjectInformation(User user,
                                                       java.lang.String trialSubjectIdentifier)
                                                       throws CSTException

Throws:

CSTException

updateChangeHistory

void updateChangeHistory(User user,
                         TrialActivityChange trialActivityChange)
                         throws CSTException

Throws:

CSTException

getTrialActivityChangesForSubject

java.util.ArrayList<TrialActivityChange> getTrialActivityChangesForSubject(User user,
                                                                           java.lang.String trialSubjectIdentifier)
                                                                           throws CSTException

Throws:

CSTException

getTrialActivityChangesForUser

java.util.ArrayList<TrialActivityChange> getTrialActivityChangesForUser(User user,
                                                                        User changeAuthor)
                                                                        throws CSTException

Throws:

CSTException