java.lang.Object

com.tectonica.jonix.onix3.VelocityMetric

All Implemented Interfaces:: OnixElement<VelocityMetrics>, OnixTag, Serializable

public class VelocityMetric extends Object implements OnixElement<VelocityMetrics>, Serializable

Velocity metric

An ONIX code that specifies how the rate of stock depletion is measured. Mandatory within the <Velocity> composite, and non-repeating.

Format	Fixed length, two digits
Codelist	List 216
Reference name	`<VelocityMetric>`
Short tag	`<x504>`
Cardinality	1
Example	`<x504>02</x504>` (Mean daily sale)

This tag may be included in the following composites:

<Velocity>

Possible placements within ONIX message:

Product ⯈ ProductSupply ⯈ SupplyDetail ⯈ Stock ⯈ Velocity ⯈ VelocityMetric

Since:

Onix-3.02

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type

Field

Description

String

datestamp

(type: dt.DateOrDateTime)

static final VelocityMetric

EMPTY

static final String

refname

static final String

shortname

String

sourcename

(type: dt.NonEmptyString)

RecordSourceTypes

sourcetype

VelocityMetrics

value
Constructor Summary

Constructors

Constructor

Description

VelocityMetric()

VelocityMetric(Element element)
Method Summary

Modifier and Type

Method

Description

VelocityMetrics

__v()

Internal API, use the OnixElement.value() method or the OnixElement.value() field instead

String

codeOrNull()

String

descriptionOrNull()

boolean

exists()

indicates whether this tag exists in the ONIX record

void

ifExists(Consumer<VelocityMetric> action)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tectonica.jonix.common.OnixElement
equal, is, isNull, value

Field Details
- refname
  
  public static final String refname
  See Also:
  
  Constant Field Values
- shortname
  
  public static final String shortname
  See Also:
  
  Constant Field Values
- datestamp
  
  public String datestamp
  
  (type: dt.DateOrDateTime)
- sourcename
  
  public String sourcename
  
  (type: dt.NonEmptyString)
- sourcetype
  
  public RecordSourceTypes sourcetype
- value
  
  public VelocityMetrics value
- EMPTY
  
  public static final VelocityMetric EMPTY
Constructor Details
- VelocityMetric
  
  public VelocityMetric()
- VelocityMetric
  
  public VelocityMetric(Element element)
Method Details
- __v
  
  public VelocityMetrics __v()
  
  Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
  
  Specified by:
  
  __v in interface OnixElement<VelocityMetrics>
- 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 (<VelocityMetric> or <x504>) is explicitly provided in the ONIX XML
- ifExists
  
  public void ifExists(Consumer<VelocityMetric> action)
- codeOrNull
  
  public String codeOrNull()
- descriptionOrNull
  
  public String descriptionOrNull()