Study (SeqWare 1.1.2 API)

java.lang.Object
- net.sourceforge.seqware.common.security.PermissionsAware
- - net.sourceforge.seqware.common.model.Study

All Implemented Interfaces:: Serializable, Comparable<Study>, Annotatable<StudyAttribute>, FirstTierModel, ParentAccessionModel

public class Study
extends PermissionsAware
implements Serializable, ParentAccessionModel, Comparable<Study>, Annotatable<StudyAttribute>, FirstTierModel

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

Study()
Constructor for Study.

Constructors
Constructor and Description
`Study()` Constructor for Study.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(Study that)` compareTo.
`boolean`	`equals(Object other)`
`String`	`getAbstractStr()` Getter for the field `abstractStr`.
`String`	`getAccession()` Getter for the field `accession`.
`String`	`getAlias()` Getter for the field `alias`.
`Set<StudyAttribute>`	`getAnnotations()` Get the annotations for this model
`String`	`getCenterName()` Getter for the field `centerName`.
`String`	`getCenterProjectName()` Getter for the field `centerProjectName`.
`Date`	`getCreateTimestamp()` Getter for the field `createTimestamp`.
`String`	`getDescription()` Getter for the field `description`.
`StudyType`	`getExistingType()` Getter for the field `existingType`.
`Integer`	`getExistingTypeInt()` Getter for the field `existingTypeInt`.
`SortedSet<Experiment>`	`getExperiments()` Getter for the field `experiments`.
`String`	`getHtml()` Getter for the field `html`.
`Boolean`	`getIsHasFile()` Getter for the field `isHasFile`.
`Boolean`	`getIsSelected()` Getter for the field `isSelected`.
`String`	`getJsonEscapeDescription()` getJsonEscapeDescription.
`String`	`getJsonEscapeDescription200()` getJsonEscapeDescription200.
`String`	`getJsonEscapeTitle()` getJsonEscapeTitle.
`String`	`getNewType()` Getter for the field `newType`.
`Registration`	`getOwner()` Getter for the field `owner`.
`Set<Processing>`	`getProcessings()` Getter for the field `processings`.
`Integer`	`getProjectId()` Getter for the field `projectId`.
`static long`	`getSerialVersionUID()` Getter for the field `serialVersionUID`.
`SortedSet<ShareStudy>`	`getSharedStudies()` Getter for the field `sharedStudies`.
`String`	`getStatus()` Getter for the field `status`.
`Set<StudyAttribute>`	`getStudyAttributes()` Getter for the field `studyAttributes`.
`Integer`	`getStudyId()` Getter for the field `studyId`.
`Integer`	`getSwAccession()` Getter for the field `swAccession`.
`String`	`getTitle()` Getter for the field `title`.
`Date`	`getUpdateTimestamp()` Getter for the field `updateTimestamp`.
`boolean`	`givesPermissionInternal(Registration registration, Set<Integer> considered)` Short-circuit permission checking by providing a set of entities that have already been checked
`int`	`hashCode()`
`void`	`setAbstractStr(String abstractStr)` Setter for the field `abstractStr`.
`void`	`setAccession(String accession)` Setter for the field `accession`.
`void`	`setAlias(String alias)` Setter for the field `alias`.
`void`	`setCenterName(String centerName)` Setter for the field `centerName`.
`void`	`setCenterProjectName(String centerProjectName)` Setter for the field `centerProjectName`.
`void`	`setCreateTimestamp(Date createTimestamp)` Setter for the field `createTimestamp`.
`void`	`setDescription(String description)` Setter for the field `description`.
`void`	`setExistingType(StudyType existingType)` Setter for the field `existingType`.
`void`	`setExistingTypeInt(Integer existingTypeInt)` Setter for the field `existingTypeInt`.
`void`	`setExperiments(SortedSet<Experiment> experiments)` Setter for the field `experiments`.
`void`	`setHtml(String html)` Setter for the field `html`.
`void`	`setIsHasFile(Boolean isHasFile)` Setter for the field `isHasFile`.
`void`	`setIsSelected(Boolean isSelected)` Setter for the field `isSelected`.
`void`	`setNewType(String newType)` Setter for the field `newType`.
`void`	`setOwner(Registration owner)` Setter for the field `owner`.
`void`	`setProcessings(Set<Processing> processings)` Setter for the field `processings`.
`void`	`setProjectId(Integer projectId)` Setter for the field `projectId`.
`void`	`setSharedStudies(SortedSet<ShareStudy> sharedStudies)` Setter for the field `sharedStudies`.
`void`	`setStatus(String status)` Setter for the field `status`.
`void`	`setStudyAttributes(Set<StudyAttribute> studyAttributes)` Setter for the field `studyAttributes`.
`void`	`setStudyId(Integer studyId)` Setter for the field `studyId`.
`void`	`setSwAccession(Integer swAccession)` Setter for the field `swAccession`.
`void`	`setTitle(String title)` Setter for the field `title`.
`void`	`setUpdateTimestamp(Date updateTimestamp)` Setter for the field `updateTimestamp`.
`String`	`toString()`

Methods inherited from class net.sourceforge.seqware.common.security.PermissionsAware
givesPermission, givesPermission

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Study
```
public Study()
```
    Constructor for Study.
- Method Detail
  - compareTo
```
public int compareTo(Study that)
```
    compareTo.
    
    Specified by:
    
    compareTo in interface Comparable<Study>
    
    Parameters:
    that - a Study object.
    
    Returns:
    a int.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
    
    Parameters:
    other -
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getStudyId
```
public Integer getStudyId()
```
    Getter for the field studyId.
    
    Returns:
    a Integer object.
  - setStudyId
```
public void setStudyId(Integer studyId)
```
    Setter for the field studyId.
    
    Parameters:
    studyId - a Integer object.
  - getSwAccession
```
public Integer getSwAccession()
```
    Getter for the field swAccession.
    
    Specified by:
    
    getSwAccession in interface FirstTierModel
    
    Returns:
    a Integer object.
  - setSwAccession
```
public void setSwAccession(Integer swAccession)
```
    Setter for the field swAccession.
    
    Parameters:
    swAccession - a Integer object.
  - getTitle
```
public String getTitle()
```
    Getter for the field title.
    
    Returns:
    a String object.
  - getJsonEscapeTitle
```
public String getJsonEscapeTitle()
```
    getJsonEscapeTitle.
    
    Returns:
    a String object.
  - setTitle
```
public void setTitle(String title)
```
    Setter for the field title.
    
    Parameters:
    title - a String object.
  - getJsonEscapeDescription
```
public String getJsonEscapeDescription()
```
    getJsonEscapeDescription.
    
    Returns:
    a String object.
  - getJsonEscapeDescription200
```
public String getJsonEscapeDescription200()
```
    getJsonEscapeDescription200.
    
    Returns:
    a String object.
  - getDescription
```
public String getDescription()
```
    Getter for the field description.
    
    Returns:
    a String object.
  - setDescription
```
public void setDescription(String description)
```
    Setter for the field description.
    
    Parameters:
    description - a String object.
  - getAlias
```
public String getAlias()
```
    Getter for the field alias.
    
    Returns:
    a String object.
  - setAlias
```
public void setAlias(String alias)
```
    Setter for the field alias.
    
    Parameters:
    alias - a String object.
  - getAccession
```
public String getAccession()
```
    Getter for the field accession.
    
    Returns:
    a String object.
  - setAccession
```
public void setAccession(String accession)
```
    Setter for the field accession.
    
    Parameters:
    accession - a String object.
  - getStatus
```
public String getStatus()
```
    Getter for the field status.
    
    Returns:
    a String object.
  - setStatus
```
public void setStatus(String status)
```
    Setter for the field status.
    
    Parameters:
    status - a String object.
  - getAbstractStr
```
public String getAbstractStr()
```
    Getter for the field abstractStr.
    
    Returns:
    a String object.
  - setAbstractStr
```
public void setAbstractStr(String abstractStr)
```
    Setter for the field abstractStr.
    
    Parameters:
    abstractStr - a String object.
  - getNewType
```
public String getNewType()
```
    Getter for the field newType.
    
    Returns:
    a String object.
  - setNewType
```
public void setNewType(String newType)
```
    Setter for the field newType.
    
    Parameters:
    newType - a String object.
  - getCenterName
```
public String getCenterName()
```
    Getter for the field centerName.
    
    Returns:
    a String object.
  - setCenterName
```
public void setCenterName(String centerName)
```
    Setter for the field centerName.
    
    Parameters:
    centerName - a String object.
  - getCenterProjectName
```
public String getCenterProjectName()
```
    Getter for the field centerProjectName.
    
    Returns:
    a String object.
  - setCenterProjectName
```
public void setCenterProjectName(String centerProjectName)
```
    Setter for the field centerProjectName.
    
    Parameters:
    centerProjectName - a String object.
  - getProjectId
```
public Integer getProjectId()
```
    Getter for the field projectId.
    
    Returns:
    a Integer object.
  - setProjectId
```
public void setProjectId(Integer projectId)
```
    Setter for the field projectId.
    
    Parameters:
    projectId - a Integer object.
  - getCreateTimestamp
```
public Date getCreateTimestamp()
```
    Getter for the field createTimestamp.
    
    Returns:
    a Date object.
  - setCreateTimestamp
```
public void setCreateTimestamp(Date createTimestamp)
```
    Setter for the field createTimestamp.
    
    Parameters:
    createTimestamp - a Date object.
  - getUpdateTimestamp
```
public Date getUpdateTimestamp()
```
    Getter for the field updateTimestamp.
    
    Returns:
    a Date object.
  - setUpdateTimestamp
```
public void setUpdateTimestamp(Date updateTimestamp)
```
    Setter for the field updateTimestamp.
    
    Parameters:
    updateTimestamp - a Date object.
  - getOwner
```
public Registration getOwner()
```
    Getter for the field owner.
    
    Returns:
    a Registration object.
  - setOwner
```
public void setOwner(Registration owner)
```
    Setter for the field owner.
    
    Parameters:
    owner - a Registration object.
  - getExistingType
```
public StudyType getExistingType()
```
    Getter for the field existingType.
    
    Returns:
    a StudyType object.
  - setExistingType
```
public void setExistingType(StudyType existingType)
```
    Setter for the field existingType.
    
    Parameters:
    existingType - a StudyType object.
  - getExperiments
```
public SortedSet<Experiment> getExperiments()
```
    Getter for the field experiments.
    
    Returns:
    a SortedSet object.
  - setExperiments
```
public void setExperiments(SortedSet<Experiment> experiments)
```
    Setter for the field experiments.
    
    Parameters:
    experiments - a SortedSet object.
  - getSerialVersionUID
```
public static long getSerialVersionUID()
```
    Getter for the field serialVersionUID.
    
    Returns:
    a long.
  - getExistingTypeInt
```
public Integer getExistingTypeInt()
```
    Getter for the field existingTypeInt.
    
    Returns:
    a Integer object.
  - setExistingTypeInt
```
public void setExistingTypeInt(Integer existingTypeInt)
```
    Setter for the field existingTypeInt.
    
    Parameters:
    existingTypeInt - a Integer object.
  - getSharedStudies
```
public SortedSet<ShareStudy> getSharedStudies()
```
    Getter for the field sharedStudies.
    
    Returns:
    a SortedSet object.
  - setSharedStudies
```
public void setSharedStudies(SortedSet<ShareStudy> sharedStudies)
```
    Setter for the field sharedStudies.
    
    Parameters:
    sharedStudies - a SortedSet object.
  - getProcessings
```
public Set<Processing> getProcessings()
```
    Getter for the field processings.
    
    Returns:
    a Set object.
  - setProcessings
```
public void setProcessings(Set<Processing> processings)
```
    Setter for the field processings.
    
    Parameters:
    processings - a Set object.
  - getIsSelected
```
public Boolean getIsSelected()
```
    Getter for the field isSelected.
    
    Returns:
    a Boolean object.
  - setIsSelected
```
public void setIsSelected(Boolean isSelected)
```
    Setter for the field isSelected.
    
    Parameters:
    isSelected - a Boolean object.
  - getIsHasFile
```
public Boolean getIsHasFile()
```
    Getter for the field isHasFile.
    
    Returns:
    a Boolean object.
  - setIsHasFile
```
public void setIsHasFile(Boolean isHasFile)
```
    Setter for the field isHasFile.
    
    Parameters:
    isHasFile - a Boolean object.
  - getHtml
```
public String getHtml()
```
    Getter for the field html.
    
    Returns:
    a String object.
  - setHtml
```
public void setHtml(String html)
```
    Setter for the field html.
    
    Parameters:
    html - a String object.
  - getStudyAttributes
```
public Set<StudyAttribute> getStudyAttributes()
```
    Getter for the field studyAttributes.
    
    Returns:
    a Set object.
  - setStudyAttributes
```
public void setStudyAttributes(Set<StudyAttribute> studyAttributes)
```
    Setter for the field studyAttributes.
    
    Parameters:
    studyAttributes - a Set object.
  - givesPermissionInternal
```
public boolean givesPermissionInternal(Registration registration,
                              Set<Integer> considered)
```
    Short-circuit permission checking by providing a set of entities that have already been checked
    
    Specified by:
    
    givesPermissionInternal in class PermissionsAware
    
    Returns:
  - getAnnotations
```
public Set<StudyAttribute> getAnnotations()
```
    Description copied from interface: Annotatable
    
    Get the annotations for this model
    
    Specified by:
    
    getAnnotations in interface Annotatable<StudyAttribute>
    
    Returns:

Class Study

Constructor Summary

Method Summary

Methods inherited from class net.sourceforge.seqware.common.security.PermissionsAware

Methods inherited from class java.lang.Object

Constructor Detail

Study

Method Detail

compareTo

toString

equals

hashCode

getStudyId

setStudyId

getSwAccession

setSwAccession

getTitle

getJsonEscapeTitle

setTitle

getJsonEscapeDescription

getJsonEscapeDescription200

getDescription

setDescription

getAlias

setAlias

getAccession

setAccession

getStatus

setStatus

getAbstractStr

setAbstractStr

getNewType

setNewType

getCenterName

setCenterName

getCenterProjectName

setCenterProjectName

getProjectId

setProjectId

getCreateTimestamp

setCreateTimestamp

getUpdateTimestamp

setUpdateTimestamp

getOwner

setOwner

getExistingType

setExistingType

getExperiments

setExperiments

getSerialVersionUID

getExistingTypeInt

setExistingTypeInt

getSharedStudies

setSharedStudies

getProcessings

setProcessings

getIsSelected

setIsSelected

getIsHasFile

setIsHasFile

getHtml

setHtml

getStudyAttributes

setStudyAttributes

givesPermissionInternal

getAnnotations