Module jonix.onix3
Package com.tectonica.jonix.onix3

Class Prize

java.lang.Object
com.tectonica.jonix.onix3.Prize
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable
public class Prize extends Object implements OnixComposite.OnixSuperComposite, Serializable

Prize composite

An optional group of data elements which together describe a prize or award won by the contributor for a body of work (rather than for this or other specific works or products). Repeatable to describe multiple prizes or awards.

Reference name <Prize>
Short tag <prize>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.03
See Also:

  • Field Details

  • Constructor Details

    • Prize

      public Prize()

    • Prize

      public Prize(Element element)

  • Method Details

    • _initialize

      public void _initialize()
      Description copied from interface: OnixComposite
      This is an internal API. Since Jonix 8.0, composite objects are being populated lazily. This method initiates the population process, and is invoked internally by the accessor APIs of the composites
      Specified by:
      _initialize in interface OnixComposite

    • exists

      public boolean exists()
      Description copied from interface: OnixTag
      indicates whether this tag exists in the ONIX record
      Specified by:
      exists in interface OnixTag
      Returns:
      whether this tag (<Prize> or <prize>) is explicitly provided in the ONIX XML

    • ifExists

      public void ifExists(Consumer<Prize> action)

    • getXmlElement

      public Element getXmlElement()
      Description copied from interface: OnixComposite
      For advanced use-cases only.
      Specified by:
      getXmlElement in interface OnixComposite
      Returns:
      native representation of the XML element underlying to this tag

    • prizeNames

      public ListOfOnixElement<PrizeName,String> prizeNames()

      The name of a prize or award which the product or work has received. Mandatory in each occurrence of the <Prize> composite, and repeatable to provide a parallel award name in multiple languages. The language attribute is optional for a single instance of <PrizeName>, but must be included in each instance if <PrizeName> is repeated.

      Jonix-Comment: this list is required to contain at least one item

    • sequenceNumber

      public SequenceNumber sequenceNumber()

      A number which specifies a single overall sequence of prizes. Optional and non-repeating. It is strongly recommended that if any occurrence of the <Prize> composite carries a <SequenceNumber>, then all should carry a <SequenceNumber>.

      Jonix-Comment: this field is optional

    • prizeYear

      public PrizeYear prizeYear()

      The year in which a prize or award was given. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • prizeCountry

      public PrizeCountry prizeCountry()

      An ONIX code identifying the country in which a prize or award is given. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • prizeRegion

      public PrizeRegion prizeRegion()

      An ONIX code identifying the region in which a prize or award is given. Optional and non-repeatable. A region is an area which is not a country, but which is precisely defined in geographical terms, eg Newfoundland and Labrador, Florida. If both country and region are specified, the region must be within the country. Note that US States have region codes, while US overseas territories have distinct ISO Country Codes.

      Jonix-Comment: this field is optional

    • prizeCode

      public PrizeCode prizeCode()

      An ONIX code indicating the achievement of the product in relation to a prize or award, eg winner, runner-up, shortlisted. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • prizeIdentifiers

      public ListOfOnixDataCompositeWithKey<PrizeIdentifier,JonixPrizeIdentifier,PrizeIdentifierTypes> prizeIdentifiers()

      A group of data elements which together specify an identifier for the Prize. The composite is optional, and repatable if more than one identifier for the same prize is sent.

      Jonix-Comment: this list may be empty

    • awardingBodys

      public ListOfOnixElement<AwardingBody,String> awardingBodys()

      The name of the organization(s) that awarded the prize. Optional, and repeatable if the text is provided in more than one language. The language attribute is optional for a single instance of <AwardingBody>, but must be included in each instance if <AwardingBody> is repeated.

      Jonix-Comment: this list may be empty

    • prizeStatements

      public ListOfOnixElement<PrizeStatement,String> prizeStatements()

      A short free-text description of the prize or award, intended primarily for display. Optional, and repeatable if the text is provided in more than one language. The language attribute is optional for a single instance of <PrizeStatement>, but must be included in each instance if <PrizeStatement> is repeated.

      <PrizeStatement> is intended for display purposes only. When used, a <PrizeStatement> must be complete in itself, ie it should not be treated as merely supplementary to other elements within the <Prize> composite. Nor should <PrizeStatement> be supplied instead of those other elements – at minimum, the <PrizeCode> element, and whenever appropriate the <PrizeYear> element should be supplied.

      Jonix-Comment: this list may be empty

    • prizeJurys

      public ListOfOnixElement<PrizeJury,String> prizeJurys()

      Free text listing members of the jury that awarded the prize. Optional, and repeatable if the text is provided in more than one language. The language attribute is optional for a single instance of <PrizeJury>, but must be included in each instance if <PrizeJury> is repeated.

      Jonix-Comment: this list may be empty