Module control.cust.assessment_record

Expand source code 
from config import Names as N
from control.record import Record
from control.html import HtmlElements as H


class AssessmentR(Record):
    """Logic for assessment records.

    Assessment records that are part of a workflow have customised titles,
    showing the creator and create data of the assessment.

    !!! hint
        If the `assessment` record is not part of the workflow, the behaviour
        of this class falls back to the base class `control.record.Record`.
    """

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

    def title(self, record=None, *args, **kwargs):
        inActualCls = self.inActualCls(record)
        wfitem = self.wfitem
        if not wfitem:
            return super().title(*args, **kwargs)

        markup = kwargs.get("markup", True)
        datetime = self.field(N.dateCreated).wrapBare(markup=markup)
        date = datetime.split(maxsplit=1)[0]
        creator = self.field(N.creator).wrapBare(markup=markup)
        valBare = f"""on {date} by {creator}"""
        return (
            H.span(f"""on {date} by {creator}""", cls=f"small {inActualCls}")
            if markup
            else valBare
        )

    def field(self, fieldName, **kwargs):
        """Customised factory function to wrap a field object around the data
        of a field.

        This function only comes into play when the assigning reviewers.
        Office users assign reviewers by editing the fields `reviewerE` and `reviewerF`.
        But they may only do so if the assessment is submitted and not
        withdrawn and there is not yet a final verdict.

        If those conditions apply, the base version of `field` will be called
        with a `mayEdit=False` parameter.
        """

        if fieldName in {N.reviewerE, N.reviewerF}:
            wfitem = self.wfitem

            if wfitem:
                (stage,) = wfitem.info(N.assessment, N.stage)
                if stage not in {
                    N.submitted,
                    N.submittedRevised,
                    N.reviewRevise,
                }:
                    kwargs[N.mayEdit] = False

        return super().field(fieldName, **kwargs)

Classes

class AssessmentR (*args, **kwargs)

Logic for assessment records.

Assessment records that are part of a workflow have customised titles, showing the creator and create data of the assessment.

Hint

If the assessment record is not part of the workflow, the behaviour of this class falls back to the base class Record.

Initialization

Store the incoming information.

A number of properties will be inherited from the table object that spawns a record object.

Parameters

tableObj : object
See below.
eid, record, withDetails, readonly, bodyMethod
See Table.record()
Expand source code 
class AssessmentR(Record):
    """Logic for assessment records.

    Assessment records that are part of a workflow have customised titles,
    showing the creator and create data of the assessment.

    !!! hint
        If the `assessment` record is not part of the workflow, the behaviour
        of this class falls back to the base class `control.record.Record`.
    """

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

    def title(self, record=None, *args, **kwargs):
        inActualCls = self.inActualCls(record)
        wfitem = self.wfitem
        if not wfitem:
            return super().title(*args, **kwargs)

        markup = kwargs.get("markup", True)
        datetime = self.field(N.dateCreated).wrapBare(markup=markup)
        date = datetime.split(maxsplit=1)[0]
        creator = self.field(N.creator).wrapBare(markup=markup)
        valBare = f"""on {date} by {creator}"""
        return (
            H.span(f"""on {date} by {creator}""", cls=f"small {inActualCls}")
            if markup
            else valBare
        )

    def field(self, fieldName, **kwargs):
        """Customised factory function to wrap a field object around the data
        of a field.

        This function only comes into play when the assigning reviewers.
        Office users assign reviewers by editing the fields `reviewerE` and `reviewerF`.
        But they may only do so if the assessment is submitted and not
        withdrawn and there is not yet a final verdict.

        If those conditions apply, the base version of `field` will be called
        with a `mayEdit=False` parameter.
        """

        if fieldName in {N.reviewerE, N.reviewerF}:
            wfitem = self.wfitem

            if wfitem:
                (stage,) = wfitem.info(N.assessment, N.stage)
                if stage not in {
                    N.submitted,
                    N.submittedRevised,
                    N.reviewRevise,
                }:
                    kwargs[N.mayEdit] = False

        return super().field(fieldName, **kwargs)

Ancestors

Methods

def field(self, fieldName, **kwargs)

Customised factory function to wrap a field object around the data of a field.

This function only comes into play when the assigning reviewers. Office users assign reviewers by editing the fields reviewerE and reviewerF. But they may only do so if the assessment is submitted and not withdrawn and there is not yet a final verdict.

If those conditions apply, the base version of field will be called with a mayEdit=False parameter.

Expand source code 
def field(self, fieldName, **kwargs):
    """Customised factory function to wrap a field object around the data
    of a field.

    This function only comes into play when the assigning reviewers.
    Office users assign reviewers by editing the fields `reviewerE` and `reviewerF`.
    But they may only do so if the assessment is submitted and not
    withdrawn and there is not yet a final verdict.

    If those conditions apply, the base version of `field` will be called
    with a `mayEdit=False` parameter.
    """

    if fieldName in {N.reviewerE, N.reviewerF}:
        wfitem = self.wfitem

        if wfitem:
            (stage,) = wfitem.info(N.assessment, N.stage)
            if stage not in {
                N.submitted,
                N.submittedRevised,
                N.reviewRevise,
            }:
                kwargs[N.mayEdit] = False

    return super().field(fieldName, **kwargs)

Inherited members