Package com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.freightorderintegration

Class FreightOrderStop

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<FreightOrderStop>
com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.freightorderintegration.FreightOrderStop
All Implemented Interfaces:
VdmEntitySet
public class FreightOrderStop extends VdmEntity<FreightOrderStop> implements VdmEntitySet
Freight Order Stop

Original entity name from the Odata EDM: FreightOrderStop_Type

  • Field Details

  • Constructor Details

    • FreightOrderStop

      public FreightOrderStop()

    • FreightOrderStop

      public FreightOrderStop(@Nullable UUID transportationOrderStopUUID, @Nullable UUID transportationOrderUUID, @Nullable String transportationOrderStop, @Nullable String transpOrdStopCategory, @Nullable String transpOrdStopRole, @Nullable UUID locationAdditionalUUID, @Nullable String locationId, @Nullable String locationUNCode, @Nullable String locationIATACode, @Nullable OffsetDateTime transpOrdStopPlanTranspDteTme, @Nullable OffsetDateTime transpOrdStopDteTme, @Nullable OffsetDateTime transpOrdStopApptStrtDteTme, @Nullable OffsetDateTime transpOrdStopApptEndDteTme, @Nullable OffsetDateTime transpStopCarrConfStrtDteTme, @Nullable OffsetDateTime transpStopCarrConfEndDteTme, @Nullable String transpOrdStopSequencePosition, @Nullable String transpOrdStopHndlgExecStatus, @Nullable Boolean transpOrdStopExecIsBlocked, @Nullable FreightOrder to_FreightOrder, List<FreightOrderStage> to_FreightOrderStage)

  • Method Details

    • getType

      @Nonnull public Class<FreightOrderStop> getType()
      Specified by:
      getType in class VdmObject<FreightOrderStop>

    • setTransportationOrderStopUUID

      public void setTransportationOrderStopUUID(@Nullable UUID transportationOrderStopUUID)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: TransportationOrderStopUUID

      Parameters:
      transportationOrderStopUUID - NodeID

    • setTransportationOrderUUID

      public void setTransportationOrderUUID(@Nullable UUID transportationOrderUUID)
      Constraints: Not nullable

      Original property name from the Odata EDM: TransportationOrderUUID

      Parameters:
      transportationOrderUUID - Transportation Order UUID

    • setTransportationOrderStop

      public void setTransportationOrderStop(@Nullable String transportationOrderStop)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: TransportationOrderStop

      Parameters:
      transportationOrderStop - Stop

    • setTranspOrdStopCategory

      public void setTranspOrdStopCategory(@Nullable String transpOrdStopCategory)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: TranspOrdStopCategory

      Parameters:
      transpOrdStopCategory - Stop Category

    • setTranspOrdStopRole

      public void setTranspOrdStopRole(@Nullable String transpOrdStopRole)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TranspOrdStopRole

      Parameters:
      transpOrdStopRole - Role of the Stop

    • setLocationAdditionalUUID

      public void setLocationAdditionalUUID(@Nullable UUID locationAdditionalUUID)
      Constraints: Nullable

      Original property name from the Odata EDM: LocationAdditionalUUID

      Parameters:
      locationAdditionalUUID - Location Additonal UUID (RAW 16)

    • setLocationId

      public void setLocationId(@Nullable String locationId)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: LocationId

      Parameters:
      locationId - Location

    • setLocationUNCode

      public void setLocationUNCode(@Nullable String locationUNCode)
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: LocationUNCode

      Parameters:
      locationUNCode - United Nations Code for Trade and Transport Locations

    • setLocationIATACode

      public void setLocationIATACode(@Nullable String locationIATACode)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: LocationIATACode

      Parameters:
      locationIATACode - International Air Transport Association: Location

    • setTranspOrdStopPlanTranspDteTme

      public void setTranspOrdStopPlanTranspDteTme(@Nullable OffsetDateTime transpOrdStopPlanTranspDteTme)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspOrdStopPlanTranspDteTme

      Parameters:
      transpOrdStopPlanTranspDteTme - Created on Timestamp

    • setTranspOrdStopDteTme

      public void setTranspOrdStopDteTme(@Nullable OffsetDateTime transpOrdStopDteTme)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspOrdStopDteTme

      Parameters:
      transpOrdStopDteTme - Actual Date/Time of Event

    • setTranspOrdStopApptStrtDteTme

      public void setTranspOrdStopApptStrtDteTme(@Nullable OffsetDateTime transpOrdStopApptStrtDteTme)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspOrdStopApptStrtDteTme

      Parameters:
      transpOrdStopApptStrtDteTme - Created on Timestamp

    • setTranspOrdStopApptEndDteTme

      public void setTranspOrdStopApptEndDteTme(@Nullable OffsetDateTime transpOrdStopApptEndDteTme)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspOrdStopApptEndDteTme

      Parameters:
      transpOrdStopApptEndDteTme - Created on Timestamp

    • setTranspStopCarrConfStrtDteTme

      public void setTranspStopCarrConfStrtDteTme(@Nullable OffsetDateTime transpStopCarrConfStrtDteTme)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspStopCarrConfStrtDteTme

      Parameters:
      transpStopCarrConfStrtDteTme - Created on Timestamp

    • setTranspStopCarrConfEndDteTme

      public void setTranspStopCarrConfEndDteTme(@Nullable OffsetDateTime transpStopCarrConfEndDteTme)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspStopCarrConfEndDteTme

      Parameters:
      transpStopCarrConfEndDteTme - Created on Timestamp

    • setTranspOrdStopSequencePosition

      public void setTranspOrdStopSequencePosition(@Nullable String transpOrdStopSequencePosition)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: TranspOrdStopSequencePosition

      Parameters:
      transpOrdStopSequencePosition - Stop Position in Transportation Stop Sequence

    • setTranspOrdStopHndlgExecStatus

      public void setTranspOrdStopHndlgExecStatus(@Nullable String transpOrdStopHndlgExecStatus)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TranspOrdStopHndlgExecStatus

      Parameters:
      transpOrdStopHndlgExecStatus - Handling Execution Status at Stop Level

    • setTranspOrdStopExecIsBlocked

      public void setTranspOrdStopExecIsBlocked(@Nullable Boolean transpOrdStopExecIsBlocked)
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspOrdStopExecIsBlocked

      Parameters:
      transpOrdStopExecIsBlocked - Execution Block

    • getEntityCollection

      protected String getEntityCollection()
      Specified by:
      getEntityCollection in class VdmEntity<FreightOrderStop>

    • getKey

      @Nonnull protected ODataEntityKey getKey()
      Overrides:
      getKey in class VdmObject<FreightOrderStop>

    • toMapOfFields

      @Nonnull protected Map<String,Object> toMapOfFields()
      Overrides:
      toMapOfFields in class VdmObject<FreightOrderStop>

    • fromMap

      protected void fromMap(Map<String,Object> inputValues)
      Overrides:
      fromMap in class VdmObject<FreightOrderStop>

    • getDefaultServicePath

      protected String getDefaultServicePath()
      Overrides:
      getDefaultServicePath in class VdmEntity<FreightOrderStop>

    • toMapOfNavigationProperties

      @Nonnull protected Map<String,Object> toMapOfNavigationProperties()
      Overrides:
      toMapOfNavigationProperties in class VdmObject<FreightOrderStop>

    • getFreightOrderIfPresent

      @Nonnull public io.vavr.control.Option<FreightOrder> getFreightOrderIfPresent()
      Retrieval of associated FreightOrder entity (one to one). This corresponds to the OData navigation property _FreightOrder.

      If the navigation property for an entity FreightOrderStop has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.

      Returns:
      If the information for navigation property _FreightOrder is already loaded, the result will contain the FreightOrder entity. If not, an Option with result state empty is returned.

    • setFreightOrder

      public void setFreightOrder(FreightOrder value)
      Overwrites the associated FreightOrder entity for the loaded navigation property _FreightOrder.
      Parameters:
      value - New FreightOrder entity.

    • getFreightOrderStageIfPresent

      @Nonnull public io.vavr.control.Option<List<FreightOrderStage>> getFreightOrderStageIfPresent()
      Retrieval of associated FreightOrderStage entities (one to many). This corresponds to the OData navigation property _FreightOrderStage.

      If the navigation property for an entity FreightOrderStop has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.

      Returns:
      If the information for navigation property _FreightOrderStage is already loaded, the result will contain the FreightOrderStage entities. If not, an Option with result state empty is returned.

    • setFreightOrderStage

      public void setFreightOrderStage(@Nonnull List<FreightOrderStage> value)
      Overwrites the list of associated FreightOrderStage entities for the loaded navigation property _FreightOrderStage.

      If the navigation property _FreightOrderStage of a queried FreightOrderStop is operated lazily, an ODataException can be thrown in case of an OData query error.

      Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.

      Parameters:
      value - List of FreightOrderStage entities.

    • addFreightOrderStage

      public void addFreightOrderStage(FreightOrderStage... entity)
      Adds elements to the list of associated FreightOrderStage entities. This corresponds to the OData navigation property _FreightOrderStage.

      If the navigation property _FreightOrderStage of a queried FreightOrderStop is operated lazily, an ODataException can be thrown in case of an OData query error.

      Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.

      Parameters:
      entity - Array of FreightOrderStage entities.

    • builder

      @Nonnull public static FreightOrderStop.FreightOrderStopBuilder builder()

    • getTransportationOrderStopUUID

      @Nullable public UUID getTransportationOrderStopUUID()
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: TransportationOrderStopUUID

      Returns:
      NodeID

    • getTransportationOrderUUID

      @Nullable public UUID getTransportationOrderUUID()
      Constraints: Not nullable

      Original property name from the Odata EDM: TransportationOrderUUID

      Returns:
      Transportation Order UUID

    • getTransportationOrderStop

      @Nullable public String getTransportationOrderStop()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: TransportationOrderStop

      Returns:
      Stop

    • getTranspOrdStopCategory

      @Nullable public String getTranspOrdStopCategory()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: TranspOrdStopCategory

      Returns:
      Stop Category

    • getTranspOrdStopRole

      @Nullable public String getTranspOrdStopRole()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TranspOrdStopRole

      Returns:
      Role of the Stop

    • getLocationAdditionalUUID

      @Nullable public UUID getLocationAdditionalUUID()
      Constraints: Nullable

      Original property name from the Odata EDM: LocationAdditionalUUID

      Returns:
      Location Additonal UUID (RAW 16)

    • getLocationId

      @Nullable public String getLocationId()
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: LocationId

      Returns:
      Location

    • getLocationUNCode

      @Nullable public String getLocationUNCode()
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: LocationUNCode

      Returns:
      United Nations Code for Trade and Transport Locations

    • getLocationIATACode

      @Nullable public String getLocationIATACode()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: LocationIATACode

      Returns:
      International Air Transport Association: Location

    • getTranspOrdStopPlanTranspDteTme

      @Nullable public OffsetDateTime getTranspOrdStopPlanTranspDteTme()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspOrdStopPlanTranspDteTme

      Returns:
      Created on Timestamp

    • getTranspOrdStopDteTme

      @Nullable public OffsetDateTime getTranspOrdStopDteTme()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspOrdStopDteTme

      Returns:
      Actual Date/Time of Event

    • getTranspOrdStopApptStrtDteTme

      @Nullable public OffsetDateTime getTranspOrdStopApptStrtDteTme()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspOrdStopApptStrtDteTme

      Returns:
      Created on Timestamp

    • getTranspOrdStopApptEndDteTme

      @Nullable public OffsetDateTime getTranspOrdStopApptEndDteTme()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspOrdStopApptEndDteTme

      Returns:
      Created on Timestamp

    • getTranspStopCarrConfStrtDteTme

      @Nullable public OffsetDateTime getTranspStopCarrConfStrtDteTme()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspStopCarrConfStrtDteTme

      Returns:
      Created on Timestamp

    • getTranspStopCarrConfEndDteTme

      @Nullable public OffsetDateTime getTranspStopCarrConfEndDteTme()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspStopCarrConfEndDteTme

      Returns:
      Created on Timestamp

    • getTranspOrdStopSequencePosition

      @Nullable public String getTranspOrdStopSequencePosition()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: TranspOrdStopSequencePosition

      Returns:
      Stop Position in Transportation Stop Sequence

    • getTranspOrdStopHndlgExecStatus

      @Nullable public String getTranspOrdStopHndlgExecStatus()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TranspOrdStopHndlgExecStatus

      Returns:
      Handling Execution Status at Stop Level

    • getTranspOrdStopExecIsBlocked

      @Nullable public Boolean getTranspOrdStopExecIsBlocked()
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspOrdStopExecIsBlocked

      Returns:
      Execution Block

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class VdmObject<FreightOrderStop>

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class VdmEntity<FreightOrderStop>

    • canEqual

      protected boolean canEqual(@Nullable Object other)
      Overrides:
      canEqual in class VdmEntity<FreightOrderStop>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class VdmEntity<FreightOrderStop>

    • getOdataType

      public String getOdataType()
      Specified by:
      getOdataType in class VdmObject<FreightOrderStop>