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

Class Location

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<Location>
com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.location.Location
All Implemented Interfaces:
VdmEntitySet
public class Location extends VdmEntity<Location> implements VdmEntitySet
Manage Location

Original entity name from the Odata EDM: Location_Type

  • Field Details

  • Constructor Details

  • Method Details

    • getType

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

    • setLocationUUID

      public void setLocationUUID(@Nullable UUID locationUUID)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: LocationUUID

      Parameters:
      locationUUID - Internal Location Number (Customer, Supplier, or Plant)

    • setLocation

      public void setLocation(@Nullable String location)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: Location

      Parameters:
      location - Location

    • setLocationType

      public void setLocationType(@Nullable String locationType)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: LocationType

      Parameters:
      locationType - Location Type

    • setLocationAdditionalUUID

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

      Original property name from the Odata EDM: LocationAdditionalUUID

      Parameters:
      locationAdditionalUUID - Location UUID

    • setLocationTimeZone

      public void setLocationTimeZone(@Nullable String locationTimeZone)
      Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: LocationTimeZone

      Parameters:
      locationTimeZone - Time Zone

    • setGlobalLocationNumber

      public void setGlobalLocationNumber(@Nullable String globalLocationNumber)
      Constraints: Not nullable, Maximum length: 13

      Original property name from the Odata EDM: GlobalLocationNumber

      Parameters:
      globalLocationNumber - Global Location Number

    • setLocationDUNSNumber

      public void setLocationDUNSNumber(@Nullable String locationDUNSNumber)
      Constraints: Not nullable, Maximum length: 13

      Original property name from the Odata EDM: LocationDUNSNumber

      Parameters:
      locationDUNSNumber - DUNS+4 Number

    • 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 Identifier

    • setGeoCoordinatesLongitudeValue

      public void setGeoCoordinatesLongitudeValue(@Nullable Double geoCoordinatesLongitudeValue)
      Constraints: Not nullable

      Original property name from the Odata EDM: GeoCoordinatesLongitudeValue

      Parameters:
      geoCoordinatesLongitudeValue - Longitude Specified in GPS Coordinates

    • setGeoCoordinatesLatitudeValue

      public void setGeoCoordinatesLatitudeValue(@Nullable Double geoCoordinatesLatitudeValue)
      Constraints: Not nullable

      Original property name from the Odata EDM: GeoCoordinatesLatitudeValue

      Parameters:
      geoCoordinatesLatitudeValue - Latitude Specified in GPS Coordinates

    • setGeoCoordsValidityEndDateTime

      public void setGeoCoordsValidityEndDateTime(@Nullable OffsetDateTime geoCoordsValidityEndDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: GeoCoordsValidityEndDateTime

      Parameters:
      geoCoordsValidityEndDateTime - UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

    • setGeoCoordsAreManuallyChanged

      public void setGeoCoordsAreManuallyChanged(@Nullable Boolean geoCoordsAreManuallyChanged)
      Constraints: Not nullable

      Original property name from the Odata EDM: GeoCoordsAreManuallyChanged

      Parameters:
      geoCoordsAreManuallyChanged - Manually Changed Geocoordinates

    • setCreationDateTime

      public void setCreationDateTime(@Nullable OffsetDateTime creationDateTime)
      Constraints: Nullable, Precision: 7

      Original property name from the Odata EDM: CreationDateTime

      Parameters:
      creationDateTime - UTC time stamp in long form (YYYYMMDDhhmmss,mmmuuun)

    • setCreatedByUser

      public void setCreatedByUser(@Nullable String createdByUser)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: CreatedByUser

      Parameters:
      createdByUser - Name of Person Who Created the Object

    • setChangedDateTime

      public void setChangedDateTime(@Nullable OffsetDateTime changedDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: ChangedDateTime

      Parameters:
      changedDateTime - UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

    • setLocalLastChangeDateTime

      public void setLocalLastChangeDateTime(@Nullable OffsetDateTime localLastChangeDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: LocalLastChangeDateTime

      Parameters:
      localLastChangeDateTime - UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

    • setLastChangedByUser

      public void setLastChangedByUser(@Nullable String lastChangedByUser)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: LastChangedByUser

      Parameters:
      lastChangedByUser - Name of Person Who Changed Object

    • setLocationIsTemporary

      public void setLocationIsTemporary(@Nullable Boolean locationIsTemporary)
      Constraints: Not nullable

      Original property name from the Odata EDM: LocationIsTemporary

      Parameters:
      locationIsTemporary - Temporary Location

    • setIsBusinessPurposeCompleted

      public void setIsBusinessPurposeCompleted(@Nullable String isBusinessPurposeCompleted)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: IsBusinessPurposeCompleted

      Parameters:
      isBusinessPurposeCompleted - Business Purpose Completed Flag

    • setAddressID

      public void setAddressID(@Nullable String addressID)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: AddressID

      Parameters:
      addressID - Address Number

    • set_Messages

      public void set_Messages(@Nullable Collection<SAP__Message> _Messages)
      Constraints: Not nullable

      Original property name from the Odata EDM: SAP__Messages

      Parameters:
      _Messages - The _Messages to set.

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • getLocationAddressTPIfPresent

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

      If the navigation property for an entity Location 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 _LocationAddressTP is already loaded, the result will contain the LocationAddress entity. If not, an Option with result state empty is returned.

    • setLocationAddressTP

      public void setLocationAddressTP(LocationAddress value)
      Overwrites the associated LocationAddress entity for the loaded navigation property _LocationAddressTP.
      Parameters:
      value - New LocationAddress entity.

    • getLocationTextTPIfPresent

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

      If the navigation property for an entity Location 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 _LocationTextTP is already loaded, the result will contain the LocationText entities. If not, an Option with result state empty is returned.

    • setLocationTextTP

      public void setLocationTextTP(@Nonnull List<LocationText> value)
      Overwrites the list of associated LocationText entities for the loaded navigation property _LocationTextTP.

      If the navigation property _LocationTextTP of a queried Location 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 LocationText entities.

    • addLocationTextTP

      public void addLocationTextTP(LocationText... entity)
      Adds elements to the list of associated LocationText entities. This corresponds to the OData navigation property _LocationTextTP.

      If the navigation property _LocationTextTP of a queried Location 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 LocationText entities.

    • glMnlGeoCoordinatesMaint

      @Nonnull public static BoundAction.SingleToSingle<Location,Location> glMnlGeoCoordinatesMaint()
      Action that can be applied to any entity object of this class.

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

      To execute it use the service.forEntity(entity).applyAction(thisAction) API.

    • builder

      @Nonnull public static Location.LocationBuilder builder()

    • getLocationUUID

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

      Original property name from the Odata EDM: LocationUUID

      Returns:
      Internal Location Number (Customer, Supplier, or Plant)

    • getLocation

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

      Original property name from the Odata EDM: Location

      Returns:
      Location

    • getLocationType

      @Nullable public String getLocationType()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: LocationType

      Returns:
      Location Type

    • getLocationAdditionalUUID

      @Nullable public UUID getLocationAdditionalUUID()
      Constraints: Nullable

      Original property name from the Odata EDM: LocationAdditionalUUID

      Returns:
      Location UUID

    • getLocationTimeZone

      @Nullable public String getLocationTimeZone()
      Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: LocationTimeZone

      Returns:
      Time Zone

    • getGlobalLocationNumber

      @Nullable public String getGlobalLocationNumber()
      Constraints: Not nullable, Maximum length: 13

      Original property name from the Odata EDM: GlobalLocationNumber

      Returns:
      Global Location Number

    • getLocationDUNSNumber

      @Nullable public String getLocationDUNSNumber()
      Constraints: Not nullable, Maximum length: 13

      Original property name from the Odata EDM: LocationDUNSNumber

      Returns:
      DUNS+4 Number

    • 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 Identifier

    • getGeoCoordinatesLongitudeValue

      @Nullable public Double getGeoCoordinatesLongitudeValue()
      Constraints: Not nullable

      Original property name from the Odata EDM: GeoCoordinatesLongitudeValue

      Returns:
      Longitude Specified in GPS Coordinates

    • getGeoCoordinatesLatitudeValue

      @Nullable public Double getGeoCoordinatesLatitudeValue()
      Constraints: Not nullable

      Original property name from the Odata EDM: GeoCoordinatesLatitudeValue

      Returns:
      Latitude Specified in GPS Coordinates

    • getGeoCoordsValidityEndDateTime

      @Nullable public OffsetDateTime getGeoCoordsValidityEndDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: GeoCoordsValidityEndDateTime

      Returns:
      UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

    • getGeoCoordsAreManuallyChanged

      @Nullable public Boolean getGeoCoordsAreManuallyChanged()
      Constraints: Not nullable

      Original property name from the Odata EDM: GeoCoordsAreManuallyChanged

      Returns:
      Manually Changed Geocoordinates

    • getCreationDateTime

      @Nullable public OffsetDateTime getCreationDateTime()
      Constraints: Nullable, Precision: 7

      Original property name from the Odata EDM: CreationDateTime

      Returns:
      UTC time stamp in long form (YYYYMMDDhhmmss,mmmuuun)

    • getCreatedByUser

      @Nullable public String getCreatedByUser()
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: CreatedByUser

      Returns:
      Name of Person Who Created the Object

    • getChangedDateTime

      @Nullable public OffsetDateTime getChangedDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: ChangedDateTime

      Returns:
      UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

    • getLocalLastChangeDateTime

      @Nullable public OffsetDateTime getLocalLastChangeDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: LocalLastChangeDateTime

      Returns:
      UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

    • getLastChangedByUser

      @Nullable public String getLastChangedByUser()
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: LastChangedByUser

      Returns:
      Name of Person Who Changed Object

    • getLocationIsTemporary

      @Nullable public Boolean getLocationIsTemporary()
      Constraints: Not nullable

      Original property name from the Odata EDM: LocationIsTemporary

      Returns:
      Temporary Location

    • getIsBusinessPurposeCompleted

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

      Original property name from the Odata EDM: IsBusinessPurposeCompleted

      Returns:
      Business Purpose Completed Flag

    • getAddressID

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

      Original property name from the Odata EDM: AddressID

      Returns:
      Address Number

    • get_Messages

      @Nullable public Collection<SAP__Message> get_Messages()
      Constraints: Not nullable

      Original property name from the Odata EDM: SAP__Messages

      Returns:
      The _Messages contained in this VdmEntity.

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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

    • getOdataType

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