Investigation (ICAT Java Client 4.2.0 API)

java.lang.Object
- org.icatproject.EntityBaseBean
- - org.icatproject.Investigation

public class Investigation
extends EntityBaseBean

Java class for investigation complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="investigation">
   <complexContent>
     <extension base="{http://icatproject.org}entityBaseBean">
       <sequence>
         <element name="datasets" type="{http://icatproject.org}dataset" maxOccurs="unbounded" minOccurs="0"/>
         <element name="doi" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="endDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="facility" type="{http://icatproject.org}facility" minOccurs="0"/>
         <element name="facilityCycle" type="{http://icatproject.org}facilityCycle" minOccurs="0"/>
         <element name="instrument" type="{http://icatproject.org}instrument" minOccurs="0"/>
         <element name="investigationUsers" type="{http://icatproject.org}investigationUser" maxOccurs="unbounded" minOccurs="0"/>
         <element name="keywords" type="{http://icatproject.org}keyword" maxOccurs="unbounded" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="parameters" type="{http://icatproject.org}investigationParameter" maxOccurs="unbounded" minOccurs="0"/>
         <element name="publications" type="{http://icatproject.org}publication" maxOccurs="unbounded" minOccurs="0"/>
         <element name="releaseDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="samples" type="{http://icatproject.org}sample" maxOccurs="unbounded" minOccurs="0"/>
         <element name="shifts" type="{http://icatproject.org}shift" maxOccurs="unbounded" minOccurs="0"/>
         <element name="startDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="studyInvestigations" type="{http://icatproject.org}studyInvestigation" maxOccurs="unbounded" minOccurs="0"/>
         <element name="summary" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="title" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="type" type="{http://icatproject.org}investigationType" minOccurs="0"/>
         <element name="visitId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Dataset>`	`datasets`
`protected String`	`doi`
`protected XMLGregorianCalendar`	`endDate`
`protected Facility`	`facility`
`protected FacilityCycle`	`facilityCycle`
`protected Instrument`	`instrument`
`protected List<InvestigationUser>`	`investigationUsers`
`protected List<Keyword>`	`keywords`
`protected String`	`name`
`protected List<InvestigationParameter>`	`parameters`
`protected List<Publication>`	`publications`
`protected XMLGregorianCalendar`	`releaseDate`
`protected List<Sample>`	`samples`
`protected List<Shift>`	`shifts`
`protected XMLGregorianCalendar`	`startDate`
`protected List<StudyInvestigation>`	`studyInvestigations`
`protected String`	`summary`
`protected String`	`title`
`protected InvestigationType`	`type`
`protected String`	`visitId`

Fields inherited from class org.icatproject.EntityBaseBean
createId, createTime, id, modId, modTime

Constructor Summary

Constructors
Constructor and Description

Investigation()

Constructors
Constructor and Description
`Investigation()`

Method Summary

Methods
Modifier and Type	Method and Description
`List<Dataset>`	`getDatasets()` Gets the value of the datasets property.
`String`	`getDoi()` Gets the value of the doi property.
`XMLGregorianCalendar`	`getEndDate()` Gets the value of the endDate property.
`Facility`	`getFacility()` Gets the value of the facility property.
`FacilityCycle`	`getFacilityCycle()` Gets the value of the facilityCycle property.
`Instrument`	`getInstrument()` Gets the value of the instrument property.
`List<InvestigationUser>`	`getInvestigationUsers()` Gets the value of the investigationUsers property.
`List<Keyword>`	`getKeywords()` Gets the value of the keywords property.
`String`	`getName()` Gets the value of the name property.
`List<InvestigationParameter>`	`getParameters()` Gets the value of the parameters property.
`List<Publication>`	`getPublications()` Gets the value of the publications property.
`XMLGregorianCalendar`	`getReleaseDate()` Gets the value of the releaseDate property.
`List<Sample>`	`getSamples()` Gets the value of the samples property.
`List<Shift>`	`getShifts()` Gets the value of the shifts property.
`XMLGregorianCalendar`	`getStartDate()` Gets the value of the startDate property.
`List<StudyInvestigation>`	`getStudyInvestigations()` Gets the value of the studyInvestigations property.
`String`	`getSummary()` Gets the value of the summary property.
`String`	`getTitle()` Gets the value of the title property.
`InvestigationType`	`getType()` Gets the value of the type property.
`String`	`getVisitId()` Gets the value of the visitId property.
`void`	`setDoi(String value)` Sets the value of the doi property.
`void`	`setEndDate(XMLGregorianCalendar value)` Sets the value of the endDate property.
`void`	`setFacility(Facility value)` Sets the value of the facility property.
`void`	`setFacilityCycle(FacilityCycle value)` Sets the value of the facilityCycle property.
`void`	`setInstrument(Instrument value)` Sets the value of the instrument property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setReleaseDate(XMLGregorianCalendar value)` Sets the value of the releaseDate property.
`void`	`setStartDate(XMLGregorianCalendar value)` Sets the value of the startDate property.
`void`	`setSummary(String value)` Sets the value of the summary property.
`void`	`setTitle(String value)` Sets the value of the title property.
`void`	`setType(InvestigationType value)` Sets the value of the type property.
`void`	`setVisitId(String value)` Sets the value of the visitId property.

Methods inherited from class org.icatproject.EntityBaseBean
getCreateId, getCreateTime, getId, getModId, getModTime, setCreateId, setCreateTime, setId, setModId, setModTime

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

- Field Detail
  - datasets
```
protected List<Dataset> datasets
```
  - doi
```
protected String doi
```
  - endDate
```
protected XMLGregorianCalendar endDate
```
  - facility
```
protected Facility facility
```
  - facilityCycle
```
protected FacilityCycle facilityCycle
```
  - instrument
```
protected Instrument instrument
```
  - investigationUsers
```
protected List<InvestigationUser> investigationUsers
```
  - keywords
```
protected List<Keyword> keywords
```
  - name
```
protected String name
```
  - parameters
```
protected List<InvestigationParameter> parameters
```
  - publications
```
protected List<Publication> publications
```
  - releaseDate
```
protected XMLGregorianCalendar releaseDate
```
  - samples
```
protected List<Sample> samples
```
  - shifts
```
protected List<Shift> shifts
```
  - startDate
```
protected XMLGregorianCalendar startDate
```
  - studyInvestigations
```
protected List<StudyInvestigation> studyInvestigations
```
  - summary
```
protected String summary
```
  - title
```
protected String title
```
  - type
```
protected InvestigationType type
```
  - visitId
```
protected String visitId
```
- Constructor Detail
  - Investigation
```
public Investigation()
```
- Method Detail
  - getDatasets
```
public List<Dataset> getDatasets()
```
    Gets the value of the datasets property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the datasets property.
    For example, to add a new item, do as follows:
```
    getDatasets().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Dataset
  - getDoi
```
public String getDoi()
```
    Gets the value of the doi property.
    
    Returns:
    possible object is String
  - setDoi
```
public void setDoi(String value)
```
    Sets the value of the doi property.
    
    Parameters:
    value - allowed object is String
  - getEndDate
```
public XMLGregorianCalendar getEndDate()
```
    Gets the value of the endDate property.
    
    Returns:
    possible object is XMLGregorianCalendar
  - setEndDate
```
public void setEndDate(XMLGregorianCalendar value)
```
    Sets the value of the endDate property.
    
    Parameters:
    value - allowed object is XMLGregorianCalendar
  - getFacility
```
public Facility getFacility()
```
    Gets the value of the facility property.
    
    Returns:
    possible object is Facility
  - setFacility
```
public void setFacility(Facility value)
```
    Sets the value of the facility property.
    
    Parameters:
    value - allowed object is Facility
  - getFacilityCycle
```
public FacilityCycle getFacilityCycle()
```
    Gets the value of the facilityCycle property.
    
    Returns:
    possible object is FacilityCycle
  - setFacilityCycle
```
public void setFacilityCycle(FacilityCycle value)
```
    Sets the value of the facilityCycle property.
    
    Parameters:
    value - allowed object is FacilityCycle
  - getInstrument
```
public Instrument getInstrument()
```
    Gets the value of the instrument property.
    
    Returns:
    possible object is Instrument
  - setInstrument
```
public void setInstrument(Instrument value)
```
    Sets the value of the instrument property.
    
    Parameters:
    value - allowed object is Instrument
  - getInvestigationUsers
```
public List<InvestigationUser> getInvestigationUsers()
```
    Gets the value of the investigationUsers property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the investigationUsers property.
    For example, to add a new item, do as follows:
```
    getInvestigationUsers().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list InvestigationUser
  - getKeywords
```
public List<Keyword> getKeywords()
```
    Gets the value of the keywords property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the keywords property.
    For example, to add a new item, do as follows:
```
    getKeywords().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Keyword
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    value - allowed object is String
  - getParameters
```
public List<InvestigationParameter> getParameters()
```
    Gets the value of the parameters property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the parameters property.
    For example, to add a new item, do as follows:
```
    getParameters().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list InvestigationParameter
  - getPublications
```
public List<Publication> getPublications()
```
    Gets the value of the publications property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the publications property.
    For example, to add a new item, do as follows:
```
    getPublications().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Publication
  - getReleaseDate
```
public XMLGregorianCalendar getReleaseDate()
```
    Gets the value of the releaseDate property.
    
    Returns:
    possible object is XMLGregorianCalendar
  - setReleaseDate
```
public void setReleaseDate(XMLGregorianCalendar value)
```
    Sets the value of the releaseDate property.
    
    Parameters:
    value - allowed object is XMLGregorianCalendar
  - getSamples
```
public List<Sample> getSamples()
```
    Gets the value of the samples property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the samples property.
    For example, to add a new item, do as follows:
```
    getSamples().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Sample
  - getShifts
```
public List<Shift> getShifts()
```
    Gets the value of the shifts property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the shifts property.
    For example, to add a new item, do as follows:
```
    getShifts().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Shift
  - getStartDate
```
public XMLGregorianCalendar getStartDate()
```
    Gets the value of the startDate property.
    
    Returns:
    possible object is XMLGregorianCalendar
  - setStartDate
```
public void setStartDate(XMLGregorianCalendar value)
```
    Sets the value of the startDate property.
    
    Parameters:
    value - allowed object is XMLGregorianCalendar
  - getStudyInvestigations
```
public List<StudyInvestigation> getStudyInvestigations()
```
    Gets the value of the studyInvestigations property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the studyInvestigations property.
    For example, to add a new item, do as follows:
```
    getStudyInvestigations().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list StudyInvestigation
  - getSummary
```
public String getSummary()
```
    Gets the value of the summary property.
    
    Returns:
    possible object is String
  - setSummary
```
public void setSummary(String value)
```
    Sets the value of the summary property.
    
    Parameters:
    value - allowed object is String
  - getTitle
```
public String getTitle()
```
    Gets the value of the title property.
    
    Returns:
    possible object is String
  - setTitle
```
public void setTitle(String value)
```
    Sets the value of the title property.
    
    Parameters:
    value - allowed object is String
  - getType
```
public InvestigationType getType()
```
    Gets the value of the type property.
    
    Returns:
    possible object is InvestigationType
  - setType
```
public void setType(InvestigationType value)
```
    Sets the value of the type property.
    
    Parameters:
    value - allowed object is InvestigationType
  - getVisitId
```
public String getVisitId()
```
    Gets the value of the visitId property.
    
    Returns:
    possible object is String
  - setVisitId
```
public void setVisitId(String value)
```
    Sets the value of the visitId property.
    
    Parameters:
    value - allowed object is String

Class Investigation

Field Summary

Fields inherited from class org.icatproject.EntityBaseBean

Constructor Summary

Method Summary

Methods inherited from class org.icatproject.EntityBaseBean

Methods inherited from class java.lang.Object

Field Detail

datasets

doi

endDate

facility

facilityCycle

instrument

investigationUsers

keywords

name

parameters

publications

releaseDate

samples

shifts

startDate

studyInvestigations

summary

title

type

visitId

Constructor Detail

Investigation

Method Detail

getDatasets

getDoi

setDoi

getEndDate

setEndDate

getFacility

setFacility

getFacilityCycle

setFacilityCycle

getInstrument

setInstrument

getInvestigationUsers

getKeywords

getName

setName

getParameters

getPublications

getReleaseDate

setReleaseDate

getSamples

getShifts

getStartDate

setStartDate

getStudyInvestigations

getSummary

setSummary

getTitle

setTitle

getType

setType

getVisitId

setVisitId