Skip to content

erp5
erp5
Commit 90af6d56 authored by Jean-Paul Smets's avatar Jean-Paul Smets
Browse files
Options

Updated variable description for explanation. 

git-svn-id: https://svn.erp5.org/repos/public/erp5/sandbox/amount_generator@36063 20353a03-c40f-0410-a6d1-a30d3c3de9de
parent 264ed6e6
Hide whitespace changes
Inline Side-by-side
Showing with 58 additions and 58 deletions
product/ERP5/interfaces/business_process.py
View file @ 90af6d56
...@@ -75,8 +75,8 @@ class IBusinessPathProcess(Interface): ...@@ -75,8 +75,8 @@ class IBusinessPathProcess(Interface):
"""Returns True if given Business Path document """Returns True if given Business Path document
is completed in the context of provided explanation. is completed in the context of provided explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
business_path -- a Business Path document business_path -- a Business Path document
""" """
...@@ -85,8 +85,8 @@ class IBusinessPathProcess(Interface): ...@@ -85,8 +85,8 @@ class IBusinessPathProcess(Interface):
"""Returns True if given Business Path document """Returns True if given Business Path document
is partially completed in the context of provided explanation. is partially completed in the context of provided explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
business_path -- a Business Path document business_path -- a Business Path document
""" """
...@@ -96,8 +96,8 @@ class IBusinessPathProcess(Interface): ...@@ -96,8 +96,8 @@ class IBusinessPathProcess(Interface):
"""Returns the expected completion date of given Business Path document """Returns the expected completion date of given Business Path document
in the context of provided explanation. in the context of provided explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
business_path -- a Business Path document business_path -- a Business Path document
...@@ -110,8 +110,8 @@ class IBusinessPathProcess(Interface): ...@@ -110,8 +110,8 @@ class IBusinessPathProcess(Interface):
"""Returns the expected start and stop dates of given Business Path """Returns the expected start and stop dates of given Business Path
document in the context of provided explanation. document in the context of provided explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
business_path -- a Business Path document business_path -- a Business Path document
...@@ -132,8 +132,8 @@ class IBuildableBusinessPathProcess(Interface): ...@@ -132,8 +132,8 @@ class IBuildableBusinessPathProcess(Interface):
by taking into account trade state dependencies between by taking into account trade state dependencies between
Business Path. Business Path.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
""" """
def getPartiallyBuildableBusinessPathValueList(explanation): def getPartiallyBuildableBusinessPathValueList(explanation):
...@@ -141,16 +141,16 @@ class IBuildableBusinessPathProcess(Interface): ...@@ -141,16 +141,16 @@ class IBuildableBusinessPathProcess(Interface):
by taking into account trade state dependencies between by taking into account trade state dependencies between
Business Path. Business Path.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
""" """
def isBusinessPathBuildable(explanation, business_path): def isBusinessPathBuildable(explanation, business_path):
"""Returns True if any of the related Simulation Movement """Returns True if any of the related Simulation Movement
is buildable and if the predecessor trade state is completed. is buildable and if the predecessor trade state is completed.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
business_path -- a Business Path document business_path -- a Business Path document
""" """
...@@ -159,8 +159,8 @@ class IBuildableBusinessPathProcess(Interface): ...@@ -159,8 +159,8 @@ class IBuildableBusinessPathProcess(Interface):
"""Returns True if any of the related Simulation Movement """Returns True if any of the related Simulation Movement
is buildable and if the predecessor trade state is partially completed. is buildable and if the predecessor trade state is partially completed.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
business_path -- a Business Path document business_path -- a Business Path document
""" """
...@@ -194,8 +194,8 @@ class ITradeStateProcess(Interface): ...@@ -194,8 +194,8 @@ class ITradeStateProcess(Interface):
by looking at successor and predecessor values of contained by looking at successor and predecessor values of contained
Business Path. Business Path.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
""" """
def isInitialTradeState(trade_state): def isInitialTradeState(trade_state):
...@@ -218,8 +218,8 @@ class ITradeStateProcess(Interface): ...@@ -218,8 +218,8 @@ class ITradeStateProcess(Interface):
at all successor of business path involved in given explanation at all successor of business path involved in given explanation
and which predecessor is the given trade_phase. and which predecessor is the given trade_phase.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
trade_state -- a Trade State category trade_state -- a Trade State category
""" """
...@@ -230,8 +230,8 @@ class ITradeStateProcess(Interface): ...@@ -230,8 +230,8 @@ class ITradeStateProcess(Interface):
at all predecessor of business path involved in given explanation at all predecessor of business path involved in given explanation
and which sucessor is the given trade_phase. and which sucessor is the given trade_phase.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
trade_state -- a Trade State category trade_state -- a Trade State category
""" """
...@@ -240,16 +240,16 @@ class ITradeStateProcess(Interface): ...@@ -240,16 +240,16 @@ class ITradeStateProcess(Interface):
"""Returns the list of Trade States which are completed """Returns the list of Trade States which are completed
in the context of given explanation. in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
""" """
def getPartiallyCompletedTradeStateList(explanation): def getPartiallyCompletedTradeStateList(explanation):
"""Returns the list of Trade States which are partially """Returns the list of Trade States which are partially
completed in the context of given explanation. completed in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
""" """
def getLatestCompletedTradeStateList(explanation): def getLatestCompletedTradeStateList(explanation):
...@@ -257,8 +257,8 @@ class ITradeStateProcess(Interface): ...@@ -257,8 +257,8 @@ class ITradeStateProcess(Interface):
states are completed and for which no successor state states are completed and for which no successor state
is completed in the context of given explanation. is completed in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
""" """
def getLatestPartiallyCompletedTradeStateList(explanation): def getLatestPartiallyCompletedTradeStateList(explanation):
...@@ -266,8 +266,8 @@ class ITradeStateProcess(Interface): ...@@ -266,8 +266,8 @@ class ITradeStateProcess(Interface):
states are completed and for which no successor state states are completed and for which no successor state
is partially completed in the context of given explanation. is partially completed in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
""" """
def isTradeStateCompleted(explanation, trade_state): def isTradeStateCompleted(explanation, trade_state):
...@@ -275,8 +275,8 @@ class ITradeStateProcess(Interface): ...@@ -275,8 +275,8 @@ class ITradeStateProcess(Interface):
completed and if no successor trade state is completed completed and if no successor trade state is completed
in the context of given explanation. in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
trade_state -- a Trade State category trade_state -- a Trade State category
""" """
...@@ -286,8 +286,8 @@ class ITradeStateProcess(Interface): ...@@ -286,8 +286,8 @@ class ITradeStateProcess(Interface):
completed and if no successor trade state is partially completed completed and if no successor trade state is partially completed
in the context of given explanation. in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
trade_state -- a Trade State category trade_state -- a Trade State category
""" """
...@@ -297,8 +297,8 @@ class ITradeStateProcess(Interface): ...@@ -297,8 +297,8 @@ class ITradeStateProcess(Interface):
"""Returns the date at which the give trade state is expected """Returns the date at which the give trade state is expected
to be completed in the context of given explanation. to be completed in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
trade_state -- a Trade State category trade_state -- a Trade State category
...@@ -330,24 +330,24 @@ class ITradePhaseProcess(Interface): ...@@ -330,24 +330,24 @@ class ITradePhaseProcess(Interface):
"""Returns the list of Trade Phases which are completed """Returns the list of Trade Phases which are completed
in the context of given explanation. in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
""" """
def getPartiallyCompletedTradePhaseList(explanation): def getPartiallyCompletedTradePhaseList(explanation):
"""Returns the list of Trade Phases which are partially completed """Returns the list of Trade Phases which are partially completed
in the context of given explanation. in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
""" """
def isTradePhaseCompleted(explanation, trade_phase): def isTradePhaseCompleted(explanation, trade_phase):
"""Returns True all business path with given trade_phase """Returns True all business path with given trade_phase
applicable to given explanation are completed. applicable to given explanation are completed.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
trade_phase -- a Trade Phase category trade_phase -- a Trade Phase category
""" """
...@@ -357,8 +357,8 @@ class ITradePhaseProcess(Interface): ...@@ -357,8 +357,8 @@ class ITradePhaseProcess(Interface):
applicable to given explanation is partially completed applicable to given explanation is partially completed
or completed. or completed.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
trade_phase -- a Trade Phase category trade_phase -- a Trade Phase category
""" """
...@@ -370,8 +370,8 @@ class ITradePhaseProcess(Interface): ...@@ -370,8 +370,8 @@ class ITradePhaseProcess(Interface):
into account the graph of date constraints defined by business path into account the graph of date constraints defined by business path
and business states. and business states.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
trade_phase -- a Trade Phase category trade_phase -- a Trade Phase category
...@@ -406,8 +406,8 @@ class ITradePhaseProcess(Interface): ...@@ -406,8 +406,8 @@ class ITradePhaseProcess(Interface):
trade phases. If no trade_phase is provided, the trade_phase defined trade phases. If no trade_phase is provided, the trade_phase defined
on the Amount is used instead. on the Amount is used instead.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
amount -- Amount (quantity, resource) amount -- Amount (quantity, resource)
...@@ -430,39 +430,39 @@ class IBusinessProcess(IBusinessPathProcess, IBuildableBusinessPathProcess, ...@@ -430,39 +430,39 @@ class IBusinessProcess(IBusinessPathProcess, IBuildableBusinessPathProcess,
"""Returns True is all applicable Trade States and Trade Phases """Returns True is all applicable Trade States and Trade Phases
are completed in the context of given explanation. are completed in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
""" """
def isBuildable(explanation): def isBuildable(explanation):
"""Returns True is one Business Path of this Business Process """Returns True is one Business Path of this Business Process
is buildable in the context of given explanation. is buildable in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
""" """
def isPartiallyBuildable(explanation): def isPartiallyBuildable(explanation):
"""Returns True is one Business Path of this Business Process """Returns True is one Business Path of this Business Process
is partially buildable in the context of given explanation. is partially buildable in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
""" """
def getExpectedCompletionDate(explanation, delay_mode=None): def getExpectedCompletionDate(explanation, delay_mode=None):
"""Returns the expected date at which all applicable Trade States and """Returns the expected date at which all applicable Trade States and
Trade Phases are completed in the context of given explanation. Trade Phases are completed in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
""" """
def build(explanation, include_partially_buildable=False): def build(explanation, include_partially_buildable=False):
"""Build whatever is buildable in the context of given explanation. """Build whatever is buildable in the context of given explanation.
explanation -- an Order, Order Line, Delivery or Delivery Line which explanation -- an Order, Order Line, Delivery or Delivery Line or
implicitely defines a simulation subtree Applied Rule which implicitely defines a simulation subtree
include_partially_buildable -- if set to True, also build partially include_partially_buildable -- if set to True, also build partially
buildable business path. Else buildable business path. Else
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7