|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@RemoteServiceRelativePath(value="NGSPortal") public interface NGSPortalService
The client side stub for the RPC service.
| Field Summary | |
|---|---|
static int |
kAttachToGroup
Specifies that the key : value pair is about a Group |
static int |
kAttachToProject
Specifies that the key : value pair is about a Project |
static int |
kAttachToRun
Specifies that the key : value pair is about a run |
static int |
kAttachToSample
Specifies that the key : value pair is about a sample |
static int |
kAttachToSequencedSample
Specifies that the key : value pair is about a sequenced sample |
static int |
kAttachToUser
Specifies that the key : value pair is about a user |
static int |
kFirstLabUserRole
The smallest role number that specifies a lab related user |
static int |
kIndexSeqLength
Allowed length for a non-empty Index Sequence |
static int |
kLastLabUserRole
The largest role number that specifies a lab related user |
static int |
kRoleAdmin
|
static int |
kRoleCoPI
|
static int |
kRoleInformaticsLead
|
static int |
kRoleInformaticsPhdLead
|
static int |
kRoleInformaticsSpecialist
|
static int |
kRoleIt
|
static int |
kRoleLabManager
|
static int |
kRoleLabTech
|
static int |
kRolePI
|
static int |
kRoleProjCreator
|
static int |
kRoleProjLead
|
static int |
kRoleProjPI
|
static int |
kRoleProjSpec
|
static int |
kRoleResearcher
|
static int |
kRoleSpa
|
static int |
kRoleStatistician
|
| Method Summary | |
|---|---|
boolean |
addExternalUser(String firstName,
String lastName,
String id)
Add an external user to the database |
int |
addGroup(int connectionID,
String name,
String description)
Adds a new group |
boolean |
addKeyValuePair(int connectionID,
int table,
String name,
String more,
String key,
String value)
Add a Key : Value pair about a specified item to the DB |
String |
addNewRerun(int connectionID,
int projectID,
String projectName)
|
boolean |
addNote(int connectionID,
String note,
String tableName,
int rowID)
Adds a note to the database |
String |
addProject(int connectionID,
String notes,
boolean isReanalysis,
int[] seqSampleIDs,
Integer leadID,
Integer specID,
Integer piID)
Adds a new project. |
boolean |
addToFamily(int connectionID,
String family,
String parentID,
String rlimsID,
String sampleParentID,
String name,
Boolean isMale)
Add a sample to a family, creating the family if necessary. |
boolean |
addUsersToGroup(int connectionID,
int groupID,
Map<String,Integer> users)
Add users to an existing group |
boolean |
addUsersToProject(int connectionID,
Map<String,Boolean> users,
int role,
String project)
Give one or more users' access to a project |
boolean |
checkAccessPrivilages(String string)
|
boolean |
deleteGroup(int connectionID,
int groupID)
Delete an existing group |
boolean |
deleteNote(int connectionID,
String tableName,
int rowID,
Date noteDate)
Deletes a note from the database. |
Map<String,Integer> |
getAllSecondaryStatuses()
|
List<String> |
getAnalysisStatuses()
Get the names for each of the analysis statuses the database recognizes |
List<String> |
getAnalysisTypes()
Get the names for each of the analysis types the database recognizes |
List<AnalysisInfo> |
getAnalyzedSamples(int connectionID,
String theRun)
Finds all the samples for a run that have had an analysis done |
List<String> |
getApplicationTypes()
Get the Descriptions for each of the application types the database recognizes |
List<String> |
getApplicationTypes(String runID,
String pi)
Get the Descriptions for each of the application types the database recognizes, that occur with the specified PI and / or runID |
int |
getApplicationTypesForSamples(int[] sampleIDs)
Gets the ID of the Application Type for more of the passed in samples than anyone else |
List<SGEScriptSummary> |
getAvgCPUSecondsPerScript(SGEFilter filter,
int connectionID)
Queries the portal database and returns a list of SGEScriptSummary containing the average of cpuseconds consumed by the scripts defined by the provided SGEFilter |
List<SGEScriptSummary> |
getAvgRun(SGEFilter filter,
int connectionID)
Queries the portal database and returns a list of SGEScriptSummary containing the sum of cpuseconds consumed by the scripts defined by the provided SGEFilter |
List<RunData> |
getCompletedRuns(int connectionID,
String piName,
String runID)
Get all the completed runs |
ConnectionResponse |
getConnection()
Ask the server for the information the client needs in order to send data to the server |
List<ContactInfo> |
getContacts(int connectionID,
int[] contactIDs)
Gets one or more contacts. |
Map<String,PrimaryAnalysisBean> |
getCurrentPrimaryStatus(int connectionID)
Get the latest primary analysis statuses, from all the primary analysis results that have been updated in the last week |
String |
getDefaultProjectName(String runName,
String appType,
String pi,
boolean isReanalysis)
Get a default Secondary Project Reanalysis name from the server given the run, PI, and appType, then ask the user for the reanalysis name, given the default name |
Map<String,Integer> |
getErrorsPerRun(SGEFilter filter,
int connectionID)
Returns a set of pairs of RunIDs - ScriptNames and error counts defined by the passed filter object. |
List<FileLocation> |
getFileLocations()
Get a List of the available FileLocations that files might be saved in |
Map<String,Integer> |
getFlowcellsPerMonth(SGEFilter filter,
int connectionID)
|
List<GroupInfo> |
getGroups(int connectionID)
Get the list of all the groups in the DB |
List<InstrumentInfo> |
getInstrumentHistory(int connectionID,
String instrument)
Get all the actions recorded for the given instrument |
Map<String,String> |
getInstrumentStatus(int connectionID)
Query the Primary Analysis DB for the runs that have completed the given task, and when they did it |
Map<String,String> |
getISdetails()
Get a map from LAN IDs to names for all the Informatics Specialists |
List<ResultInfo> |
getMatchingRuns(int connectionID,
String piName,
String runID,
String sample,
String application,
String rlimsProject,
String rlimsID,
Date startDate,
Date endDate,
boolean onlyAnalyzed,
String projName)
Search the database for all the runs matching the criteria given, and return them |
List<Note> |
getNote(int connectionID,
String tableName,
int rowID)
Get one or more notes from the database |
int |
getPIForSamples(int[] sampleIDs)
Gets the ContactLinker ID of the Contact who is the PI for more of the passed in samples than anyone else |
List<String> |
getPINames()
Get the names of all the PIs in the database |
List<String> |
getPrimaryAnalysisStatuses()
Get the names for each of the Primary Analysis Statuses the database recognizes |
List<String> |
getProjectNames(int connectionID)
Get the names of all the secondary analysis projects in the database that this user can see |
List<ProjectInfo> |
getProjects(int connectionID,
int[] projIDs)
Gets one or more projects. |
List<SecondaryProjectInfo> |
getProjects(int connectionID,
String projectName)
Get all the Secondary Projects created by this individual, or the single project projectName |
ProjectSummaryBuilder |
getProjectsSummary(int connectionID,
String userName,
Date fromDate,
Date toDate)
|
List<QCResult> |
getQCResults(int connectionID,
String sampleName,
String runID)
Get all the information about the QCResults for a sample from a given run |
List<String> |
getReadTypes()
Get the Descriptions for each of the read types the database recognizes |
List<ResultInfo> |
getRetainedSamples(int connectionID,
String piName,
String runID,
String sample,
boolean isPrimary)
Get all the runs and samples that have data files that are currently marked for non-deletion |
List<String> |
getRLIMSIDs(int connectionID)
Get all the RLIMS Sample "Sample IDs" in the database that this user can see |
List<String> |
getRLIMSProjectNames(int connectionID)
Get all the RLIMS project names in the database that this user can see |
List<String> |
getRoles()
Get all the Contact Roles in the database |
RunData |
getRunData(int connectionID,
String piName,
String runID)
Get all the metadata from a given run, owned by a given PI |
List<String> |
getRunIDs(int connectionID)
Get all the run IDs in the database this user can see |
List<String> |
getRunIDs(int connectionID,
String pi,
String appType)
Get all the run IDs in the database this user can see, that have at least one sample that has the specified PI and / or application type |
boolean |
getRunSecondaryAnalysisStatus(List<Integer> sampleIDs)
Runs a SQL query to find if any of the Sequenced Samples in sampleIDs have a Secondary Analysis result of Delivered |
List<String> |
getSampleNames(int connectionID)
Get the names of all the samples in the DB |
List<SampleInfo> |
getSampleNames(int connectionID,
String piName,
String runID)
Get the name, RLIMS ID, and DB ID of all the samples in the DB, or only those samples associated with a given Run, PI, or both |
List<SampleInfo> |
getSamples(int connectionID,
String piName,
String runID,
String appType,
String projectName)
Get all the information about all the samples from a given run, owned by a given PI |
Map<String,Integer> |
getSamplesPerMonth(SGEFilter filter,
int connectionID)
Returns a set of pairs of months and unique samples defined by the passed filter object. |
List<SGEScriptSummary> |
getScriptInvocations(SGEFilter filter,
int connectionID)
Queries the portal database and returns a list of SGEScriptSummary containing the total script invocations in the runs defined by the provided SGEFilter |
List<SecondaryDetails> |
getSecondaryAnalysisHistory(int connectionID,
int secondaryProjectID)
|
List<Analysis2> |
getSecondaryAnalysisResults(int connectionID,
Date finishedCutoff)
Get all the information about the Secondary Analysis results for a sample from a given run |
Map<String,List<SecondaryAnalysisBean>> |
getSecondaryStatus(int connectionID)
|
Map<String,Integer> |
getSGEFlowcellsPerMonth(SGEFilter filter,
int connectionID)
|
List<SGEScriptSummary> |
getSumCPUSecondsPerScript(SGEFilter filter,
int connectionID)
Queries the portal database and returns a list of SGEScriptSummary containing the sum of cpuseconds consumed by the scripts defined by the provided SGEFilter |
List<String> |
getValidRLIMS(SGEFilter filter,
int connectionID)
Queries the portal database and returns a list of possible RunIDs falling within the provided SGEFilter |
List<String> |
getValidRunTypes(int connectionID)
Returns a list of possible Run Types (eg., exome, whole_genome,...) available |
Map<String,Double> |
getWallClockPerRun(SGEFilter filter,
int connectionID)
Returns a set of pairs of WallClock times and RunIDs defined by the passed filter object. |
Map<String,Double> |
getWallClockPerSample(SGEFilter filter,
int connectionID)
Returns a set of pairs of WallClock times and SampleIDs defined by the passed filter object. |
boolean |
grantProjectAccess(int connectionID,
String project,
String run,
List<String> samples)
Routine to add samples to a project |
boolean |
grantUserAccess(int connectionID,
Map<String,Boolean> users,
int role,
String run,
List<String> samples)
Routine to give users access to samples that the caller has access to |
ConnectionResponse |
logIn(String userName,
String password,
int connectionID)
Tell the server the lanID and Password (encrypted) of the person doing the querying, and get told by the server if the lan ID and password are valid |
void |
logOut(String userName,
String password,
int connectionID)
Tell the server to forget about this user, and the user's current search |
boolean |
parseRunFile(String filePath,
String user,
String password)
Parses the passed in file. |
boolean |
removeFromFamily(int connectionID,
String family,
String rlimsID,
String parentID)
Remove a sample from a family |
void |
removeProject(int connectionID,
String projectName)
Removes an existing project. |
boolean |
removeUsersFromGroup(int connectionID,
int groupID,
List<String> users)
Remove users from a group |
boolean |
removeUsersFromProject(int connectionID,
List<String> users,
String project)
Routine to remove one or more users' access to a project |
boolean |
retainSample(int connectionID,
Date deleteDate,
String piName,
List<String> runIDs,
String sample,
String requestor,
boolean isPrimary)
Mark a sample or set of samples as needing their data files to be retained |
boolean |
revokeProjectAccess(int connectionID,
String project,
String run,
List<String> samples)
Routine to remove samples from a project |
boolean |
revokeUserAccess(int connectionID,
List<String> users,
String run,
List<String> samples)
Routine to remove users' access to samples that the caller has PI access to, or where the caller has all sample access. |
void |
saveBatched(int connectionID,
int projectID,
String newnotes)
|
void |
saveNotes(int connectionID,
int projectID,
String runName,
String pI,
String application,
String personnel,
String newNotes)
Save Notes to the Database. |
void |
savePersonneltoDB(int connectionID,
int projectID,
String newISAssignee,
String oldISAssignee)
|
void |
saveSecondaryAnalysisNotes(int connectionID,
int analysisID,
String notes)
|
void |
saveSecondaryAssignedDate(int connectionID,
int projectID,
Date newValue)
|
void |
saveSecondaryCompleteDate(int connectionID,
int projectID,
Date date)
|
void |
saveSecondaryDeliveryDate(int connectionID,
int projectID,
Date newValue)
|
void |
saveSecondaryStartDate(int connectionID,
int projectID,
Date newValue)
|
void |
sendEmailNotification(int connectionID,
String runName,
String application,
String pI,
String assignerLanID,
String notes,
String newAssignee,
String oldAssignee,
int projectID)
Send an email to the new person assigned to a project, and the old person no longer assigned to a project |
boolean |
sendWeeklyReport(String lanID,
int connectionID)
|
boolean |
setIsBIC(int connectionID,
boolean isBIC,
int projectID)
Sets all the samples for a project to have their isBIC field either be true or false |
boolean |
setRunData(int connectionID,
String piName,
String runID,
RunData theRun,
List<SampleInfo> samples,
int[] deletedIDs)
Update all the metadata for a given run, owned by a given PI, and for its samples |
boolean |
updateAnalysis(String analysisPath,
String uID,
String password)
Update the database with all the new analyses that have been added |
boolean |
updateGroup(int connectionID,
int groupID,
String name,
String description)
Updates information about an existing group |
void |
updateProject(int connectionID,
String projectName,
String notes,
boolean isReanalysis,
int[] seqSampleIDs,
Integer leadID,
Integer specID,
Integer piID)
Updates an existing project. |
void |
writedatatofile(int connectionID,
String exportdata)
|
| Field Detail |
|---|
static final int kIndexSeqLength
static final int kAttachToSample
static final int kAttachToSequencedSample
static final int kAttachToRun
static final int kAttachToUser
static final int kAttachToGroup
static final int kAttachToProject
static final int kRolePI
static final int kRoleCoPI
static final int kRoleResearcher
static final int kRoleInformaticsPhdLead
static final int kRoleInformaticsLead
static final int kRoleInformaticsSpecialist
static final int kRoleStatistician
static final int kRoleIt
static final int kRoleSpa
static final int kRoleLabManager
static final int kRoleLabTech
static final int kRoleAdmin
static final int kRoleProjCreator
static final int kRoleProjLead
static final int kRoleProjSpec
static final int kRoleProjPI
static final int kFirstLabUserRole
static final int kLastLabUserRole
| Method Detail |
|---|
ConnectionResponse getConnection()
ConnectionResponse logIn(String userName,
String password,
int connectionID)
userName - User's lanIDpassword - User's password, encrypted to the server's specificationsconnectionID - The unique ID of the connection, so server can track multiple connection at
the same time.
void logOut(String userName,
String password,
int connectionID)
userName - User's lanIDpassword - User's password, encrypted to the server's specificationsconnectionID - The unique ID of the connection, so server can track multiple connection at
the same time.List<String> getApplicationTypes()
List<String> getApplicationTypes(String runID,
String pi)
runID - Name of the run of interest, or null if don't carepi - LanID of the PI of interest, or null if don't care
int getApplicationTypesForSamples(int[] sampleIDs)
sampleIDs - Array of SequencedSample IDs, must not be empty or null
List<String> getReadTypes()
List<String> getAnalysisTypes()
List<String> getAnalysisStatuses()
List<FileLocation> getFileLocations()
List<String> getPrimaryAnalysisStatuses()
Map<String,PrimaryAnalysisBean> getCurrentPrimaryStatus(int connectionID)
throws ConnectionException
connectionID - The id of the connection, so know what user has access to
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection IDList<String> getRoles()
List<String> getPINames()
int getPIForSamples(int[] sampleIDs)
sampleIDs - Array of SequencedSample IDs, must not be empty or null
List<String> getRunIDs(int connectionID)
throws ConnectionException
connectionID - The id of the connection, so know what user has access to
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
List<String> getRunIDs(int connectionID,
String pi,
String appType)
throws ConnectionException
connectionID - The id of the connection, so know what user has access topi - LanID of the PI of interest, or null if don't careappType - Description of the application type of interest, or null if don't care
ConnectionException
List<ResultInfo> getMatchingRuns(int connectionID,
String piName,
String runID,
String sample,
String application,
String rlimsProject,
String rlimsID,
Date startDate,
Date endDate,
boolean onlyAnalyzed,
String projName)
throws Exception
connectionID - The id of the connection, so know what user has access topiName - If not empty or null, the Last Name, First Name of the PI to look forrunID - If not empty or null, the single run ID to returnsample - If not empty or null, the name of the samples to returnapplication - If not empty or null, the type of application to search forrlimsProject - If not empty or null, the RLIMS Project Name to search forrlimsID - If not empty or null, the Run RLIMS BatchID to search forstartDate - If not null, lower bound on date range or allowed resultsendDate - If not null, upper bound on date range or allowed results
If startDate == endDate, will only return runs from that date.onlyAnalyzed - If true, only find results where there's at least one secondary analysis
availableprojName - If not empty or null, the secondary project name to look for
Exception
RunData getRunData(int connectionID,
String piName,
String runID)
throws ConnectionException
connectionID - The id of the connection, so know what user has access topiName - The Last Name, First Name of the PI to look for, empty or null if don't carerunID - The run ID we're interested in
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
List<ResultInfo> getRetainedSamples(int connectionID,
String piName,
String runID,
String sample,
boolean isPrimary)
throws ConnectionException
connectionID - The id of the connection, so know what user has access topiName - The Last Name, First Name of the PI to look for, or null if not restricting on thatrunID - The run ID we're interested in, null or empty if not restricting on thatsample - Name of the sample we're searching forisPrimary - True if want to know about primary analysis files, false if want to know
about secondary analysis files
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean retainSample(int connectionID,
Date deleteDate,
String piName,
List<String> runIDs,
String sample,
String requestor,
boolean isPrimary)
throws ConnectionException
connectionID - The id of the connection, so know that user has write accessdeleteDate - New deletion date for the sample(s)piName - The Last Name, First Name of the PI who owns the samples, or null if not
restricting on thatrunIDs - The run IDs we're interested in, list must not be null or emptysample - Name of the sample we're updating, null for all samples on that runrequestor - Person making the update request. If user is not an "all access" user, this
is ignored, and the user's name is usedisPrimary - True if want to retain primary analysis files, false if want to retain
secondary analysis files
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean setRunData(int connectionID,
String piName,
String runID,
RunData theRun,
List<SampleInfo> samples,
int[] deletedIDs)
throws ConnectionException
connectionID - The id of the connection, so know what user has access topiName - The Last Name, First Name of the PI to look forrunID - The run ID we're interested intheRun - The updated run metadata, or null if no change to that datasamples - The changed samples for the this run - PI pairdeletedIDs - Array of the ids of Samples that were deleted, null if none were deleted
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
List<SampleInfo> getSamples(int connectionID,
String piName,
String runID,
String appType,
String projectName)
throws ConnectionException
connectionID - The id of the connection, so know what user has access topiName - The Last Name, First Name of the PI to look forrunID - The run ID we're interested in. One of this and projID can NOT be blankappType - If not empty or null, The type of application to returnprojectName - The name of the project we're interested in. One of this and runID can NOT be blank
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean addExternalUser(String firstName,
String lastName,
String id)
firstName - The new user's first namelastName - The new user's last nameid - The new user's unique ID. Cannot match any id in the DB, or any Mayo LAN ID
boolean grantUserAccess(int connectionID,
Map<String,Boolean> users,
int role,
String run,
List<String> samples)
throws ConnectionException
connectionID - The id of the connection, so know what user has access tousers - Map of the users being granted access to whether they're internal or not.
For internal users, the String should be the user's lanID. For external, it needs to be a
unique last name, first namerole - The role the Users are being given for these samplesrun - The name of the run they're being granted access tosamples - List of samples from the run that the users are being granted access to, null or
empty to grant access to all the samples of that run
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean revokeUserAccess(int connectionID,
List<String> users,
String run,
List<String> samples)
throws ConnectionException
connectionID - The id of the connection, so know what user has access tousers - List of the users losing accessrun - The name of the run they're losing access tosamples - List of samples from the run that the users are losing access to, null or
empty to revoke access to all the samples of that run
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean addUsersToProject(int connectionID,
Map<String,Boolean> users,
int role,
String project)
throws ConnectionException
connectionID - The id of the person doing the add, must be part of Bioinformatics Staffusers - Map of the users being granted access to whether they're internal or not.
For internal users, the String should be the user's lanID. For external, it needs to be a
unique last name, first namerole - The role the Users are being given for this projectproject - Name of the project the users are being added to
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean removeUsersFromProject(int connectionID,
List<String> users,
String project)
throws ConnectionException
connectionID - The id of the person doing the add, must be part of Bioinformatics Staffusers - List of the users losing accessproject - The name of the project they're losing access to
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean grantProjectAccess(int connectionID,
String project,
String run,
List<String> samples)
throws ConnectionException
connectionID - The id of the person doing the add, must be part of Bioinformatics Staffproject - Name of the project getting access to the samplesrun - The name of the run they're being granted access tosamples - List of samples from the run that are being added to the project, null or
empty to grant access to all the samples of that run
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean revokeProjectAccess(int connectionID,
String project,
String run,
List<String> samples)
throws ConnectionException
connectionID - The id of the person doing the remove, must be part of Bioinformatics Staffproject - Name of the project losing access to the samplesrun - The name of the run the project is losing access tosamples - List of samples from the run that the project is losing access to, null or
empty to revoke access to all the samples of that run
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
List<SampleInfo> getSampleNames(int connectionID,
String piName,
String runID)
throws ConnectionException
connectionID - The id of the connection, so know what user has access topiName - The Last Name, First Name of the PI to look for, empty or null if don't carerunID - The run ID we're interested in, empty or null if don't care
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
List<String> getSampleNames(int connectionID)
throws ConnectionException
connectionID - The id of the connection, so know what user has access to
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
List<RunData> getCompletedRuns(int connectionID,
String piName,
String runID)
throws ConnectionException
connectionID - ID of the connection, used to retrieve the PortalConnection. Must match
the session connection ID, if the session connection ID existspiName - The Last Name, First Name of the PI to look for, empty or null if don't carerunID - The run ID we're interested in, empty or null if want all completed runs
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
List<QCResult> getQCResults(int connectionID,
String sampleName,
String runID)
throws ConnectionException
connectionID - The id of the connection, so know what user has access tosampleName - The name of the Sample to look forrunID - The run ID we're interested in
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
List<Analysis2> getSecondaryAnalysisResults(int connectionID,
Date finishedCutoff)
throws ConnectionException
connectionID - The id of the connection, so know what user has access tofinishedCutoff - The cutoff date for finished runs (i.e. only report on finished runs
that finished at or after this date). Defaults to one week ago if is null
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean parseRunFile(String filePath,
String user,
String password)
filePath - XML file or directory to useuser - user ID to give to the DB, in order to get write permissionpassword - password to give to the DB, in order to get write permission
List<AnalysisInfo> getAnalyzedSamples(int connectionID,
String theRun)
throws ConnectionException
connectionID - ID of the connection, used to retrieve the PortalConnection. Must match
the session connection ID, if the session connection ID existstheRun - The run whose samples we're looking at
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean addNote(int connectionID,
String note,
String tableName,
int rowID)
throws ConnectionException
connectionID - ID of the connection, used to retrieve the PortalConnection. Must match
the session connection ID, if the session connection ID existsnote - The NotetableName - Name of the table the note's aboutrowID - The id of the item in the table the note is about
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
List<Note> getNote(int connectionID,
String tableName,
int rowID)
throws ConnectionException
connectionID - ID of the connection, used to retrieve the PortalConnection. Must match
the session connection ID, if the session connection ID existstableName - Name of the table we're looking for notes for, null or empty string to get
notes for all tablesrowID - The row id of the item in the table that we're looking for notes for, or kInvalidID
to get the notes for all the items for table tableName
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean deleteNote(int connectionID,
String tableName,
int rowID,
Date noteDate)
throws ConnectionException
connectionID - ID of the connection, used to retrieve the PortalConnection. Must match
the session connection ID, if the session connection ID existstableName - Name of the table we're looking for notes for, null or empty string to get
notes for all tablesrowID - The row id of the item in the table that we're looking for notes for, or kInvalidID
to get the notes for all the items for table tableNamenoteDate - The date of the note
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean updateAnalysis(String analysisPath,
String uID,
String password)
analysisPath - The path to where the analysis results are locateduID - The user ID to use when modifying the databasepassword - The password to use when modifying the database
Map<String,String> getInstrumentStatus(int connectionID)
throws ConnectionException
connectionID - The user's connection ID
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
List<InstrumentInfo> getInstrumentHistory(int connectionID,
String instrument)
throws ConnectionException
connectionID - The user's connection IDinstrument - The name of the instrument to look up
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
int addGroup(int connectionID,
String name,
String description)
throws ConnectionException
connectionID - The user's connection IDname - Name of the new group. Must be uniquedescription - The group description
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean updateGroup(int connectionID,
int groupID,
String name,
String description)
throws ConnectionException
connectionID - The user's connection IDgroupID - The DB ID for the groupname - The group namedescription - The group description
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean deleteGroup(int connectionID,
int groupID)
throws ConnectionException
connectionID - The user's connection IDgroupID - The DB ID for the group
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean addUsersToGroup(int connectionID,
int groupID,
Map<String,Integer> users)
throws ConnectionException
connectionID - The user's connection IDgroupID - The DB ID for the groupusers - Map holding the users' lanIDs and roles
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean removeUsersFromGroup(int connectionID,
int groupID,
List<String> users)
throws ConnectionException
connectionID - The user's connection IDgroupID - The DB ID for the groupusers - List holding the lanIDs of the users being removed from the group
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
List<GroupInfo> getGroups(int connectionID)
throws ConnectionException
connectionID - The user's connection ID
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean addKeyValuePair(int connectionID,
int table,
String name,
String more,
String key,
String value)
throws ConnectionException
connectionID - The user's connection ID. Must be part of Informatics stafftable - Specifier for which table to attach the data toname - Unique specifier for the table of interestmore - Additional data to create a unique specifier for the table of interest, or null if don't need itkey - Key of the key : Value pair to addvalue - Value of the key : Value pair to add
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean addToFamily(int connectionID,
String family,
String parentID,
String rlimsID,
String sampleParentID,
String name,
Boolean isMale)
throws ConnectionException
connectionID - The user's connection ID. Must be part of Informatics stafffamily - The name of the family, each family has a unique nameparentID - The RLIMS ID of a sample belonging to a parent who is part of this family.
The method will fail if the sample ID is not null and the sample doesn't exist, or if the
sample is not part of the familyrlimsID - The RLIMS Family ID of the sample being added to the familysampleParentID - The RLIMS Parent ID of the sample being added to the familyname - Name of the sample being added to the family, can be null or emptyisMale - True if male, false if female, null if not known
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
boolean removeFromFamily(int connectionID,
String family,
String rlimsID,
String parentID)
throws ConnectionException
connectionID - The user's connection ID. Must be part of Informatics stafffamily - The name of the family, each family has a unique namerlimsID - The RLIMS family ID of the sample being removed from the familyparentID - The RLIMS parent ID of the sample being removed from the family
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
String addProject(int connectionID,
String notes,
boolean isReanalysis,
int[] seqSampleIDs,
Integer leadID,
Integer specID,
Integer piID)
throws ConnectionException
connectionID - The user's connection IDnotes - The project notes.isReanalysis - Is this a reanalysis project.seqSampleIDs - One or more sequenced sample IDs assigned to the project.leadID - Contact user ID for the informatics lead, or null if nonespecID - Contact user ID for the informatics specialist, or null if nonepiID - Contact user ID for the PI, or null if none
ConnectionException
void updateProject(int connectionID,
String projectName,
String notes,
boolean isReanalysis,
int[] seqSampleIDs,
Integer leadID,
Integer specID,
Integer piID)
throws ConnectionException
connectionID - The user's connection IDprojectName - Name of project to update.notes - The project notes.isReanalysis - Is this a reanalysis project.seqSampleIDs - One or more sequenced sample IDs assigned to the project.leadID - Contact user ID for the informatics leadspecID - Contact user ID for the informatics specialistpiID - Contact user ID for the PI
ConnectionException
List<SecondaryProjectInfo> getProjects(int connectionID,
String projectName)
throws ConnectionException
connectionID - The user's connection IDprojectName - If not null, the name of the single project to get. Only will get if
the user created the project, or has canEditAll authorization
ConnectionException
void removeProject(int connectionID,
String projectName)
throws ConnectionException
connectionID - The user's connection IDprojectName - Name of project to remove.
ConnectionException
List<ProjectInfo> getProjects(int connectionID,
int[] projIDs)
throws ConnectionException
connectionID - The user's connection IDprojIDs - ID(s) of the projects to fetch. If empty or null, all projects are returned.
ConnectionException
List<String> getProjectNames(int connectionID)
throws ConnectionException
connectionID - The user's connection ID
ConnectionException
List<String> getRLIMSProjectNames(int connectionID)
throws ConnectionException
connectionID - The user's connection ID
ConnectionException
List<String> getRLIMSIDs(int connectionID)
throws ConnectionException
connectionID - The user's connection ID
ConnectionException
List<ContactInfo> getContacts(int connectionID,
int[] contactIDs)
throws ConnectionException
connectionID - The user's connection IDcontactIDs - ID(s) of the contacts to fetch. If empty or null, all contacts are returned.
ConnectionException
ProjectSummaryBuilder getProjectsSummary(int connectionID,
String userName,
Date fromDate,
Date toDate)
throws ConnectionException
ConnectionException
String getDefaultProjectName(String runName,
String appType,
String pi,
boolean isReanalysis)
runName - Name of the run of interestappType - Application typepi - Name of the PIisReanalysis - True if it's a reanalysis, false otherwise
List<SGEScriptSummary> getSumCPUSecondsPerScript(SGEFilter filter,
int connectionID)
throws ConnectionException
filter - An SGEFilter (null gives no filtering)connectionID - The user's connection ID.
ConnectionException
List<SGEScriptSummary> getAvgCPUSecondsPerScript(SGEFilter filter,
int connectionID)
throws ConnectionException
filter - An SGEFilter (null gives no filtering)connectionID - The user's connection ID.
ConnectionException
List<SGEScriptSummary> getScriptInvocations(SGEFilter filter,
int connectionID)
throws ConnectionException
filter - An SGEFilter (null gives no filtering)connectionID - The user's connection ID.
ConnectionException
List<SGEScriptSummary> getAvgRun(SGEFilter filter,
int connectionID)
throws ConnectionException
filter - An SGEFilter (null gives no filtering)connectionID - The user's connection ID.
ConnectionException
List<String> getValidRLIMS(SGEFilter filter,
int connectionID)
throws ConnectionException
filter - An SGEFilter (null gives no filtering)connectionID - The user's connection ID.
ConnectionException
List<String> getValidRunTypes(int connectionID)
throws ConnectionException
connectionID - The user's connection ID.
ConnectionException
Map<String,Double> getWallClockPerRun(SGEFilter filter,
int connectionID)
throws ConnectionException
filter - An SGEFilter (null gives no filtering)connectionID - The user's connection ID.
ConnectionException
Map<String,Double> getWallClockPerSample(SGEFilter filter,
int connectionID)
throws ConnectionException
filter - An SGEFilter (null gives no filtering)connectionID - The user's connection ID.
ConnectionException
Map<String,Integer> getSamplesPerMonth(SGEFilter filter,
int connectionID)
throws ConnectionException
filter - An SGEFilter(null gives no filtering)connectionID - The user's connection ID.
ConnectionException
Map<String,Integer> getErrorsPerRun(SGEFilter filter,
int connectionID)
throws ConnectionException
filter - An SGEFilter(null gives no filtering)connectionID - The user's connection ID.
ConnectionException
Map<String,List<SecondaryAnalysisBean>> getSecondaryStatus(int connectionID)
throws ConnectionException
ConnectionException
void sendEmailNotification(int connectionID,
String runName,
String application,
String pI,
String assignerLanID,
String notes,
String newAssignee,
String oldAssignee,
int projectID)
throws ConnectionException
connectionID - The user's connection IDrunName - The name of the runapplication - The type of analysis to be runpI - The PI the work is being done forassignerLanID - The LAN ID of the person assigning the worknotes - Any notes for the analysisnewAssignee - The person being assigned to run the analysisoldAssignee - The previous person assigned to do the analysis, or null if no oneprojectID - ID of the project, so can send along its name
ConnectionExceptionboolean checkAccessPrivilages(String string)
void saveSecondaryStartDate(int connectionID,
int projectID,
Date newValue)
throws ConnectionException
ConnectionException
void saveSecondaryDeliveryDate(int connectionID,
int projectID,
Date newValue)
throws ConnectionException
ConnectionException
void saveSecondaryCompleteDate(int connectionID,
int projectID,
Date date)
throws ConnectionException
ConnectionException
void saveNotes(int connectionID,
int projectID,
String runName,
String pI,
String application,
String personnel,
String newNotes)
throws ConnectionException
connectionID - The id of the connection, so know what user has access toprojectID - ID of the project we're adding notes aboutrunName - Name of the run we're adding notes aboutpI - The PI the work is being done forapplication - The type of analysis being runpersonnel - LanID of the person doing the analysisnewNotes - New value of the notes field
ConnectionException
void saveSecondaryAssignedDate(int connectionID,
int projectID,
Date newValue)
throws ConnectionException
ConnectionException
String addNewRerun(int connectionID,
int projectID,
String projectName)
throws ConnectionException
ConnectionException
void writedatatofile(int connectionID,
String exportdata)
throws IOException
IOException
List<SecondaryDetails> getSecondaryAnalysisHistory(int connectionID,
int secondaryProjectID)
Map<String,Integer> getFlowcellsPerMonth(SGEFilter filter,
int connectionID)
void savePersonneltoDB(int connectionID,
int projectID,
String newISAssignee,
String oldISAssignee)
throws ConnectionException
ConnectionException
void saveSecondaryAnalysisNotes(int connectionID,
int analysisID,
String notes)
throws ConnectionException
ConnectionExceptionMap<String,Integer> getAllSecondaryStatuses()
Map<String,Integer> getSGEFlowcellsPerMonth(SGEFilter filter,
int connectionID)
throws ConnectionException
ConnectionExceptionMap<String,String> getISdetails()
boolean getRunSecondaryAnalysisStatus(List<Integer> sampleIDs)
sampleIDs - List of IDs to look for, must not be empty or null
void saveBatched(int connectionID,
int projectID,
String newnotes)
throws ConnectionException
ConnectionException
boolean sendWeeklyReport(String lanID,
int connectionID)
throws ConnectionException
ConnectionException
boolean setIsBIC(int connectionID,
boolean isBIC,
int projectID)
throws ConnectionException
connectionID - ID of the connection, used to retrieve the PortalConnection. Must match
the session connection ID, if the session connection ID existsisBIC - Value to set all the samples toprojectID - DB Row ID of the project holding the samples
ConnectionException - If the connectionID is not valid, or if it doesn't match the session
connection ID
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||