com.tectonica.jonix.onix3.SentDateTime Maven / Gradle / Ivy
/*
* Copyright (C) 2012-2024 Zach Melamed
*
* Latest version available online at https://github.com/zach-m/jonix
* Contact me at [email protected]
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tectonica.jonix.onix3;
import com.tectonica.jonix.common.JPU;
import com.tectonica.jonix.common.OnixElement;
import com.tectonica.jonix.common.codelist.RecordSourceTypes;
import java.io.Serializable;
import java.util.function.Consumer;
/*
* NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
*/
/**
* Message creation date/time
*
* The date on which the message is sent. Optionally, the time may be added, using the 24-hour clock, with an explicit
* indication of the time zone if required, in a format based on ISO 8601. Mandatory and non-repeating.
*
*
*
* Format
* Permitted formats, where 'T' and 'Z' represent themselves (ie the letters T and Z), and where the symbol '±'
* represents either '+' or '-' to indicate a timezone offset from UTC. YYYYMMDD Date only YYYYMMDDThhmm Date and time
* (local time of sender) YYYYMMDDThhmmZ Universal time (UTC) † YYYYMMDDThhmm±hhmm With time zone offset from
* UTC † YYYYMMDDThhmmss Date and time (with seconds) YYYYMMDDThhmmssZ Universal time (with seconds)
* YYYYMMDDThhmmss±hhmm With time zone offset from UTC (with seconds) † indicates the preferred formats
*
*
* Reference name
* <SentDateTime>
*
*
* Short tag
* <x307>
*
*
* Cardinality
* 1
*
*
* Example
* <x307>20100522T1230Z</x307> (12.30pm UTC, 22 May 2010)
*
*
* Notes
* The calendar date must use the Gregorian calendar, even if other dates within the message use a different
* calendar. For all practical purposes, UTC is the same as GMT.
*
*
*
* This tag may be included in the following composites:
*
* - <{@link Header}>
*
*
* Possible placements within ONIX message:
*
* - {@link Header} ⯈ {@link SentDateTime}
*
*/
public class SentDateTime implements OnixElement, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "SentDateTime";
public static final String shortname = "x307";
/////////////////////////////////////////////////////////////////////////////////
// ATTRIBUTES
/////////////////////////////////////////////////////////////////////////////////
/**
* (type: dt.DateOrDateTime)
*/
public String datestamp;
/**
* (type: dt.NonEmptyString)
*/
public String sourcename;
public RecordSourceTypes sourcetype;
/////////////////////////////////////////////////////////////////////////////////
// VALUE MEMBER
/////////////////////////////////////////////////////////////////////////////////
/**
* This is the raw content of SentDateTime. Could be null if {@code exists() == false}. Use {@link #value()} instead
* if you want to get this as an {@link java.util.Optional}.
*
* Raw Format: Permitted formats, where 'T' and 'Z' represent themselves (ie the letters T and Z), and where the
* symbol '±' represents either '+' or '-' to indicate a timezone offset from UTC. YYYYMMDD Date only
* YYYYMMDDThhmm Date and time (local time of sender) YYYYMMDDThhmmZ Universal time (UTC) †
* YYYYMMDDThhmm±hhmm With time zone offset from UTC † YYYYMMDDThhmmss Date and time (with seconds)
* YYYYMMDDThhmmssZ Universal time (with seconds) YYYYMMDDThhmmss±hhmm With time zone offset from UTC (with
* seconds) † indicates the preferred formats
*
* (type: dt.DateOrDateTime)
*/
public String value;
/**
* Internal API, use the {@link #value()} method or the {@link #value} field instead
*/
@Override
public String __v() {
return value;
}
/////////////////////////////////////////////////////////////////////////////////
// SERVICES
/////////////////////////////////////////////////////////////////////////////////
private final boolean exists;
public static final SentDateTime EMPTY = new SentDateTime();
public SentDateTime() {
exists = false;
}
public SentDateTime(org.w3c.dom.Element element) {
exists = true;
datestamp = JPU.getAttribute(element, "datestamp");
sourcename = JPU.getAttribute(element, "sourcename");
sourcetype = RecordSourceTypes.byCode(JPU.getAttribute(element, "sourcetype"));
value = JPU.getContentAsString(element);
}
/**
* @return whether this tag (<SentDateTime> or <x307>) is explicitly provided in the ONIX XML
*/
@Override
public boolean exists() {
return exists;
}
public void ifExists(Consumer action) {
if (exists) {
action.accept(this);
}
}
}