Class AtpFormulaModel

  • All Implemented Interfaces:
    java.io.Serializable

    public class AtpFormulaModel
    extends ItemModel
    Generated model class for type AtpFormula first defined at extension warehousing.

    Represents the attributes of an ATP formula.

    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _BASESTORE2ATPFORMULARELATION
      Generated relation code constant for relation BaseStore2AtpFormulaRelation defining source attribute baseStores in extension warehousing.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String ALLOCATION
      Generated constant - Attribute key of AtpFormula.allocation attribute defined at extension warehousing.
      static java.lang.String AVAILABILITY
      Generated constant - Attribute key of AtpFormula.availability attribute defined at extension warehousing.
      static java.lang.String BASESTORES
      Generated constant - Attribute key of AtpFormula.baseStores attribute defined at extension warehousing.
      static java.lang.String CANCELLATION
      Generated constant - Attribute key of AtpFormula.cancellation attribute defined at extension warehousing.
      static java.lang.String CODE
      Generated constant - Attribute key of AtpFormula.code attribute defined at extension warehousing.
      static java.lang.String EXTERNAL
      Generated constant - Attribute key of AtpFormula.external attribute defined at extension warehousing.
      static java.lang.String FORMULASTRING
      Generated constant - Attribute key of AtpFormula.formulaString attribute defined at extension warehousing.
      static java.lang.String INCREASE
      Generated constant - Attribute key of AtpFormula.increase attribute defined at extension warehousing.
      static java.lang.String RESERVED
      Generated constant - Attribute key of AtpFormula.reserved attribute defined at extension warehousing.
      static java.lang.String RETURNED
      Generated constant - Attribute key of AtpFormula.returned attribute defined at extension warehousing.
      static java.lang.String SHRINKAGE
      Generated constant - Attribute key of AtpFormula.shrinkage attribute defined at extension warehousing.
      static java.lang.String WASTAGE
      Generated constant - Attribute key of AtpFormula.wastage attribute defined at extension warehousing.
    • Constructor Summary

      Constructors 
      Constructor Description
      AtpFormulaModel()
      Generated constructor - Default constructor for generic creation.
      AtpFormulaModel​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      AtpFormulaModel​(java.lang.String _code)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      AtpFormulaModel​(java.lang.String _code, ItemModel _owner)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Boolean getAllocation()
      Generated method - Getter of the AtpFormula.allocation attribute defined at extension warehousing.
      java.lang.Boolean getAvailability()
      Generated method - Getter of the AtpFormula.availability attribute defined at extension warehousing.
      java.util.Set<BaseStoreModel> getBaseStores()
      Generated method - Getter of the AtpFormula.baseStores attribute defined at extension warehousing.
      java.lang.Boolean getCancellation()
      Generated method - Getter of the AtpFormula.cancellation attribute defined at extension warehousing.
      java.lang.String getCode()
      Generated method - Getter of the AtpFormula.code attribute defined at extension warehousing.
      java.lang.Boolean getExternal()
      Generated method - Getter of the AtpFormula.external attribute defined at extension warehousing.
      java.lang.String getFormulaString()
      Generated method - Getter of the AtpFormula.formulaString dynamic attribute defined at extension warehousing.
      java.lang.Boolean getIncrease()
      Generated method - Getter of the AtpFormula.increase attribute defined at extension warehousing.
      java.lang.Boolean getReserved()
      Generated method - Getter of the AtpFormula.reserved attribute defined at extension warehousing.
      java.lang.Boolean getReturned()
      Generated method - Getter of the AtpFormula.returned attribute defined at extension warehousing.
      java.lang.Boolean getShrinkage()
      Generated method - Getter of the AtpFormula.shrinkage attribute defined at extension warehousing.
      java.lang.Boolean getWastage()
      Generated method - Getter of the AtpFormula.wastage attribute defined at extension warehousing.
      void setAllocation​(java.lang.Boolean value)
      Generated method - Setter of AtpFormula.allocation attribute defined at extension warehousing.
      void setAvailability​(java.lang.Boolean value)
      Generated method - Setter of AtpFormula.availability attribute defined at extension warehousing.
      void setBaseStores​(java.util.Set<BaseStoreModel> value)
      Generated method - Setter of AtpFormula.baseStores attribute defined at extension warehousing.
      void setCancellation​(java.lang.Boolean value)
      Generated method - Setter of AtpFormula.cancellation attribute defined at extension warehousing.
      void setCode​(java.lang.String value)
      Generated method - Setter of AtpFormula.code attribute defined at extension warehousing.
      void setExternal​(java.lang.Boolean value)
      Generated method - Setter of AtpFormula.external attribute defined at extension warehousing.
      void setIncrease​(java.lang.Boolean value)
      Generated method - Setter of AtpFormula.increase attribute defined at extension warehousing.
      void setReserved​(java.lang.Boolean value)
      Generated method - Setter of AtpFormula.reserved attribute defined at extension warehousing.
      void setReturned​(java.lang.Boolean value)
      Generated method - Setter of AtpFormula.returned attribute defined at extension warehousing.
      void setShrinkage​(java.lang.Boolean value)
      Generated method - Setter of AtpFormula.shrinkage attribute defined at extension warehousing.
      void setWastage​(java.lang.Boolean value)
      Generated method - Setter of AtpFormula.wastage attribute defined at extension warehousing.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values
      • _BASESTORE2ATPFORMULARELATION

        public static final java.lang.String _BASESTORE2ATPFORMULARELATION
        Generated relation code constant for relation BaseStore2AtpFormulaRelation defining source attribute baseStores in extension warehousing.
        See Also:
        Constant Field Values
      • CODE

        public static final java.lang.String CODE
        Generated constant - Attribute key of AtpFormula.code attribute defined at extension warehousing.
        See Also:
        Constant Field Values
      • AVAILABILITY

        public static final java.lang.String AVAILABILITY
        Generated constant - Attribute key of AtpFormula.availability attribute defined at extension warehousing.
        See Also:
        Constant Field Values
      • ALLOCATION

        public static final java.lang.String ALLOCATION
        Generated constant - Attribute key of AtpFormula.allocation attribute defined at extension warehousing.
        See Also:
        Constant Field Values
      • CANCELLATION

        public static final java.lang.String CANCELLATION
        Generated constant - Attribute key of AtpFormula.cancellation attribute defined at extension warehousing.
        See Also:
        Constant Field Values
      • INCREASE

        public static final java.lang.String INCREASE
        Generated constant - Attribute key of AtpFormula.increase attribute defined at extension warehousing.
        See Also:
        Constant Field Values
      • RESERVED

        public static final java.lang.String RESERVED
        Generated constant - Attribute key of AtpFormula.reserved attribute defined at extension warehousing.
        See Also:
        Constant Field Values
      • SHRINKAGE

        public static final java.lang.String SHRINKAGE
        Generated constant - Attribute key of AtpFormula.shrinkage attribute defined at extension warehousing.
        See Also:
        Constant Field Values
      • WASTAGE

        public static final java.lang.String WASTAGE
        Generated constant - Attribute key of AtpFormula.wastage attribute defined at extension warehousing.
        See Also:
        Constant Field Values
      • RETURNED

        public static final java.lang.String RETURNED
        Generated constant - Attribute key of AtpFormula.returned attribute defined at extension warehousing.
        See Also:
        Constant Field Values
      • EXTERNAL

        public static final java.lang.String EXTERNAL
        Generated constant - Attribute key of AtpFormula.external attribute defined at extension warehousing.
        See Also:
        Constant Field Values
      • FORMULASTRING

        public static final java.lang.String FORMULASTRING
        Generated constant - Attribute key of AtpFormula.formulaString attribute defined at extension warehousing.
        See Also:
        Constant Field Values
      • BASESTORES

        public static final java.lang.String BASESTORES
        Generated constant - Attribute key of AtpFormula.baseStores attribute defined at extension warehousing.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AtpFormulaModel

        public AtpFormulaModel()
        Generated constructor - Default constructor for generic creation.
      • AtpFormulaModel

        public AtpFormulaModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null
      • AtpFormulaModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public AtpFormulaModel​(java.lang.String _code)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _code - initial attribute declared by type AtpFormula at extension warehousing
      • AtpFormulaModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public AtpFormulaModel​(java.lang.String _code,
                               ItemModel _owner)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _code - initial attribute declared by type AtpFormula at extension warehousing
        _owner - initial attribute declared by type Item at extension core
    • Method Detail

      • getAllocation

        @Accessor(qualifier="allocation",
                  type=GETTER)
        public java.lang.Boolean getAllocation()
        Generated method - Getter of the AtpFormula.allocation attribute defined at extension warehousing.
        Returns:
        the allocation - A flag to indicate if allocation events are included in the ATP calculation
      • getAvailability

        @Accessor(qualifier="availability",
                  type=GETTER)
        public java.lang.Boolean getAvailability()
        Generated method - Getter of the AtpFormula.availability attribute defined at extension warehousing.
        Returns:
        the availability - A flag to indicate if availability events are included in the ATP calculation
      • getBaseStores

        @Accessor(qualifier="baseStores",
                  type=GETTER)
        public java.util.Set<BaseStoreModel> getBaseStores()
        Generated method - Getter of the AtpFormula.baseStores attribute defined at extension warehousing. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the baseStores
      • getCancellation

        @Accessor(qualifier="cancellation",
                  type=GETTER)
        public java.lang.Boolean getCancellation()
        Generated method - Getter of the AtpFormula.cancellation attribute defined at extension warehousing.
        Returns:
        the cancellation - A flag to indicate if cancellation events are included in the ATP calculation
      • getCode

        @Accessor(qualifier="code",
                  type=GETTER)
        public java.lang.String getCode()
        Generated method - Getter of the AtpFormula.code attribute defined at extension warehousing.
        Returns:
        the code - A unique name of the formula.
      • getExternal

        @Accessor(qualifier="external",
                  type=GETTER)
        public java.lang.Boolean getExternal()
        Generated method - Getter of the AtpFormula.external attribute defined at extension warehousing.
        Returns:
        the external - A flag indicating that the external availability is included in the ATP calculation
      • getFormulaString

        @Accessor(qualifier="formulaString",
                  type=GETTER)
        public java.lang.String getFormulaString()
        Generated method - Getter of the AtpFormula.formulaString dynamic attribute defined at extension warehousing.
        Returns:
        the formulaString - String representation of the AtpFormula
      • getIncrease

        @Accessor(qualifier="increase",
                  type=GETTER)
        public java.lang.Boolean getIncrease()
        Generated method - Getter of the AtpFormula.increase attribute defined at extension warehousing.
        Returns:
        the increase - A flag to indicate if increase events are included in the ATP calculation
      • getReserved

        @Accessor(qualifier="reserved",
                  type=GETTER)
        public java.lang.Boolean getReserved()
        Generated method - Getter of the AtpFormula.reserved attribute defined at extension warehousing.
        Returns:
        the reserved - A flag to indicate if reserved events are included in the ATP calculation
      • getReturned

        @Accessor(qualifier="returned",
                  type=GETTER)
        public java.lang.Boolean getReturned()
        Generated method - Getter of the AtpFormula.returned attribute defined at extension warehousing.
        Returns:
        the returned - A flag to indicate if returned events are included in the ATP calculation
      • getShrinkage

        @Accessor(qualifier="shrinkage",
                  type=GETTER)
        public java.lang.Boolean getShrinkage()
        Generated method - Getter of the AtpFormula.shrinkage attribute defined at extension warehousing.
        Returns:
        the shrinkage - A flag to indicate if shrinkage events are included in the ATP calculation
      • getWastage

        @Accessor(qualifier="wastage",
                  type=GETTER)
        public java.lang.Boolean getWastage()
        Generated method - Getter of the AtpFormula.wastage attribute defined at extension warehousing.
        Returns:
        the wastage - A flag to indicate if wastage events are included in the ATP calculation
      • setAllocation

        @Accessor(qualifier="allocation",
                  type=SETTER)
        public void setAllocation​(java.lang.Boolean value)
        Generated method - Setter of AtpFormula.allocation attribute defined at extension warehousing.
        Parameters:
        value - the allocation - A flag to indicate if allocation events are included in the ATP calculation
      • setAvailability

        @Accessor(qualifier="availability",
                  type=SETTER)
        public void setAvailability​(java.lang.Boolean value)
        Generated method - Setter of AtpFormula.availability attribute defined at extension warehousing.
        Parameters:
        value - the availability - A flag to indicate if availability events are included in the ATP calculation
      • setBaseStores

        @Accessor(qualifier="baseStores",
                  type=SETTER)
        public void setBaseStores​(java.util.Set<BaseStoreModel> value)
        Generated method - Setter of AtpFormula.baseStores attribute defined at extension warehousing.
        Parameters:
        value - the baseStores
      • setCancellation

        @Accessor(qualifier="cancellation",
                  type=SETTER)
        public void setCancellation​(java.lang.Boolean value)
        Generated method - Setter of AtpFormula.cancellation attribute defined at extension warehousing.
        Parameters:
        value - the cancellation - A flag to indicate if cancellation events are included in the ATP calculation
      • setCode

        @Accessor(qualifier="code",
                  type=SETTER)
        public void setCode​(java.lang.String value)
        Generated method - Setter of AtpFormula.code attribute defined at extension warehousing.
        Parameters:
        value - the code - A unique name of the formula.
      • setExternal

        @Accessor(qualifier="external",
                  type=SETTER)
        public void setExternal​(java.lang.Boolean value)
        Generated method - Setter of AtpFormula.external attribute defined at extension warehousing.
        Parameters:
        value - the external - A flag indicating that the external availability is included in the ATP calculation
      • setIncrease

        @Accessor(qualifier="increase",
                  type=SETTER)
        public void setIncrease​(java.lang.Boolean value)
        Generated method - Setter of AtpFormula.increase attribute defined at extension warehousing.
        Parameters:
        value - the increase - A flag to indicate if increase events are included in the ATP calculation
      • setReserved

        @Accessor(qualifier="reserved",
                  type=SETTER)
        public void setReserved​(java.lang.Boolean value)
        Generated method - Setter of AtpFormula.reserved attribute defined at extension warehousing.
        Parameters:
        value - the reserved - A flag to indicate if reserved events are included in the ATP calculation
      • setReturned

        @Accessor(qualifier="returned",
                  type=SETTER)
        public void setReturned​(java.lang.Boolean value)
        Generated method - Setter of AtpFormula.returned attribute defined at extension warehousing.
        Parameters:
        value - the returned - A flag to indicate if returned events are included in the ATP calculation
      • setShrinkage

        @Accessor(qualifier="shrinkage",
                  type=SETTER)
        public void setShrinkage​(java.lang.Boolean value)
        Generated method - Setter of AtpFormula.shrinkage attribute defined at extension warehousing.
        Parameters:
        value - the shrinkage - A flag to indicate if shrinkage events are included in the ATP calculation
      • setWastage

        @Accessor(qualifier="wastage",
                  type=SETTER)
        public void setWastage​(java.lang.Boolean value)
        Generated method - Setter of AtpFormula.wastage attribute defined at extension warehousing.
        Parameters:
        value - the wastage - A flag to indicate if wastage events are included in the ATP calculation