StudyService (SeqWare 1.1.2 API)

All Known Implementing Classes:

StudyServiceImpl
```
public interface StudyService
```
StudyService interface.

Version:

$Id: $Id

Author:

boconnor

Field Summary

Fields
Modifier and Type Field and Description

static String NAME
Constant NAME="StudyService"

Fields
Modifier and Type	Field and Description
`static String`	`NAME` Constant `NAME="StudyService"`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`delete(Study study, boolean deleteRealFiles)` delete.
`List<Study>`	`findByCriteria(String criteria)` findByCriteria.
`List<Study>`	`findByCriteria(String criteria, boolean isCaseSens)` findByCriteria.
`Study`	`findByID(Integer expID)` findByID.
`List<Study>`	`findByOwnerID(Integer registrationId)` findByOwnerID.
`Study`	`findBySWAccession(Integer swAccession)` findBySWAccession.
`List<Study>`	`findByTitle(String title)` findByTitle.
`int`	`getFailedCount(Study study)` getFailedCount.
`List<File>`	`getFiles(Integer studyId)` getFiles.
`List<File>`	`getFiles(Integer studyId, String metaType)` getFiles.
`int`	`getFinishedCount(Study study)` getFinishedCount.
`int`	`getRunningCount(Study study)` getRunningCount.
`boolean`	`hasTitleBeenUsed(String oldTitle, String newTitle)` hasTitleBeenUsed.
`Integer`	`insert(Registration registration, Study study)` insert.
`Integer`	`insert(Study study)` insert.
`boolean`	`isHasFile(Integer studyId)` isHasFile.
`boolean`	`isHasFile(Integer studyId, String metaType)` isHasFile.
`List<Study>`	`list()` list.
`List<Study>`	`list(Registration registration)` list.
`List<Study>`	`list(Registration registration, Boolean isAcs)` list.
`List<Study>`	`listMyShared(Registration registration, Boolean isAcs)` listMyShared.
`List<Study>`	`listSharedWithMe(Registration registration)` listSharedWithMe.
`List<Study>`	`listSharedWithMe(Registration registration, Boolean isAcs)` listSharedWithMe.
`List<Study>`	`listStudyHasFile(Registration registration, String metaType, Boolean isAcs)` listStudyHasFile.
`List<Study>`	`listWithHasFile(List<Study> list)` listWithHasFile.
`List<Study>`	`listWithHasFile(List<Study> list, String metaType)` listWithHasFile.
`void`	`merge(Study study)` merge.
`void`	`setStudyDAO(StudyDAO studyDAO)` setStudyDAO.
`void`	`update(Registration registration, Study study)` update.
`void`	`update(Study study)` update.
`Study`	`updateDetached(Registration registration, Study study)` updateDetached.
`Study`	`updateDetached(Study study)` updateDetached.
`void`	`updateOwners(Integer swAccession)` updateOwners.

- Field Detail
  - NAME
```
static final String NAME
```
    Constant NAME="StudyService"
    
    See Also:
    Constant Field Values
- Method Detail
  - setStudyDAO
```
void setStudyDAO(StudyDAO studyDAO)
```
    setStudyDAO.
    
    Parameters:
    studyDAO - a StudyDAO object.
  - insert
```
Integer insert(Study study)
```
    insert.
    
    Parameters:
    study - a Study object.
    
    Returns:
    a Integer object.
  - insert
```
Integer insert(Registration registration,
             Study study)
```
    insert.
    
    Parameters:
    registration - a Registration object.
    study - a Study object.
    
    Returns:
    a Integer object.
  - update
```
void update(Study study)
```
    update.
    
    Parameters:
    study - a Study object.
  - update
```
void update(Registration registration,
          Study study)
```
    update.
    
    Parameters:
    registration - a Registration object.
    study - a Study object.
  - updateOwners
```
void updateOwners(Integer swAccession)
```
    updateOwners.
    
    Parameters:
    swAccession - a Integer object.
  - delete
```
void delete(Study study,
          boolean deleteRealFiles)
```
    delete.
    
    Parameters:
    study -
    deleteRealFiles -
  - merge
```
void merge(Study study)
```
    merge.
    
    Parameters:
    study - a Study object.
  - list
```
List<Study> list(Registration registration)
```
    list.
    
    Parameters:
    registration - a Registration object.
    
    Returns:
    a List object.
  - list
```
List<Study> list(Registration registration,
               Boolean isAcs)
```
    list.
    
    Parameters:
    registration - a Registration object.
    isAcs - a Boolean object.
    
    Returns:
    a List object.
  - listMyShared
```
List<Study> listMyShared(Registration registration,
                       Boolean isAcs)
```
    listMyShared.
    
    Parameters:
    registration - a Registration object.
    isAcs - a Boolean object.
    
    Returns:
    a List object.
  - listSharedWithMe
```
List<Study> listSharedWithMe(Registration registration)
```
    listSharedWithMe.
    
    Parameters:
    registration - a Registration object.
    
    Returns:
    a List object.
  - listSharedWithMe
```
List<Study> listSharedWithMe(Registration registration,
                           Boolean isAcs)
```
    listSharedWithMe.
    
    Parameters:
    registration - a Registration object.
    isAcs - a Boolean object.
    
    Returns:
    a List object.
  - findByTitle
```
List<Study> findByTitle(String title)
```
    findByTitle.
    
    Parameters:
    title - a String object.
    
    Returns:
    a Study object.
  - findByID
```
Study findByID(Integer expID)
```
    findByID.
    
    Parameters:
    expID - a Integer object.
    
    Returns:
    a Study object.
  - findBySWAccession
```
Study findBySWAccession(Integer swAccession)
```
    findBySWAccession.
    
    Parameters:
    swAccession - a Integer object.
    
    Returns:
    a Study object.
  - findByOwnerID
```
List<Study> findByOwnerID(Integer registrationId)
```
    findByOwnerID.
    
    Parameters:
    registrationId - a Integer object.
    
    Returns:
    a List object.
  - findByCriteria
```
List<Study> findByCriteria(String criteria,
                         boolean isCaseSens)
```
    findByCriteria.
    
    Parameters:
    criteria - a String object.
    isCaseSens - a boolean.
    
    Returns:
    a List object.
  - findByCriteria
```
List<Study> findByCriteria(String criteria)
```
    findByCriteria.
    
    Parameters:
    criteria - a String object.
    
    Returns:
    a List object.
  - hasTitleBeenUsed
```
boolean hasTitleBeenUsed(String oldTitle,
                       String newTitle)
```
    hasTitleBeenUsed.
    
    Parameters:
    oldTitle - a String object.
    newTitle - a String object.
    
    Returns:
    a boolean.
  - getFiles
```
List<File> getFiles(Integer studyId)
```
    getFiles.
    
    Parameters:
    studyId - a Integer object.
    
    Returns:
    a List object.
  - isHasFile
```
boolean isHasFile(Integer studyId)
```
    isHasFile.
    
    Parameters:
    studyId - a Integer object.
    
    Returns:
    a boolean.
  - listWithHasFile
```
List<Study> listWithHasFile(List<Study> list)
```
    listWithHasFile.
    
    Parameters:
    list - a List object.
    
    Returns:
    a List object.
  - getFiles
```
List<File> getFiles(Integer studyId,
                  String metaType)
```
    getFiles.
    
    Parameters:
    studyId - a Integer object.
    metaType - a String object.
    
    Returns:
    a List object.
  - isHasFile
```
boolean isHasFile(Integer studyId,
                String metaType)
```
    isHasFile.
    
    Parameters:
    studyId - a Integer object.
    metaType - a String object.
    
    Returns:
    a boolean.
  - listWithHasFile
```
List<Study> listWithHasFile(List<Study> list,
                          String metaType)
```
    listWithHasFile.
    
    Parameters:
    list - a List object.
    metaType - a String object.
    
    Returns:
    a List object.
  - listStudyHasFile
```
List<Study> listStudyHasFile(Registration registration,
                           String metaType,
                           Boolean isAcs)
```
    listStudyHasFile.
    
    Parameters:
    registration - a Registration object.
    metaType - a String object.
    isAcs - a Boolean object.
    
    Returns:
    a List object.
  - updateDetached
```
Study updateDetached(Study study)
```
    updateDetached.
    
    Parameters:
    study - a Study object.
    
    Returns:
    a Study object.
  - updateDetached
```
Study updateDetached(Registration registration,
                   Study study)
```
    updateDetached.
    
    Parameters:
    registration - a Registration object.
    study - a Study object.
    
    Returns:
    a Study object.
  - list
```
List<Study> list()
```
    list.
    
    Returns:
    a List object.
  - getRunningCount
```
int getRunningCount(Study study)
```
    getRunningCount.
    
    Parameters:
    study - a Study object.
    
    Returns:
    a int.
  - getFinishedCount
```
int getFinishedCount(Study study)
```
    getFinishedCount.
    
    Parameters:
    study - a Study object.
    
    Returns:
    a int.
  - getFailedCount
```
int getFailedCount(Study study)
```
    getFailedCount.
    
    Parameters:
    study - a Study object.
    
    Returns:
    a int.

Interface StudyService

Field Summary

Method Summary

Field Detail

NAME

Method Detail

setStudyDAO

insert

insert

update

update

updateOwners

delete

merge

list

list

listMyShared

listSharedWithMe

listSharedWithMe

findByTitle

findByID

findBySWAccession

findByOwnerID

findByCriteria

findByCriteria

hasTitleBeenUsed

getFiles

isHasFile

listWithHasFile

getFiles

isHasFile

listWithHasFile

listStudyHasFile

updateDetached

updateDetached

list

getRunningCount

getFinishedCount

getFailedCount