adding initial set of services, identified in the project DigiKomForst

ml/fml40/features/functionalities/accepts_activity_report.py

+"""This module implements the class AcceptsActivityReport."""
+
+from ml.ml40.features.functionalities.functionality import Functionality
+
+
+class AcceptsActivityReport(Functionality):
+    """This functionality allows to save and maintain activity reports"""
+
+    def __init__(self, namespace="fml40", name="", identifier="", parent=None):
+        """Initializes the object.
+
+        :param name:  Object name
+        :param identifier: Identifier
+
+        """
+        super().__init__(
+            namespace=namespace, name=name, identifier=identifier, parent=parent
+        )
+
+    def acceptActivityReport(self, activityReport: dict) -> bool:
+        """ Accepts and maintains an activity report. Returns True if the activity report has been accepted, False if not.
+
+        :param: activityReport: dict
+            - filename: String - filename of the actual activity report file
+            - data: String - base64 encoded data of the activity report
+        :rtype: bool
+        """
+        pass
\ No newline at end of file

ml/fml40/features/functionalities/accepts_invoice.py

+"""This module implements the class AcceptsInvoice."""
+
+from ml.ml40.features.functionalities.functionality import Functionality
+
+
+class AcceptsInvoice(Functionality):
+    """This functionality allows to save and maintain invoices"""
+
+    def __init__(self, namespace="fml40", name="", identifier="", parent=None):
+        """Initializes the object.
+
+        :param name:  Object name
+        :param identifier: Identifier
+
+        """
+        super().__init__(
+            namespace=namespace, name=name, identifier=identifier, parent=parent
+        )
+
+    def acceptInvoice(self, invoice: dict) -> bool:
+        """ Accepts and maintains an invoice. Returns True if the invoice has been accepted, False if not.
+
+        :param: invoice: dict
+            - filename: String - filename of the actual invoice file
+            - data: String - base64 encoded data of the invoice
+        :rtype: bool
+        """
+        pass
\ No newline at end of file

ml/fml40/features/functionalities/accepts_timber_stock.py

+"""This module implements the class AcceptsTimberStock."""
+
+from ml.ml40.features.functionalities.functionality import Functionality
+
+
+class AcceptsTimberStock(Functionality):
+    """This functionality allows to save and maintain timber stock information in form of a timer list"""
+
+    def __init__(self, namespace="fml40", name="", identifier="", parent=None):
+        """Initializes the object.
+
+        :param name:  Object name
+        :param identifier: Identifier
+
+        """
+        super().__init__(
+            namespace=namespace, name=name, identifier=identifier, parent=parent
+        )
+
+    def acceptTimberStock(self, timberList: dict) -> bool:
+        """ Accepts and maintains a timber list. Returns True if the timber list has been accepted, False if not.
+
+        :param: timberList: dict
+        :rtype: bool
+        """
+        pass
\ No newline at end of file

ml/fml40/features/functionalities/evaluates_funding_proposal.py

+"""This module implements the class EvaluatesFundingProposal."""
+
+from ml.ml40.features.functionalities.functionality import Functionality
+
+
+class EvaluatesFundingProposal(Functionality):
+    """This functionality evaluates funding proposals and returns a funding proposal report"""
+
+    def __init__(self, namespace="fml40", name="", identifier="", parent=None):
+        """Initializes the object.
+
+        :param name:  Object name
+        :param identifier: Identifier
+
+        """
+        super().__init__(
+            namespace=namespace, name=name, identifier=identifier, parent=parent
+        )
+
+    def evaluateFundingProposal(self, fundingProposal: dict) -> dict:
+        """ Evaluates the incoming funding proposal, consisting of an actual activity report and an invoice.
+         Returning a FundingReport.
+
+        :param: fundingProposal: dict
+        Invoice
+            - filename: String - filename of the actual invoice file
+            - data: String - base64 encoded data of the invoice
+        Activity Report
+            - filename: String - filename of the actual invoice file
+            - data: String - base64 encoded data of the invoice
+        :rtype: bool
+        """
+        pass
\ No newline at end of file

ml/fml40/features/functionalities/generates_timber_sales_offer.py

+"""This module implements the class GeneratesTimberSalesOffer."""
+
+from ml.ml40.features.functionalities.functionality import Functionality
+
+
+class GeneratesTimberSalesOffer(Functionality):
+    """This functionality allows to generate timber-sales-offers
+    """
+
+    def __init__(self, namespace="fml40", name="", identifier="", parent=None):
+        """Initializes the object.
+
+        :param name: Object name
+        :param identifier: Identifier
+
+        """
+        super().__init__(
+            namespace=namespace, name=name, identifier=identifier, parent=parent
+        )
+
+    def generateTimberSalesOffers(self, timberList: dict) -> bool:
+        """Generates a Timber sales offer based on a timber list. Returns True, if the offer is online, False if there
+        has been an error in the generation process.
+
+        :param: timberList: timber list with additional cost information
+        :rtype: bool
+        """
+        pass

ml/fml40/features/functionalities/provides_selling_proposal.py

+"""This module implements the class ProvidesSellingProposal."""
+
+from ml.ml40.features.functionalities.functionality import Functionality
+
+
+class ProvidesSellingProposal(Functionality):
+    """This functionality accumulates information through other services and provides Selling Proposals for a timer list
+    """
+
+    def __init__(self, namespace="fml40", name="", identifier="", parent=None):
+        """Initializes the object.
+
+        :param name: Object name
+        :param identifier: Identifier
+
+        """
+        super().__init__(
+            namespace=namespace, name=name, identifier=identifier, parent=parent
+        )
+
+    def getSellingProposal(self, timberList: dict) -> dict:
+        """Gets different selling data and accumulates them in a selling proposal for a given timber list.
+
+        :param: timberList: timber list with additional cost information
+        :rtype: dict
+        -Offers
+        -Requests
+        -Prices
+        """
+        pass

ml/fml40/features/functionalities/provides_timber_offfers.py

+"""This module implements the class ProvidesTimberOffers."""
+
+from ml.ml40.features.functionalities.functionality import Functionality
+
+
+class ProvidesTimberOffers(Functionality):
+    """This functionality provides timber offers from a marketplace, with respect to given search criteria
+    """
+
+    def __init__(self, namespace="fml40", name="", identifier="", parent=None):
+        """Initializes the object.
+
+        :param name: Object name
+        :param identifier: Identifier
+
+        """
+        super().__init__(
+            namespace=namespace, name=name, identifier=identifier, parent=parent
+        )
+
+    def getTimberOffers(self, timberList: dict) -> dict:
+        """Gets different timber offers [1, .., max.5]
+
+        :param: timberList: timber list with additional cost information
+        :rtype: dict
+        -Offers
+        """
+        pass

ml/fml40/features/functionalities/provides_timber_requests.py

+"""This module implements the class ProvidesTimberRequests."""
+
+from ml.ml40.features.functionalities.functionality import Functionality
+
+
+class ProvidesTimberRequests(Functionality):
+    """This functionality provides timber requests from a marketplace, with respect to given search criteria
+    """
+
+    def __init__(self, namespace="fml40", name="", identifier="", parent=None):
+        """Initializes the object.
+
+        :param name: Object name
+        :param identifier: Identifier
+
+        """
+        super().__init__(
+            namespace=namespace, name=name, identifier=identifier, parent=parent
+        )
+
+    def getTimberRequests(self, timberList: dict) -> dict:
+        """Gets different timber requests [1, .., max.5]
+
+        :param: timberList: timber list with additional cost information
+        :rtype: dict
+        -Requests
+        """
+        pass

ml/fml40/features/functionalities/provides_timber_selling_price.py

+"""This module implements the class ProvidesTimberSellingPrices."""
+
+from ml.ml40.features.functionalities.functionality import Functionality
+
+
+class ProvidesTimberSellingPrices(Functionality):
+    """This functionality provides timber selling prices from a marketplace, with respect to given search criteria
+    """
+
+    def __init__(self, namespace="fml40", name="", identifier="", parent=None):
+        """Initializes the object.
+
+        :param name: Object name
+        :param identifier: Identifier
+
+        """
+        super().__init__(
+            namespace=namespace, name=name, identifier=identifier, parent=parent
+        )
+
+    def getTimberSellingPrices(self, timberList: dict) -> dict:
+        """Gets different timber selling prices [1, .., max.5]
+
+        :param: timberList: timber list with additional cost information
+        :rtype: dict
+        -Selling Prices
+        """
+        pass