com.tools20022.repository.entity.ShipmentDateRange Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tools20022-api-payments Show documentation
Java API for ISO 20022 - Payments business domain
The newest version!
/* Tools20022 - API for ISO 20022
* Copyright (C) 2017 Tools20022.com - László Bukodi 
* 
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* 
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
* 
* You should have received a copy of the GNU General Public License
* along with this program.  If not, see .
*/

package com.tools20022.repository.entity;

import com.tools20022.metamodel.*;
import com.tools20022.repository.choice.ShipmentSchedule2Choice;
import com.tools20022.repository.datatype.ISODateTime;
import com.tools20022.repository.GeneratedRepository;
import com.tools20022.repository.msg.ShipmentAttribute1;
import com.tools20022.repository.msg.ShipmentDateRange1;
import com.tools20022.repository.msg.ShipmentDateRange2;
import com.tools20022.repository.msg.TransactionCertificateContract1;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.concurrent.atomic.AtomicReference;

/**
 * Specifies a shipment period or a shipment date.
 * 
 * Class diagram
 * 

 * 
 * 

 * Constant fields:
 * 

 * {@linkplain com.tools20022.metamodel.MMBusinessComponent#getElement
 * element} =
 * 
 * 
 * {@linkplain com.tools20022.repository.entity.ShipmentDateRange#mmLatestShipmentDate
 * ShipmentDateRange.mmLatestShipmentDate}
 * 
 * {@linkplain com.tools20022.repository.entity.ShipmentDateRange#mmRelatedTransport
 * ShipmentDateRange.mmRelatedTransport}
 * 
 * {@linkplain com.tools20022.repository.entity.ShipmentDateRange#mmEarliestShipmentDate
 * ShipmentDateRange.mmEarliestShipmentDate}
 * 
 * {@linkplain com.tools20022.repository.entity.ShipmentDateRange#mmShipmentDate
 * ShipmentDateRange.mmShipmentDate}
 * 
 * 
 * 
 * {@linkplain com.tools20022.metamodel.MMBusinessComponent#getAssociationDomain
 * associationDomain} =
 * 
 * {@linkplain com.tools20022.repository.entity.Transport#mmShipmentDates
 * Transport.mmShipmentDates}
 * 
 * 
 * 
 * {@linkplain com.tools20022.metamodel.MMBusinessComponent#getDerivationElement
 * derivationElement} =
 * 
 * 
 * {@linkplain com.tools20022.repository.choice.ShipmentSchedule2Choice#mmShipmentDateRange
 * ShipmentSchedule2Choice.mmShipmentDateRange}
 * 
 * {@linkplain com.tools20022.repository.choice.ShipmentSchedule2Choice#mmShipmentSubSchedule
 * ShipmentSchedule2Choice.mmShipmentSubSchedule}
 * 
 * 
 * 
 * {@linkplain com.tools20022.metamodel.MMBusinessComponent#getDerivationComponent
 * derivationComponent} =
 * 
 * {@linkplain com.tools20022.repository.msg.ShipmentDateRange1
 * ShipmentDateRange1}
 * {@linkplain com.tools20022.repository.msg.ShipmentDateRange2
 * ShipmentDateRange2}
 * {@linkplain com.tools20022.repository.choice.ShipmentSchedule2Choice
 * ShipmentSchedule2Choice}
 * {@linkplain com.tools20022.repository.msg.ShipmentAttribute1
 * ShipmentAttribute1}
 * 
 * 
 * 
 * {@linkplain com.tools20022.metamodel.MMTopLevelDictionaryEntry#getDataDictionary
 * dataDictionary} =
 * {@linkplain com.tools20022.repository.GeneratedRepository#mmdataDict
 * GeneratedRepository.mmdataDict}
 * 
 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getRegistrationStatus
 * registrationStatus} =
 * com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getName name} =
 * "ShipmentDateRange"
 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getDefinition
 * definition} = "Specifies a shipment period or a shipment date."
 * 
 */
public class ShipmentDateRange {

	final static private AtomicReference mmObject_lazy = new AtomicReference<>();
	protected ISODateTime latestShipmentDate;
	/**
	 * Latest date whereby the goods must be shipped.
	 * 
	 * Constant fields:
	 * 

	 * 
	 * {@linkplain com.tools20022.metamodel.MMBusinessAttribute#getSimpleType
	 * simpleType} = {@linkplain com.tools20022.repository.datatype.ISODateTime
	 * ISODateTime}
	 * {@linkplain com.tools20022.metamodel.MMBusinessElement#getDerivation
	 * derivation} =
	 * 
	 * 
	 * {@linkplain com.tools20022.repository.msg.ShipmentDateRange1#mmLatestShipmentDate
	 * ShipmentDateRange1.mmLatestShipmentDate}
	 * 
	 * {@linkplain com.tools20022.repository.msg.ShipmentDateRange2#mmLatestShipmentDate
	 * ShipmentDateRange2.mmLatestShipmentDate}
	 * 
	 * {@linkplain com.tools20022.repository.msg.ShipmentAttribute1#mmExpectedDate
	 * ShipmentAttribute1.mmExpectedDate}
	 * 
	 * 
	 * 
	 * {@linkplain com.tools20022.metamodel.MMBusinessElement#getElementContext
	 * elementContext} =
	 * {@linkplain com.tools20022.repository.entity.ShipmentDateRange
	 * ShipmentDateRange}
	 * 
	 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getRegistrationStatus
	 * registrationStatus} =
	 * com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
	 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getName
	 * name} = "LatestShipmentDate"
	 * 
	 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getDefinition
	 * definition} = "Latest date whereby the goods must be shipped."
	 * 
	 */
	public static final MMBusinessAttribute mmLatestShipmentDate = new MMBusinessAttribute() {
		{
			derivation_lazy = () -> Arrays.asList(ShipmentDateRange1.mmLatestShipmentDate, ShipmentDateRange2.mmLatestShipmentDate, ShipmentAttribute1.mmExpectedDate);
			isDerived = false;
			elementContext_lazy = () -> com.tools20022.repository.entity.ShipmentDateRange.mmObject();
			registrationStatus = MMRegistrationStatus.REGISTERED;
			name = "LatestShipmentDate";
			definition = "Latest date whereby the goods must be shipped.";
			maxOccurs = 1;
			minOccurs = 1;
			simpleType_lazy = () -> ISODateTime.mmObject();
		}

		public Method getGetterMethod() {
			try {
				return ShipmentDateRange.class.getMethod("getLatestShipmentDate", new Class[]{});
			} catch (NoSuchMethodException e) {
				throw new RuntimeException(e);
			}
		}
	};
	protected Transport relatedTransport;
	/**
	 * Specifies the transport process to which the dates apply.
	 * 
	 * Constant fields:
	 * 

	 * 
	 * {@linkplain com.tools20022.metamodel.MMBusinessAssociationEnd#getOpposite
	 * opposite} =
	 * {@linkplain com.tools20022.repository.entity.Transport#mmShipmentDates
	 * Transport.mmShipmentDates}
	 * 
	 * {@linkplain com.tools20022.metamodel.MMBusinessAssociationEnd#getAggregation
	 * aggregation} = com.tools20022.metamodel.MMAggregation.NONE
	 * 
	 * {@linkplain com.tools20022.metamodel.MMBusinessAssociationEnd#getType
	 * type} = {@linkplain com.tools20022.repository.entity.Transport Transport}
	 * 
	 * 
	 * {@linkplain com.tools20022.metamodel.MMBusinessElement#getElementContext
	 * elementContext} =
	 * {@linkplain com.tools20022.repository.entity.ShipmentDateRange
	 * ShipmentDateRange}
	 * 
	 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getRegistrationStatus
	 * registrationStatus} =
	 * com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
	 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getName
	 * name} = "RelatedTransport"
	 * 
	 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getDefinition
	 * definition} = "Specifies the transport process to which the dates apply."
	 * 
	 * 
	 */
	public static final MMBusinessAssociationEnd mmRelatedTransport = new MMBusinessAssociationEnd() {
		{
			isDerived = false;
			elementContext_lazy = () -> com.tools20022.repository.entity.ShipmentDateRange.mmObject();
			registrationStatus = MMRegistrationStatus.REGISTERED;
			name = "RelatedTransport";
			definition = "Specifies the transport process to which the dates apply.";
			maxOccurs = 1;
			minOccurs = 0;
			opposite_lazy = () -> com.tools20022.repository.entity.Transport.mmShipmentDates;
			aggregation = MMAggregation.NONE;
			type_lazy = () -> com.tools20022.repository.entity.Transport.mmObject();
		}
	};
	protected ISODateTime earliestShipmentDate;
	/**
	 * Earliest date whereby the items must be shipped.
	 * 
	 * Constant fields:
	 * 

	 * 
	 * {@linkplain com.tools20022.metamodel.MMBusinessAttribute#getSimpleType
	 * simpleType} = {@linkplain com.tools20022.repository.datatype.ISODateTime
	 * ISODateTime}
	 * {@linkplain com.tools20022.metamodel.MMBusinessElement#getDerivation
	 * derivation} =
	 * 
	 * 
	 * {@linkplain com.tools20022.repository.msg.ShipmentDateRange1#mmEarliestShipmentDate
	 * ShipmentDateRange1.mmEarliestShipmentDate}
	 * 
	 * {@linkplain com.tools20022.repository.msg.ShipmentDateRange2#mmEarliestShipmentDate
	 * ShipmentDateRange2.mmEarliestShipmentDate}
	 * 
	 * 
	 * 
	 * {@linkplain com.tools20022.metamodel.MMBusinessElement#getElementContext
	 * elementContext} =
	 * {@linkplain com.tools20022.repository.entity.ShipmentDateRange
	 * ShipmentDateRange}
	 * 
	 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getRegistrationStatus
	 * registrationStatus} =
	 * com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
	 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getName
	 * name} = "EarliestShipmentDate"
	 * 
	 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getDefinition
	 * definition} = "Earliest date whereby the items must be shipped."
	 * 
	 */
	public static final MMBusinessAttribute mmEarliestShipmentDate = new MMBusinessAttribute() {
		{
			derivation_lazy = () -> Arrays.asList(ShipmentDateRange1.mmEarliestShipmentDate, ShipmentDateRange2.mmEarliestShipmentDate);
			isDerived = false;
			elementContext_lazy = () -> com.tools20022.repository.entity.ShipmentDateRange.mmObject();
			registrationStatus = MMRegistrationStatus.REGISTERED;
			name = "EarliestShipmentDate";
			definition = "Earliest date whereby the items must be shipped.";
			maxOccurs = 1;
			minOccurs = 1;
			simpleType_lazy = () -> ISODateTime.mmObject();
		}

		public Method getGetterMethod() {
			try {
				return ShipmentDateRange.class.getMethod("getEarliestShipmentDate", new Class[]{});
			} catch (NoSuchMethodException e) {
				throw new RuntimeException(e);
			}
		}
	};
	protected ISODateTime shipmentDate;
	/**
	 * Date at which the goods are shipped.
	 * 
	 * Constant fields:
	 * 

	 * 
	 * {@linkplain com.tools20022.metamodel.MMBusinessAttribute#getSimpleType
	 * simpleType} = {@linkplain com.tools20022.repository.datatype.ISODateTime
	 * ISODateTime}
	 * {@linkplain com.tools20022.metamodel.MMBusinessElement#getDerivation
	 * derivation} =
	 * 
	 * 
	 * {@linkplain com.tools20022.repository.msg.TransactionCertificateContract1#mmExpectedShipmentDate
	 * TransactionCertificateContract1.mmExpectedShipmentDate}
	 * 
	 * 
	 * 
	 * {@linkplain com.tools20022.metamodel.MMBusinessElement#getElementContext
	 * elementContext} =
	 * {@linkplain com.tools20022.repository.entity.ShipmentDateRange
	 * ShipmentDateRange}
	 * 
	 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getRegistrationStatus
	 * registrationStatus} =
	 * com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
	 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getName
	 * name} = "ShipmentDate"
	 * 
	 * {@linkplain com.tools20022.metamodel.MMRepositoryConcept#getDefinition
	 * definition} = "Date at which the goods are shipped."
	 * 
	 */
	public static final MMBusinessAttribute mmShipmentDate = new MMBusinessAttribute() {
		{
			derivation_lazy = () -> Arrays.asList(TransactionCertificateContract1.mmExpectedShipmentDate);
			isDerived = false;
			elementContext_lazy = () -> com.tools20022.repository.entity.ShipmentDateRange.mmObject();
			registrationStatus = MMRegistrationStatus.REGISTERED;
			name = "ShipmentDate";
			definition = "Date at which the goods are shipped.";
			maxOccurs = 1;
			minOccurs = 1;
			simpleType_lazy = () -> ISODateTime.mmObject();
		}

		public Method getGetterMethod() {
			try {
				return ShipmentDateRange.class.getMethod("getShipmentDate", new Class[]{});
			} catch (NoSuchMethodException e) {
				throw new RuntimeException(e);
			}
		}
	};

	static public MMBusinessComponent mmObject() {
		mmObject_lazy.compareAndSet(null, new MMBusinessComponent() {
			{
				dataDictionary_lazy = () -> GeneratedRepository.mmdataDict;
				registrationStatus = MMRegistrationStatus.REGISTERED;
				name = "ShipmentDateRange";
				definition = "Specifies a shipment period or a shipment date.";
				associationDomain_lazy = () -> Arrays.asList(com.tools20022.repository.entity.Transport.mmShipmentDates);
				derivationElement_lazy = () -> Arrays.asList(ShipmentSchedule2Choice.mmShipmentDateRange, ShipmentSchedule2Choice.mmShipmentSubSchedule);
				element_lazy = () -> Arrays.asList(com.tools20022.repository.entity.ShipmentDateRange.mmLatestShipmentDate, com.tools20022.repository.entity.ShipmentDateRange.mmRelatedTransport,
						com.tools20022.repository.entity.ShipmentDateRange.mmEarliestShipmentDate, com.tools20022.repository.entity.ShipmentDateRange.mmShipmentDate);
				derivationComponent_lazy = () -> Arrays.asList(ShipmentDateRange1.mmObject(), ShipmentDateRange2.mmObject(), ShipmentSchedule2Choice.mmObject(), ShipmentAttribute1.mmObject());
			}

			@Override
			public Class getInstanceClass() {
				return ShipmentDateRange.class;
			}
		});
		return mmObject_lazy.get();
	}

	public ISODateTime getLatestShipmentDate() {
		return latestShipmentDate;
	}

	public void setLatestShipmentDate(ISODateTime latestShipmentDate) {
		this.latestShipmentDate = latestShipmentDate;
	}

	public Transport getRelatedTransport() {
		return relatedTransport;
	}

	public void setRelatedTransport(com.tools20022.repository.entity.Transport relatedTransport) {
		this.relatedTransport = relatedTransport;
	}

	public ISODateTime getEarliestShipmentDate() {
		return earliestShipmentDate;
	}

	public void setEarliestShipmentDate(ISODateTime earliestShipmentDate) {
		this.earliestShipmentDate = earliestShipmentDate;
	}

	public ISODateTime getShipmentDate() {
		return shipmentDate;
	}

	public void setShipmentDate(ISODateTime shipmentDate) {
		this.shipmentDate = shipmentDate;
	}
}