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

Class PriceConstraint

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

Price constraint composite

An optional group of data elements which together describe a contractual term or constraint (or the absence of such a constraint) that forms part of the commercial offer for a product. Repeatable in order to describe multiple constraints on usage.

The Price constraint composite has the same structure as <EpubUsageConstraint>. Use <EpubUsageConstraint> for constraints that limit the user experience of the product, whether or not they are enforced by technical protection measures (DRM). Use <PriceConstraint> where a single product is available under multiple terms and conditions (ie multiple commercial offers for the same product which differ in their Price constraints, and whether or not they are enforced by DRM).

Reference name <PriceConstraint>
Short tag <priceconstraint>
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

    • PriceConstraint

      public PriceConstraint()

    • PriceConstraint

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

    • ifExists

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

    • priceConstraintType

      public PriceConstraintType priceConstraintType()

      An ONIX code specifying a type of commercial term or constraint forming part of the commercial offer for a digital product. Mandatory in each occurrence of the <PriceConstraint> composite, and non-repeating.

      Jonix-Comment: this field is required

    • priceConstraintStatus

      public PriceConstraintStatus priceConstraintStatus()

      An ONIX code specifying the status of a contractual term or constraint, eg permitted without limit, permitted with limit, prohibited. Mandatory in each occurrence of the <PriceConstraint> composite, and non-repeating.

      Jonix-Comment: this field is required

    • priceConstraintLimits

      public ListOfOnixDataComposite<PriceConstraintLimit,JonixPriceConstraintLimit> priceConstraintLimits()

      An optional and repeatable group of data elements which together specify a quantitative limit on a particular type of contractual term or constraint.

      Jonix-Comment: this list may be empty