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

Class Characteristic

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

Original entity name from the Odata EDM: CharacteristicType

  • Field Details

    • ALL_FIELDS

      public static final CharacteristicSelectable ALL_FIELDS
      Selector for all available fields of Characteristic.

    • FUNCTIONAL_LOCATION

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

    • CLASS_INTERNAL_ID

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

    • CHARC_INTERNAL_ID

      public static final CharacteristicField<String> CHARC_INTERNAL_ID
      Use with available fluent helpers to apply the CharcInternalID field to query operations.

    • FUNCTIONAL_LOCATION_LABEL_NAME

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

    • CHARACTERISTIC

      public static final CharacteristicField<String> CHARACTERISTIC
      Use with available fluent helpers to apply the Characteristic field to query operations.

    • CHARC_DATA_TYPE

      public static final CharacteristicField<String> CHARC_DATA_TYPE
      Use with available fluent helpers to apply the CharcDataType field to query operations.

    • KEY_DATE

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

    • CHANGE_NUMBER

      public static final CharacteristicField<String> CHANGE_NUMBER
      Use with available fluent helpers to apply the ChangeNumber field to query operations.

    • CLASS_TYPE

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

    • CLASS_MAINT_AUTH_GRP

      public static final CharacteristicField<String> CLASS_MAINT_AUTH_GRP
      Use with available fluent helpers to apply the ClassMaintAuthGrp field to query operations.

    • CLASS_CLASSFCTN_AUTH_GRP

      public static final CharacteristicField<String> CLASS_CLASSFCTN_AUTH_GRP
      Use with available fluent helpers to apply the ClassClassfctnAuthGrp field to query operations.

    • CLASS_PROPERTY

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

    • TO_CLASS

      public static final CharacteristicOneToOneLink<FunctionalLocationClass> TO_CLASS
      Use with available fluent helpers to apply the to_Class navigation property to query operations.

    • TO_FUNCTIONAL_LOCATION

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

    • TO_VALUE

      public static final CharacteristicLink<Value> TO_VALUE
      Use with available fluent helpers to apply the to_Value navigation property to query operations.

  • Constructor Details

  • Method Details

    • getType

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

    • 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

    • setCharcInternalID

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

      Original property name from the Odata EDM: CharcInternalID

      Parameters:
      charcInternalID - Characteristic Internal ID

    • 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

    • setCharacteristic

      public void setCharacteristic(@Nullable String characteristic)
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: Characteristic

      Parameters:
      characteristic - Characteristic Name

    • setCharcDataType

      public void setCharcDataType(@Nullable String charcDataType)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: CharcDataType

      Parameters:
      charcDataType - Data type of characteristic

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

    • setChangeNumber

      public void setChangeNumber(@Nullable String changeNumber)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: ChangeNumber

      Parameters:
      changeNumber - Change Number

    • setClassType

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

      Original property name from the Odata EDM: ClassType

      Parameters:
      classType - Class Type

    • setClassMaintAuthGrp

      public void setClassMaintAuthGrp(@Nullable String classMaintAuthGrp)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: ClassMaintAuthGrp

      Parameters:
      classMaintAuthGrp - Class Maintenance Authorization Group

    • setClassClassfctnAuthGrp

      public void setClassClassfctnAuthGrp(@Nullable String classClassfctnAuthGrp)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: ClassClassfctnAuthGrp

      Parameters:
      classClassfctnAuthGrp - Classification Authorization Group

    • 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

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> CharacteristicField<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> CharacteristicField<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<Characteristic>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchClassObjects

      @Nullable public FunctionalLocationClass fetchClassObjects()
      Fetches the FunctionalLocationClass entity (one to one) associated with this entity. This corresponds to the OData navigation property to_Class.

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

      Returns:
      The single associated FunctionalLocationClass 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.

    • getClassObjectsOrFetch

      @Nullable public FunctionalLocationClass getClassObjectsOrFetch()
      Retrieval of associated FunctionalLocationClass entity (one to one). This corresponds to the OData navigation property to_Class.

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

    • getClassObjectsIfPresent

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

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

    • setClassObjects

      public void setClassObjects(FunctionalLocationClass value)
      Overwrites the associated FunctionalLocationClass entity for the loaded navigation property to_Class.
      Parameters:
      value - New FunctionalLocationClass entity.

    • 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 Characteristic 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 Characteristic 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.

    • fetchValue

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

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

      Returns:
      List containing one or more associated Value 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.

    • getValueOrFetch

      @Nonnull public List<Value> getValueOrFetch()
      Retrieval of associated Value entities (one to many). This corresponds to the OData navigation property to_Value.

      If the navigation property to_Value of a queried Characteristic 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 Value 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.

    • getValueIfPresent

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

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

    • setValue

      public void setValue(@Nonnull List<Value> value)
      Overwrites the list of associated Value entities for the loaded navigation property to_Value.

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

    • addValue

      public void addValue(Value... entity)
      Adds elements to the list of associated Value entities. This corresponds to the OData navigation property to_Value.

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

    • builder

      @Nonnull public static Characteristic.CharacteristicBuilder 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

    • getCharcInternalID

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

      Original property name from the Odata EDM: CharcInternalID

      Returns:
      Characteristic Internal ID

    • getFunctionalLocationLabelName

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

      Original property name from the Odata EDM: FunctionalLocationLabelName

      Returns:
      Functional Location Label

    • getCharacteristic

      @Nullable public String getCharacteristic()
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: Characteristic

      Returns:
      Characteristic Name

    • getCharcDataType

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

      Original property name from the Odata EDM: CharcDataType

      Returns:
      Data type of characteristic

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

    • getChangeNumber

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

      Original property name from the Odata EDM: ChangeNumber

      Returns:
      Change Number

    • getClassType

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

      Original property name from the Odata EDM: ClassType

      Returns:
      Class Type

    • getClassMaintAuthGrp

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

      Original property name from the Odata EDM: ClassMaintAuthGrp

      Returns:
      Class Maintenance Authorization Group

    • getClassClassfctnAuthGrp

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

      Original property name from the Odata EDM: ClassClassfctnAuthGrp

      Returns:
      Classification Authorization Group

    • getClassProperty

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

      Original property name from the Odata EDM: Class

      Returns:
      Class number

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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