macaw.businessLayer
Interface MacawRetrievalAPI

All Known Implementing Classes:

DemonstrationRetrievalService, ProductionRetrievalService

public interface MacawRetrievalAPI

External software clients such as the SWIFT governance tool or future information portal services will use interact with the repository of Macaw variables via this interface.

For security reasons, the interface methods do not throw exceptions which may accidentally reveal information about the underlying data. Therefore, clients should ensure that when they invoke this API, they anticipate returned results of null or an empty list.

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

AliasFilePath	getAliasFilePath(User user, java.lang.String cardNumber) given the name of a logical location for data, returns an AliasFilePath object that can also describe the physical location.
java.util.ArrayList<AliasFilePath>	getAliasFilePaths(User user) A collection of all available alias file paths.
java.util.ArrayList<AliasFilePath>	getAliasFilePathsMatchingName(User user, java.lang.String phrase) Searches for all alias file paths whose logical location names contain a phrase.
java.util.ArrayList<AvailabilityState>	getAvailabilityStates(User user)
java.util.ArrayList<Category>	getCategories(User user)
java.util.ArrayList<Category>	getCategoriesForVariable(User user, java.lang.String variableName)
java.util.ArrayList<CleaningState>	getCleaningStates(User user)
java.util.ArrayList<OntologyTerm>	getOntologyTerms(User user, java.lang.String variableName) return the ontology terms for a given variable
java.util.ArrayList<SupportingDocument>	getSupportingDocuments(User user, java.lang.String variableName) returns the supporting documents for a given variable
java.util.ArrayList<User>	getUnverifiedUsers(User admin)
User	getUserFromEmail(User user, java.lang.String email)
User	getUserFromID(User user, java.lang.String userID)
java.util.ArrayList<User>	getUsers(User admin)
java.util.ArrayList<ValueLabel>	getValueLabels(User user, java.lang.String variableName) returns the value labels associated with a given variable
Variable	getVariable(User user, java.lang.String variableName) returns a variable record given a variable name
java.lang.String[]	getVariableNames(User user) returns an alphabetically sorted list of all the variable names in the data repository
java.util.ArrayList<VariableSummary>	getVariableSummariesForCategory(User user, java.lang.String category) returns summary records of variables that are associated with a given category.

Method Detail

getAliasFilePaths

java.util.ArrayList<AliasFilePath> getAliasFilePaths(User user)

A collection of all available alias file paths.

Parameters:

user - - registered user who is using the retrieval service

getAliasFilePath

AliasFilePath getAliasFilePath(User user,
                               java.lang.String cardNumber)

given the name of a logical location for data, returns an AliasFilePath object that can also describe the physical location.

Parameters:

user - - registered user who is using the retrieval service

cardNumber -

getAliasFilePathsMatchingName

java.util.ArrayList<AliasFilePath> getAliasFilePathsMatchingName(User user,
                                                                 java.lang.String phrase)

Searches for all alias file paths whose logical location names contain a phrase. Note that this search filter does not support regular expression symbols.

Parameters:

user - - registered user who is using the retrieval service

phrase - - a search phrase that represents part of the name for a logical location in an alias file path.

getCategoriesForVariable

java.util.ArrayList<Category> getCategoriesForVariable(User user,
                                                       java.lang.String variableName)

getCategories

java.util.ArrayList<Category> getCategories(User user)

getAvailabilityStates

java.util.ArrayList<AvailabilityState> getAvailabilityStates(User user)

getCleaningStates

java.util.ArrayList<CleaningState> getCleaningStates(User user)

getVariable

Variable getVariable(User user,
                     java.lang.String variableName)

returns a variable record given a variable name

Parameters:

user -

variableName -

getSupportingDocuments

java.util.ArrayList<SupportingDocument> getSupportingDocuments(User user,
                                                               java.lang.String variableName)

returns the supporting documents for a given variable

Parameters:

user -

variableName -

getOntologyTerms

java.util.ArrayList<OntologyTerm> getOntologyTerms(User user,
                                                   java.lang.String variableName)

return the ontology terms for a given variable

Parameters:

user -

variableName -

getVariableSummariesForCategory

java.util.ArrayList<VariableSummary> getVariableSummariesForCategory(User user,
                                                                     java.lang.String category)

returns summary records of variables that are associated with a given category.

Parameters:

user -

category -

getValueLabels

java.util.ArrayList<ValueLabel> getValueLabels(User user,
                                               java.lang.String variableName)

returns the value labels associated with a given variable

Parameters:

user - registered user who is using the retrieval service

variableName - the name of a variable

getVariableNames

java.lang.String[] getVariableNames(User user)

returns an alphabetically sorted list of all the variable names in the data repository

Parameters:

user -

getUserFromID

User getUserFromID(User user,
                   java.lang.String userID)

getUnverifiedUsers

java.util.ArrayList<User> getUnverifiedUsers(User admin)

getUsers

java.util.ArrayList<User> getUsers(User admin)

getUserFromEmail

User getUserFromEmail(User user,
                      java.lang.String email)