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

Class MaintenanceItemReason

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<MaintenanceItemReason>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.maintenanceplan.MaintenanceItemReason
public class MaintenanceItemReason extends VdmEntity<MaintenanceItemReason>
Maintenance Item Reason

Original entity name from the Odata EDM: MaintenanceItemReasonType

  • Field Details

    • ALL_FIELDS

      public static final MaintenanceItemReasonSelectable ALL_FIELDS
      Selector for all available fields of MaintenanceItemReason.

    • MAINTENANCE_ITEM

      public static final MaintenanceItemReasonField<String> MAINTENANCE_ITEM
      Use with available fluent helpers to apply the MaintenanceItem field to query operations.

    • NMBR_OF_MAINT_COMPLIANCE_ITEMS

      public static final MaintenanceItemReasonField<String> NMBR_OF_MAINT_COMPLIANCE_ITEMS
      Use with available fluent helpers to apply the NmbrOfMaintComplianceItems field to query operations.

    • MAINTENANCE_COMPLIANCE_GROUP_CODE

      public static final MaintenanceItemReasonField<String> MAINTENANCE_COMPLIANCE_GROUP_CODE
      Use with available fluent helpers to apply the MaintenanceComplianceGroupCode field to query operations.

    • MAINTENANCE_COMPLIANCE_CODE

      public static final MaintenanceItemReasonField<String> MAINTENANCE_COMPLIANCE_CODE
      Use with available fluent helpers to apply the MaintenanceComplianceCode field to query operations.

    • MAINTENANCE_COMPLIANCE_TYPE_CODE

      public static final MaintenanceItemReasonField<String> MAINTENANCE_COMPLIANCE_TYPE_CODE
      Use with available fluent helpers to apply the MaintenanceComplianceTypeCode field to query operations.

    • MAINT_COMPLIANCE_CATALOG_CODE

      public static final MaintenanceItemReasonField<String> MAINT_COMPLIANCE_CATALOG_CODE
      Use with available fluent helpers to apply the MaintComplianceCatalogCode field to query operations.

    • MAINT_COMPLIANCE_DESCRIPTION

      public static final MaintenanceItemReasonField<String> MAINT_COMPLIANCE_DESCRIPTION
      Use with available fluent helpers to apply the MaintComplianceDescription field to query operations.

    • MAINTENANCE_PACKAGE

      public static final MaintenanceItemReasonField<String> MAINTENANCE_PACKAGE
      Use with available fluent helpers to apply the MaintenancePackage field to query operations.

    • MAINT_CMPL_RQ_IS_LEGALLY_BINDING

      public static final MaintenanceItemReasonField<String> MAINT_CMPL_RQ_IS_LEGALLY_BINDING
      Use with available fluent helpers to apply the MaintCmplRqIsLegallyBinding field to query operations.

    • MAINT_CMPL_RQ_ORIGIN_CODE

      public static final MaintenanceItemReasonField<String> MAINT_CMPL_RQ_ORIGIN_CODE
      Use with available fluent helpers to apply the MaintCmplRqOriginCode field to query operations.

    • CREATED_BY_USER

      public static final MaintenanceItemReasonField<String> CREATED_BY_USER
      Use with available fluent helpers to apply the CreatedByUser field to query operations.

    • CREATION_DATE

      public static final MaintenanceItemReasonField<LocalDateTime> CREATION_DATE
      Use with available fluent helpers to apply the CreationDate field to query operations.

    • LAST_CHANGED_BY_USER

      public static final MaintenanceItemReasonField<String> LAST_CHANGED_BY_USER
      Use with available fluent helpers to apply the LastChangedByUser field to query operations.

    • LAST_CHANGE_DATE

      public static final MaintenanceItemReasonField<LocalDateTime> LAST_CHANGE_DATE
      Use with available fluent helpers to apply the LastChangeDate field to query operations.

    • LAST_CHANGE_DATE_TIME

      public static final MaintenanceItemReasonField<ZonedDateTime> LAST_CHANGE_DATE_TIME
      Use with available fluent helpers to apply the LastChangeDateTime field to query operations.

    • TO_MAINTENANCE_ITEM

      public static final MaintenanceItemReasonOneToOneLink<MaintenanceItem> TO_MAINTENANCE_ITEM
      Use with available fluent helpers to apply the to_MaintenanceItem navigation property to query operations.

    • TO_MAINTENANCE_ITEM_REASON_TEXT

      public static final MaintenanceItemReasonLink<MaintenanceItemReasonText> TO_MAINTENANCE_ITEM_REASON_TEXT
      Use with available fluent helpers to apply the to_MaintenanceItemReasonText navigation property to query operations.

  • Constructor Details

    • MaintenanceItemReason

      public MaintenanceItemReason()

    • MaintenanceItemReason

      public MaintenanceItemReason(@Nullable String maintenanceItem, @Nullable String nmbrOfMaintComplianceItems, @Nullable String maintenanceComplianceGroupCode, @Nullable String maintenanceComplianceCode, @Nullable String maintenanceComplianceTypeCode, @Nullable String maintComplianceCatalogCode, @Nullable String maintComplianceDescription, @Nullable String maintenancePackage, @Nullable String maintCmplRqIsLegallyBinding, @Nullable String maintCmplRqOriginCode, @Nullable String createdByUser, @Nullable LocalDateTime creationDate, @Nullable String lastChangedByUser, @Nullable LocalDateTime lastChangeDate, @Nullable ZonedDateTime lastChangeDateTime, @Nullable MaintenanceItem toMaintenanceItem, List<MaintenanceItemReasonText> toMaintenanceItemReasonText)

  • Method Details

    • getType

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

    • setMaintenanceItem

      public void setMaintenanceItem(@Nullable String maintenanceItem)
      (Key Field) Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: MaintenanceItem

      Parameters:
      maintenanceItem - Maintenance Item

    • setNmbrOfMaintComplianceItems

      public void setNmbrOfMaintComplianceItems(@Nullable String nmbrOfMaintComplianceItems)
      (Key Field) Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: NmbrOfMaintComplianceItems

      Parameters:
      nmbrOfMaintComplianceItems - Sequential Number for Compliance

    • setMaintenanceComplianceGroupCode

      public void setMaintenanceComplianceGroupCode(@Nullable String maintenanceComplianceGroupCode)
      Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: MaintenanceComplianceGroupCode

      Parameters:
      maintenanceComplianceGroupCode - Compliance Group

    • setMaintenanceComplianceCode

      public void setMaintenanceComplianceCode(@Nullable String maintenanceComplianceCode)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: MaintenanceComplianceCode

      Parameters:
      maintenanceComplianceCode - Compliance Code

    • setMaintenanceComplianceTypeCode

      public void setMaintenanceComplianceTypeCode(@Nullable String maintenanceComplianceTypeCode)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: MaintenanceComplianceTypeCode

      Parameters:
      maintenanceComplianceTypeCode - Compliance Type: 'C'ause or 'R'eason

    • setMaintComplianceCatalogCode

      public void setMaintComplianceCatalogCode(@Nullable String maintComplianceCatalogCode)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: MaintComplianceCatalogCode

      Parameters:
      maintComplianceCatalogCode - Compliance Catalog

    • setMaintComplianceDescription

      public void setMaintComplianceDescription(@Nullable String maintComplianceDescription)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: MaintComplianceDescription

      Parameters:
      maintComplianceDescription - Compliance Description

    • setMaintenancePackage

      public void setMaintenancePackage(@Nullable String maintenancePackage)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: MaintenancePackage

      Parameters:
      maintenancePackage - Maintenance Package Number

    • setMaintCmplRqIsLegallyBinding

      public void setMaintCmplRqIsLegallyBinding(@Nullable String maintCmplRqIsLegallyBinding)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: MaintCmplRqIsLegallyBinding

      Parameters:
      maintCmplRqIsLegallyBinding - Legally Binding Requirement

    • setMaintCmplRqOriginCode

      public void setMaintCmplRqOriginCode(@Nullable String maintCmplRqOriginCode)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: MaintCmplRqOriginCode

      Parameters:
      maintCmplRqOriginCode - Origin of Compliance Requirement

    • 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 Responsible for Creating the Object

    • setCreationDate

      public void setCreationDate(@Nullable LocalDateTime creationDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: CreationDate

      Parameters:
      creationDate - Record Created On

    • 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

    • setLastChangeDate

      public void setLastChangeDate(@Nullable LocalDateTime lastChangeDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: LastChangeDate

      Parameters:
      lastChangeDate - Last Changed On

    • setLastChangeDateTime

      public void setLastChangeDateTime(@Nullable ZonedDateTime lastChangeDateTime)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: LastChangeDateTime

      Parameters:
      lastChangeDateTime - Changed Date and Time

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> MaintenanceItemReasonField<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> MaintenanceItemReasonField<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<MaintenanceItemReason>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchMaintenanceItem

      @Nullable public MaintenanceItem fetchMaintenanceItem()
      Fetches the MaintenanceItem entity (one to one) associated with this entity. This corresponds to the OData navigation property to_MaintenanceItem.

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

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

    • getMaintenanceItemOrFetch

      @Nullable public MaintenanceItem getMaintenanceItemOrFetch()
      Retrieval of associated MaintenanceItem entity (one to one). This corresponds to the OData navigation property to_MaintenanceItem.

      If the navigation property to_MaintenanceItem of a queried MaintenanceItemReason 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 MaintenanceItem 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.

    • getMaintenanceItemIfPresent

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

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

    • setMaintenanceItem

      public void setMaintenanceItem(MaintenanceItem value)
      Overwrites the associated MaintenanceItem entity for the loaded navigation property to_MaintenanceItem.
      Parameters:
      value - New MaintenanceItem entity.

    • fetchMaintenanceItemReasonText

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

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

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

    • getMaintenanceItemReasonTextOrFetch

      @Nonnull public List<MaintenanceItemReasonText> getMaintenanceItemReasonTextOrFetch()
      Retrieval of associated MaintenanceItemReasonText entities (one to many). This corresponds to the OData navigation property to_MaintenanceItemReasonText.

      If the navigation property to_MaintenanceItemReasonText of a queried MaintenanceItemReason 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 MaintenanceItemReasonText 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.

    • getMaintenanceItemReasonTextIfPresent

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

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

    • setMaintenanceItemReasonText

      public void setMaintenanceItemReasonText(@Nonnull List<MaintenanceItemReasonText> value)
      Overwrites the list of associated MaintenanceItemReasonText entities for the loaded navigation property to_MaintenanceItemReasonText.

      If the navigation property to_MaintenanceItemReasonText of a queried MaintenanceItemReason 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 MaintenanceItemReasonText entities.

    • addMaintenanceItemReasonText

      public void addMaintenanceItemReasonText(MaintenanceItemReasonText... entity)
      Adds elements to the list of associated MaintenanceItemReasonText entities. This corresponds to the OData navigation property to_MaintenanceItemReasonText.

      If the navigation property to_MaintenanceItemReasonText of a queried MaintenanceItemReason 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 MaintenanceItemReasonText entities.

    • builder

      @Nonnull public static MaintenanceItemReason.MaintenanceItemReasonBuilder builder()

    • getMaintenanceItem

      @Nullable public String getMaintenanceItem()
      (Key Field) Constraints: Not nullable, Maximum length: 16

      Original property name from the Odata EDM: MaintenanceItem

      Returns:
      Maintenance Item

    • getNmbrOfMaintComplianceItems

      @Nullable public String getNmbrOfMaintComplianceItems()
      (Key Field) Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: NmbrOfMaintComplianceItems

      Returns:
      Sequential Number for Compliance

    • getMaintenanceComplianceGroupCode

      @Nullable public String getMaintenanceComplianceGroupCode()
      Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: MaintenanceComplianceGroupCode

      Returns:
      Compliance Group

    • getMaintenanceComplianceCode

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

      Original property name from the Odata EDM: MaintenanceComplianceCode

      Returns:
      Compliance Code

    • getMaintenanceComplianceTypeCode

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

      Original property name from the Odata EDM: MaintenanceComplianceTypeCode

      Returns:
      Compliance Type: 'C'ause or 'R'eason

    • getMaintComplianceCatalogCode

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

      Original property name from the Odata EDM: MaintComplianceCatalogCode

      Returns:
      Compliance Catalog

    • getMaintComplianceDescription

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

      Original property name from the Odata EDM: MaintComplianceDescription

      Returns:
      Compliance Description

    • getMaintenancePackage

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

      Original property name from the Odata EDM: MaintenancePackage

      Returns:
      Maintenance Package Number

    • getMaintCmplRqIsLegallyBinding

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

      Original property name from the Odata EDM: MaintCmplRqIsLegallyBinding

      Returns:
      Legally Binding Requirement

    • getMaintCmplRqOriginCode

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

      Original property name from the Odata EDM: MaintCmplRqOriginCode

      Returns:
      Origin of Compliance Requirement

    • getCreatedByUser

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

      Original property name from the Odata EDM: CreatedByUser

      Returns:
      Name of Person Responsible for Creating the Object

    • getCreationDate

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

      Original property name from the Odata EDM: CreationDate

      Returns:
      Record Created On

    • 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

    • getLastChangeDate

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

      Original property name from the Odata EDM: LastChangeDate

      Returns:
      Last Changed On

    • getLastChangeDateTime

      @Nullable public ZonedDateTime getLastChangeDateTime()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: LastChangeDateTime

      Returns:
      Changed Date and Time

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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