Module jonix.onix2
Package com.tectonica.jonix.onix2

Class MarketRepresentation

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

Market representation composite

A group of data elements which together specify a territorial market and the identity of a sales agent or local publisher responsible for marketing the product therein. Optional and repeatable.

Reference name <MarketRepresentation>
Short tag <marketrepresentation>

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-2.12
See Also:

  • Field Details

  • Constructor Details

    • MarketRepresentation

      public MarketRepresentation()

    • MarketRepresentation

      public MarketRepresentation(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 (<MarketRepresentation> or <marketrepresentation>) is explicitly provided in the ONIX XML

    • ifExists

      public void ifExists(Consumer<MarketRepresentation> 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

    • marketTerritory

      public MarketTerritory marketTerritory()

      One or more ONIX codes identifying a territory which is not a country, but which is precisely defined in geographical terms, eg World, Northern Ireland, Australian Capital Territory. Successive codes are separated by spaces. Thus the element can carry an unlimited number of territory codes. Optional, but each occurrence of the <MarketRepresentation> composite must carry either an occurrence of <MarketCountry> or an occurrence of <MarketTerritory>, to specify the market concerned. Non-repeating.

      Jonix-Comment: this field is required

    • agentIdentifiers

      public ListOfOnixDataCompositeWithKey<AgentIdentifier,JonixAgentIdentifier,SupplierIdentifierTypes> agentIdentifiers()

      A group of data elements together defining the identifier of an agent or local publisher in accordance with a specified scheme. Optional, but each occurrence of the <MarketRepresentation> composite must carry either at least one agent identifier, or an <AgentName>. Repeatable only if two or more identifiers are sent using different schemes.

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

    • agentName

      public AgentName agentName()

      The name of an agent or local publisher. Optional and non-repeating; required if no agent identifier is sent in an occurrence of the <MarketRepresentation> composite.

      Jonix-Comment: this field is optional

    • agentRole

      public AgentRole agentRole()

      An ONIX code identifying the role of an agent in relation to the product in the specified market, eg Exclusive sales agent, Local publisher, etc. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • marketCountry

      public MarketCountry marketCountry()

      One or more ISO standard codes identifying a country in which the agent or local publisher markets the product. Successive codes are separated by spaces. Thus, a single occurrence of the element can carry an unlimited number of country codes. Optional, but each occurrence of the <MarketRepresentation> composite must carry either an occurrence of <MarketCountry> or an occurrence of <MarketTerritory>, to specify the market concerned. Non-repeating.

      Jonix-Comment: this field is optional

    • marketCountryExcluded

      public MarketCountryExcluded marketCountryExcluded()

      One or more ISO standard codes identifying a country which is excluded from a territory specified in <MarketTerritory>. Successive codes are separated by spaces. Thus, a single occurrence of the element can carry an unlimited number of country codes. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • marketRestrictionDetail

      public MarketRestrictionDetail marketRestrictionDetail()

      A free text field describing a non-geographical restriction of the market covered by a sales agent or local publisher. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • marketPublishingStatus

      public MarketPublishingStatus marketPublishingStatus()

      An ONIX code which identifies the status of a published product in the market defined in an occurrence of the <MarketRepresentation> composite. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • telephoneNumbers

      public ListOfOnixElement<TelephoneNumber,String> telephoneNumbers()

      A telephone number of an agent or local publisher. Optional and repeatable.

      Jonix-Comment: this list may be empty

    • faxNumbers

      public ListOfOnixElement<FaxNumber,String> faxNumbers()

      A fax number of an agent or local publisher. Optional and repeatable.

      Jonix-Comment: this list may be empty

    • emailAddresss

      public ListOfOnixElement<EmailAddress,String> emailAddresss()

      An email address for an agent or local publisher. Optional and repeatable.

      Jonix-Comment: this list may be empty

    • websites

      public ListOfOnixDataComposite<Website,JonixWebsite> websites()

      An optional and repeatable group of data elements which together identify and provide pointers to a website which is related to the agent or local publisher identified in an occurrence of the <MarketRepresentation> composite.

      Jonix-Comment: this list may be empty

    • marketDates

      public ListOfOnixDataCompositeWithKey<MarketDate,JonixMarketDate,PublishingDateRoles> marketDates()

      A repeatable group of data elements which together specify a date associated with the publishing status of the product in the market identified in an occurrence of the <MarketRepresentation> composite, eg local publication date.

      Jonix-Comment: this list may be empty