Instrument (ICAT Clients 5.0.0 API)

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

public class Instrument
extends EntityBaseBean

Java class for instrument complex type.

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

 <complexType name="instrument">
   <complexContent>
     <extension base="{http://icatproject.org}entityBaseBean">
       <sequence>
         <element name="datasetInstruments" type="{http://icatproject.org}datasetInstrument" maxOccurs="unbounded" minOccurs="0"/>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="facility" type="{http://icatproject.org}facility" minOccurs="0"/>
         <element name="fullName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="instrumentScientists" type="{http://icatproject.org}instrumentScientist" maxOccurs="unbounded" minOccurs="0"/>
         <element name="investigationInstruments" type="{http://icatproject.org}investigationInstrument" maxOccurs="unbounded" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="pid" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="shifts" type="{http://icatproject.org}shift" maxOccurs="unbounded" minOccurs="0"/>
         <element name="type" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="url" 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<DatasetInstrument>`	`datasetInstruments`
`protected String`	`description`
`protected Facility`	`facility`
`protected String`	`fullName`
`protected List<InstrumentScientist>`	`instrumentScientists`
`protected List<InvestigationInstrument>`	`investigationInstruments`
`protected String`	`name`
`protected String`	`pid`
`protected List<Shift>`	`shifts`
`protected String`	`type`
`protected String`	`url`

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

Constructor Summary

Constructors
Constructor and Description

Instrument()

Constructors
Constructor and Description
`Instrument()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<DatasetInstrument>`	`getDatasetInstruments()` Gets the value of the datasetInstruments property.
`String`	`getDescription()` Gets the value of the description property.
`Facility`	`getFacility()` Gets the value of the facility property.
`String`	`getFullName()` Gets the value of the fullName property.
`List<InstrumentScientist>`	`getInstrumentScientists()` Gets the value of the instrumentScientists property.
`List<InvestigationInstrument>`	`getInvestigationInstruments()` Gets the value of the investigationInstruments property.
`String`	`getName()` Gets the value of the name property.
`String`	`getPid()` Gets the value of the pid property.
`List<Shift>`	`getShifts()` Gets the value of the shifts property.
`String`	`getType()` Gets the value of the type property.
`String`	`getUrl()` Gets the value of the url property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setFacility(Facility value)` Sets the value of the facility property.
`void`	`setFullName(String value)` Sets the value of the fullName property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setPid(String value)` Sets the value of the pid property.
`void`	`setType(String value)` Sets the value of the type property.
`void`	`setUrl(String value)` Sets the value of the url 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
  - datasetInstruments
```
protected List<DatasetInstrument> datasetInstruments
```
  - description
```
protected String description
```
  - facility
```
protected Facility facility
```
  - fullName
```
protected String fullName
```
  - instrumentScientists
```
protected List<InstrumentScientist> instrumentScientists
```
  - investigationInstruments
```
protected List<InvestigationInstrument> investigationInstruments
```
  - name
```
protected String name
```
  - pid
```
protected String pid
```
  - shifts
```
protected List<Shift> shifts
```
  - type
```
protected String type
```
  - url
```
protected String url
```
- Constructor Detail
  - Instrument
```
public Instrument()
```
- Method Detail
  - getDatasetInstruments
```
public List<DatasetInstrument> getDatasetInstruments()
```
    Gets the value of the datasetInstruments 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 datasetInstruments property.
    For example, to add a new item, do as follows:
```
    getDatasetInstruments().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list DatasetInstrument
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - 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
  - getFullName
```
public String getFullName()
```
    Gets the value of the fullName property.
    
    Returns:
    
    possible object is String
  - setFullName
```
public void setFullName(String value)
```
    Sets the value of the fullName property.
    
    Parameters:
    
    value - allowed object is String
  - getInstrumentScientists
```
public List<InstrumentScientist> getInstrumentScientists()
```
    Gets the value of the instrumentScientists 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 instrumentScientists property.
    For example, to add a new item, do as follows:
```
    getInstrumentScientists().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list InstrumentScientist
  - getInvestigationInstruments
```
public List<InvestigationInstrument> getInvestigationInstruments()
```
    Gets the value of the investigationInstruments 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 investigationInstruments property.
    For example, to add a new item, do as follows:
```
    getInvestigationInstruments().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list InvestigationInstrument
  - 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
  - getPid
```
public String getPid()
```
    Gets the value of the pid property.
    
    Returns:
    
    possible object is String
  - setPid
```
public void setPid(String value)
```
    Sets the value of the pid property.
    
    Parameters:
    
    value - allowed object is String
  - 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
  - getType
```
public String getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is String
  - setType
```
public void setType(String value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is String
  - getUrl
```
public String getUrl()
```
    Gets the value of the url property.
    
    Returns:
    
    possible object is String
  - setUrl
```
public void setUrl(String value)
```
    Sets the value of the url property.
    
    Parameters:
    
    value - allowed object is String

Class Instrument

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

datasetInstruments

description

facility

fullName

instrumentScientists

investigationInstruments

name

pid

shifts

type

url

Constructor Detail

Instrument

Method Detail

getDatasetInstruments

getDescription

setDescription

getFacility

setFacility

getFullName

setFullName

getInstrumentScientists

getInvestigationInstruments

getName

setName

getPid

setPid

getShifts

getType

setType

getUrl

setUrl