Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
KWH40
fml40-reference-implementation
Commits
e035e8d3
Commit
e035e8d3
authored
Dec 02, 2020
by
GromeTT
Browse files
ENH: Added documentation for AcceptsFellingJobs
parent
f00141e6
Changes
1
Hide whitespace changes
Inline
Side-by-side
ml/fml40/features/functionalities/accepts_felling_jobs.py
View file @
e035e8d3
"""This module implements the class AcceptsFellingJobs."""
from
ml.ml40.features.functionalities.accepts_jobs
import
AcceptsJobs
from
ml.ml40.features.properties.values.documents.jobs.job_status
import
JobStatus
from
ml.fml40.features.properties.values.documents.jobs.felling_job
import
FellingJob
class
AcceptsFellingJobs
(
AcceptsJobs
):
"""This functionality signalizes that FellingJobs can be processed."""
def
__init__
(
self
,
name
=
""
,
identifier
=
""
):
"""Initializes the object.
:param name: Object name
:param identifier: Identifier
"""
super
().
__init__
(
name
=
name
,
identifier
=
identifier
)
def
acceptJob
(
self
,
job
:
FellingJob
)
->
bool
:
"""Accepts the given FellingJob job.
:param job: FellingJob to be accepted
"""
pass
def
queryJobStatus
(
self
,
identifier
)
->
JobStatus
:
"""Returns the status of the job whose id is identical to identifier.
:param identifier: Identifier of the job to be queried.
:return: Status of the jobs
:rtype: JobStatus
"""
pass
def
removeJob
(
self
,
identifier
)
->
bool
:
pass
""" Removes the job with the id identical to identifier.
:param identifier: Identifier of the job to be deleted
"""
pass
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment