Package com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.functionallocation

Class FunctionalLocationClass

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<FunctionalLocationClass>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.functionallocation.FunctionalLocationClass
public class FunctionalLocationClass extends VdmEntity<FunctionalLocationClass>
Functional Location Class

Original entity name from the Odata EDM: FunctionalLocationClassType

  • Field Details

    • ALL_FIELDS

      public static final FunctionalLocationClassSelectable ALL_FIELDS
      Selector for all available fields of FunctionalLocationClass.

    • FUNCTIONAL_LOCATION

      public static final FunctionalLocationClassField<String> FUNCTIONAL_LOCATION
      Use with available fluent helpers to apply the FunctionalLocation field to query operations.

    • CLASS_INTERNAL_ID

      public static final FunctionalLocationClassField<String> CLASS_INTERNAL_ID
      Use with available fluent helpers to apply the ClassInternalID field to query operations.

    • CLASS_TYPE

      public static final FunctionalLocationClassField<String> CLASS_TYPE
      Use with available fluent helpers to apply the ClassType field to query operations.

    • FUNCTIONAL_LOCATION_LABEL_NAME

      public static final FunctionalLocationClassField<String> FUNCTIONAL_LOCATION_LABEL_NAME
      Use with available fluent helpers to apply the FunctionalLocationLabelName field to query operations.

    • KEY_DATE

      public static final FunctionalLocationClassField<LocalDateTime> KEY_DATE
      Use with available fluent helpers to apply the KeyDate field to query operations.

    • CLASS_PROPERTY

      public static final FunctionalLocationClassField<String> CLASS_PROPERTY
      Use with available fluent helpers to apply the Class field to query operations.

    • CLFN_STATUS

      public static final FunctionalLocationClassField<String> CLFN_STATUS
      Use with available fluent helpers to apply the ClfnStatus field to query operations.

    • CLASS_POSITION_NUMBER

      public static final FunctionalLocationClassField<Short> CLASS_POSITION_NUMBER
      Use with available fluent helpers to apply the ClassPositionNumber field to query operations.

    • CLASS_IS_STANDARD_CLASS

      public static final FunctionalLocationClassField<String> CLASS_IS_STANDARD_CLASS
      Use with available fluent helpers to apply the ClassIsStandardClass field to query operations.

    • CLFN_OBJECT_INTERNAL_ID

      public static final FunctionalLocationClassField<String> CLFN_OBJECT_INTERNAL_ID
      Use with available fluent helpers to apply the ClfnObjectInternalID field to query operations.

    • VALIDITY_END_DATE

      public static final FunctionalLocationClassField<LocalDateTime> VALIDITY_END_DATE
      Use with available fluent helpers to apply the ValidityEndDate field to query operations.

    • TO_CHARACTERISTIC

      public static final FunctionalLocationClassLink<Characteristic> TO_CHARACTERISTIC
      Use with available fluent helpers to apply the to_Characteristic navigation property to query operations.

    • TO_FUNCTIONAL_LOCATION

      public static final FunctionalLocationClassOneToOneLink<FunctionalLocation> TO_FUNCTIONAL_LOCATION
      Use with available fluent helpers to apply the to_FunctionalLocation navigation property to query operations.

  • Constructor Details

    • FunctionalLocationClass

      public FunctionalLocationClass()

    • FunctionalLocationClass

      public FunctionalLocationClass(@Nullable String functionalLocation, @Nullable String classInternalID, @Nullable String classType, @Nullable String functionalLocationLabelName, @Nullable LocalDateTime keyDate, @Nullable String classProperty, @Nullable String clfnStatus, @Nullable Short classPositionNumber, @Nullable String classIsStandardClass, @Nullable String clfnObjectInternalID, @Nullable LocalDateTime validityEndDate, List<Characteristic> toCharacteristic, @Nullable FunctionalLocation toFunctionalLocation)

  • Method Details

    • getType

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

    • setFunctionalLocation

      public void setFunctionalLocation(@Nullable String functionalLocation)
      (Key Field) Constraints: Not nullable, Maximum length: 90

      Original property name from the Odata EDM: FunctionalLocation

      Parameters:
      functionalLocation - Key of Object to be Classified

    • setClassInternalID

      public void setClassInternalID(@Nullable String classInternalID)
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: ClassInternalID

      Parameters:
      classInternalID - Internal Class Number

    • setClassType

      public void setClassType(@Nullable String classType)
      (Key Field) Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: ClassType

      Parameters:
      classType - Class Type

    • setFunctionalLocationLabelName

      public void setFunctionalLocationLabelName(@Nullable String functionalLocationLabelName)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: FunctionalLocationLabelName

      Parameters:
      functionalLocationLabelName - Functional Location Label

    • setKeyDate

      public void setKeyDate(@Nullable LocalDateTime keyDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: KeyDate

      Parameters:
      keyDate - The keyDate to set.

    • setClassProperty

      public void setClassProperty(@Nullable String classProperty)
      Constraints: Not nullable, Maximum length: 18

      Original property name from the Odata EDM: Class

      Parameters:
      classProperty - Class number

    • setClfnStatus

      public void setClfnStatus(@Nullable String clfnStatus)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: ClfnStatus

      Parameters:
      clfnStatus - Classification status

    • setClassPositionNumber

      public void setClassPositionNumber(@Nullable Short classPositionNumber)
      Constraints: none

      Original property name from the Odata EDM: ClassPositionNumber

      Parameters:
      classPositionNumber - Sort Item

    • setClassIsStandardClass

      public void setClassIsStandardClass(@Nullable String classIsStandardClass)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: ClassIsStandardClass

      Parameters:
      classIsStandardClass - Indicator: Standard Class

    • setClfnObjectInternalID

      public void setClfnObjectInternalID(@Nullable String clfnObjectInternalID)
      Constraints: Not nullable, Maximum length: 18

      Original property name from the Odata EDM: ClfnObjectInternalID

      Parameters:
      clfnObjectInternalID - Configuration (Internal Object Number)

    • setValidityEndDate

      public void setValidityEndDate(@Nullable LocalDateTime validityEndDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ValidityEndDate

      Parameters:
      validityEndDate - Valid-to date

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> FunctionalLocationClassField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
      Use with available fluent helpers to apply an extension field to query operations.
      Type Parameters:
      T - The type of the extension field when performing value comparisons.
      Parameters:
      fieldName - The name of the extension field as returned by the OData service.
      fieldType - The Java type to use for the extension field when performing value comparisons.
      Returns:
      A representation of an extension field from this entity.

    • field

      @Nonnull public static <T, DomainT> FunctionalLocationClassField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
      Use with available fluent helpers to apply an extension field to query operations.
      Type Parameters:
      T - The type of the extension field when performing value comparisons.
      DomainT - The type of the extension field as returned by the OData service.
      Parameters:
      typeConverter - A TypeConverter<T, DomainT> instance whose first generic type matches the Java type of the field
      fieldName - The name of the extension field as returned by the OData service.
      Returns:
      A representation of an extension field from this entity, holding a reference to the given TypeConverter.

    • getDestinationForFetch

      @Nullable public HttpDestinationProperties getDestinationForFetch()
      Overrides:
      getDestinationForFetch in class VdmEntity<FunctionalLocationClass>

    • setServicePathForFetch

      protected void setServicePathForFetch(@Nullable String servicePathForFetch)
      Overrides:
      setServicePathForFetch in class VdmEntity<FunctionalLocationClass>

    • attachToService

      public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
      Overrides:
      attachToService in class VdmEntity<FunctionalLocationClass>

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchCharacteristic

      @Nonnull public List<Characteristic> fetchCharacteristic()
      Fetches the Characteristic entities (one to many) associated with this entity. This corresponds to the OData navigation property to_Characteristic.

      Please note: This method will not cache or persist the query results.

      Returns:
      List containing one or more associated Characteristic entities. If no entities are associated then an empty list is returned.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

    • getCharacteristicOrFetch

      @Nonnull public List<Characteristic> getCharacteristicOrFetch()
      Retrieval of associated Characteristic entities (one to many). This corresponds to the OData navigation property to_Characteristic.

      If the navigation property to_Characteristic of a queried FunctionalLocationClass 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.

      Returns:
      List of associated Characteristic entities.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

    • getCharacteristicIfPresent

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

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

    • setCharacteristic

      public void setCharacteristic(@Nonnull List<Characteristic> value)
      Overwrites the list of associated Characteristic entities for the loaded navigation property to_Characteristic.

      If the navigation property to_Characteristic of a queried FunctionalLocationClass 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 Characteristic entities.

    • addCharacteristic

      public void addCharacteristic(Characteristic... entity)
      Adds elements to the list of associated Characteristic entities. This corresponds to the OData navigation property to_Characteristic.

      If the navigation property to_Characteristic of a queried FunctionalLocationClass 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 Characteristic entities.

    • fetchFunctionalLocation

      @Nullable public FunctionalLocation fetchFunctionalLocation()
      Fetches the FunctionalLocation entity (one to one) associated with this entity. This corresponds to the OData navigation property to_FunctionalLocation.

      Please note: This method will not cache or persist the query results.

      Returns:
      The single associated FunctionalLocation entity, or null if an entity is not associated.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

    • getFunctionalLocationOrFetch

      @Nullable public FunctionalLocation getFunctionalLocationOrFetch()
      Retrieval of associated FunctionalLocation entity (one to one). This corresponds to the OData navigation property to_FunctionalLocation.

      If the navigation property to_FunctionalLocation of a queried FunctionalLocationClass 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.

      Returns:
      List of associated FunctionalLocation entity.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

    • getFunctionalLocationIfPresent

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

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

    • setFunctionalLocation

      public void setFunctionalLocation(FunctionalLocation value)
      Overwrites the associated FunctionalLocation entity for the loaded navigation property to_FunctionalLocation.
      Parameters:
      value - New FunctionalLocation entity.

    • builder

      @Nonnull public static FunctionalLocationClass.FunctionalLocationClassBuilder builder()

    • getFunctionalLocation

      @Nullable public String getFunctionalLocation()
      (Key Field) Constraints: Not nullable, Maximum length: 90

      Original property name from the Odata EDM: FunctionalLocation

      Returns:
      Key of Object to be Classified

    • getClassInternalID

      @Nullable public String getClassInternalID()
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: ClassInternalID

      Returns:
      Internal Class Number

    • getClassType

      @Nullable public String getClassType()
      (Key Field) Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: ClassType

      Returns:
      Class Type

    • getFunctionalLocationLabelName

      @Nullable public String getFunctionalLocationLabelName()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: FunctionalLocationLabelName

      Returns:
      Functional Location Label

    • getKeyDate

      @Nullable public LocalDateTime getKeyDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: KeyDate

      Returns:
      The keyDate contained in this entity.

    • getClassProperty

      @Nullable public String getClassProperty()
      Constraints: Not nullable, Maximum length: 18

      Original property name from the Odata EDM: Class

      Returns:
      Class number

    • getClfnStatus

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

      Original property name from the Odata EDM: ClfnStatus

      Returns:
      Classification status

    • getClassPositionNumber

      @Nullable public Short getClassPositionNumber()
      Constraints: none

      Original property name from the Odata EDM: ClassPositionNumber

      Returns:
      Sort Item

    • getClassIsStandardClass

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

      Original property name from the Odata EDM: ClassIsStandardClass

      Returns:
      Indicator: Standard Class

    • getClfnObjectInternalID

      @Nullable public String getClfnObjectInternalID()
      Constraints: Not nullable, Maximum length: 18

      Original property name from the Odata EDM: ClfnObjectInternalID

      Returns:
      Configuration (Internal Object Number)

    • getValidityEndDate

      @Nullable public LocalDateTime getValidityEndDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ValidityEndDate

      Returns:
      Valid-to date

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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