org.orcid.jaxb.model.record_v3

Class Work

java.lang.Object

org.orcid.jaxb.model.common_v3.ElementSummary

org.orcid.jaxb.model.record_v3.Work

All Implemented Interfaces:

Serializable, org.jvnet.jaxb2_commons.lang.ToString

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public class Work
extends ElementSummary
implements Serializable, org.jvnet.jaxb2_commons.lang.ToString

A work is any research output that the researcher produced or contributed to * The put-code attribute is used only when reading this element. When updating the item, the put-code attribute must be included to indicate the specific record to be updated.

Java class for anonymous complex type.

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

 <complexType>
   <complexContent>
     <extension base="{http://www.orcid.org/ns/common}element-summary">
       <sequence>
         <element name="title" type="{http://www.orcid.org/ns/work}work-title"/>
         <element name="journal-title" type="{http://www.orcid.org/ns/common}string-1000" minOccurs="0"/>
         <element name="short-description" type="{http://www.orcid.org/ns/common}short-description" minOccurs="0"/>
         <element name="citation" type="{http://www.orcid.org/ns/work}citation" minOccurs="0"/>
         <element name="type" type="{http://www.orcid.org/ns/work}work-type"/>
         <element ref="{http://www.orcid.org/ns/common}publication-date" minOccurs="0"/>
         <element ref="{http://www.orcid.org/ns/common}external-ids" minOccurs="0"/>
         <element ref="{http://www.orcid.org/ns/common}url" minOccurs="0"/>
         <element name="contributors" type="{http://www.orcid.org/ns/work}work-contributors" minOccurs="0"/>
         <element ref="{http://www.orcid.org/ns/common}language-code" minOccurs="0"/>
         <element ref="{http://www.orcid.org/ns/common}country" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Citation	citation
protected WorkContributors	contributors
protected Country	country
protected ExternalIds	externalIds
protected String	journalTitle
protected String	languageCode
protected FuzzyDate	publicationDate
protected String	shortDescription
protected WorkTitle	title
protected String	type
protected Url	url

Fields inherited from class org.orcid.jaxb.model.common_v3.ElementSummary

createdDate, displayIndex, lastModifiedDate, path, putCode, source, visibility

Constructor Summary

Constructors

Constructor and Description
Work() Default no-arg constructor
Work(CreatedDate createdDate, LastModifiedDate lastModifiedDate, SourceType source, BigInteger putCode, Visibility visibility, String displayIndex, String path, WorkTitle title, String journalTitle, String shortDescription, Citation citation, String type, FuzzyDate publicationDate, ExternalIds externalIds, Url url, WorkContributors contributors, String languageCode, Country country) Fully-initialising value constructor

Method Summary

Modifier and Type	Method and Description
StringBuilder	append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)
StringBuilder	appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)
Citation	getCitation() Gets the value of the citation property.
WorkContributors	getContributors() Gets the value of the contributors property.
Country	getCountry() Gets the value of the country property.
ExternalIds	getExternalIds() Required when writing work items.
String	getJournalTitle() Gets the value of the journalTitle property.
String	getLanguageCode() The language used for the metadata provided about the work
FuzzyDate	getPublicationDate() Gets the value of the publicationDate property.
String	getShortDescription() Gets the value of the shortDescription property.
WorkTitle	getTitle() Gets the value of the title property.
String	getType() Gets the value of the type property.
Url	getUrl() Gets the value of the url property.
void	setCitation(Citation value) Sets the value of the citation property.
void	setContributors(WorkContributors value) Sets the value of the contributors property.
void	setCountry(Country value) Sets the value of the country property.
void	setExternalIds(ExternalIds value) Sets the value of the externalIds property.
void	setJournalTitle(String value) Sets the value of the journalTitle property.
void	setLanguageCode(String value) Sets the value of the languageCode property.
void	setPublicationDate(FuzzyDate value) Sets the value of the publicationDate property.
void	setShortDescription(String value) Sets the value of the shortDescription property.
void	setTitle(WorkTitle value) Sets the value of the title property.
void	setType(String value) Sets the value of the type property.
void	setUrl(Url value) Sets the value of the url property.
String	toString()

Methods inherited from class org.orcid.jaxb.model.common_v3.ElementSummary

getCreatedDate, getDisplayIndex, getLastModifiedDate, getPath, getPutCode, getSource, getVisibility, setCreatedDate, setDisplayIndex, setLastModifiedDate, setPath, setPutCode, setSource, setVisibility

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

title

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
protected WorkTitle title

journalTitle

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
protected String journalTitle

shortDescription

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
protected String shortDescription

citation

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
protected Citation citation

type

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
protected String type

publicationDate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
protected FuzzyDate publicationDate

externalIds

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
protected ExternalIds externalIds

url

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
protected Url url

contributors

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
protected WorkContributors contributors

languageCode

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
protected String languageCode

country

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
protected Country country

Constructor Detail

Work

public Work()

Default no-arg constructor

Work

public Work(CreatedDate createdDate,
            LastModifiedDate lastModifiedDate,
            SourceType source,
            BigInteger putCode,
            Visibility visibility,
            String displayIndex,
            String path,
            WorkTitle title,
            String journalTitle,
            String shortDescription,
            Citation citation,
            String type,
            FuzzyDate publicationDate,
            ExternalIds externalIds,
            Url url,
            WorkContributors contributors,
            String languageCode,
            Country country)

Fully-initialising value constructor

Method Detail

getTitle

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public WorkTitle getTitle()

Gets the value of the title property.

Returns:

possible object is WorkTitle

setTitle

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public void setTitle(WorkTitle value)

Sets the value of the title property.

Parameters:

value - allowed object is WorkTitle

getJournalTitle

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public String getJournalTitle()

Gets the value of the journalTitle property.

Returns:

possible object is String

setJournalTitle

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public void setJournalTitle(String value)

Sets the value of the journalTitle property.

Parameters:

value - allowed object is String

getShortDescription

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public String getShortDescription()

Gets the value of the shortDescription property.

Returns:

possible object is String

setShortDescription

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public void setShortDescription(String value)

Sets the value of the shortDescription property.

Parameters:

value - allowed object is String

getCitation

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public Citation getCitation()

Gets the value of the citation property.

Returns:

possible object is Citation

setCitation

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public void setCitation(Citation value)

Sets the value of the citation property.

Parameters:

value - allowed object is Citation

getType

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public String getType()

Gets the value of the type property.

Returns:

possible object is String

setType

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public void setType(String value)

Sets the value of the type property.

Parameters:

value - allowed object is String

getPublicationDate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public FuzzyDate getPublicationDate()

Gets the value of the publicationDate property.

Returns:

possible object is FuzzyDate

setPublicationDate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public void setPublicationDate(FuzzyDate value)

Sets the value of the publicationDate property.

Parameters:

value - allowed object is FuzzyDate

getExternalIds

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public ExternalIds getExternalIds()

Required when writing work items. The list of supported identifier types is at https://pub.qa.orcid.org/v2.0/identifiers

Returns:

possible object is ExternalIds

setExternalIds

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public void setExternalIds(ExternalIds value)

Sets the value of the externalIds property.

Parameters:

value - allowed object is ExternalIds

getUrl

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public Url getUrl()

Gets the value of the url property.

Returns:

possible object is Url

setUrl

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public void setUrl(Url value)

Sets the value of the url property.

Parameters:

value - allowed object is Url

getContributors

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public WorkContributors getContributors()

Gets the value of the contributors property.

Returns:

possible object is WorkContributors

setContributors

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public void setContributors(WorkContributors value)

Sets the value of the contributors property.

Parameters:

value - allowed object is WorkContributors

getLanguageCode

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public String getLanguageCode()

The language used for the metadata provided about the work

Returns:

possible object is String

setLanguageCode

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public void setLanguageCode(String value)

Sets the value of the languageCode property.

Parameters:

value - allowed object is String

getCountry

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public Country getCountry()

Gets the value of the country property.

Returns:

possible object is Country

setCountry

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public void setCountry(Country value)

Sets the value of the country property.

Parameters:

value - allowed object is Country

toString

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public String toString()

Overrides:

toString in class ElementSummary

append

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                                                                                                                                                                StringBuilder buffer,
                                                                                                                                                                org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)

Specified by:

append in interface org.jvnet.jaxb2_commons.lang.ToString

Overrides:

append in class ElementSummary

appendFields

@Generated(value="com.sun.tools.xjc.Driver",
           date="2020-04-17T05:31:42+02:00",
           comments="JAXB RI v2.2.11")
public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                                                                                                                                                                      StringBuilder buffer,
                                                                                                                                                                      org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)

Specified by:

appendFields in interface org.jvnet.jaxb2_commons.lang.ToString

Overrides:

appendFields in class ElementSummary