001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.control.user.printer.server.command;
018
019import com.echothree.control.user.printer.common.edit.PrinterEditFactory;
020import com.echothree.control.user.printer.common.edit.PrinterGroupEdit;
021import com.echothree.control.user.printer.common.form.EditPrinterGroupForm;
022import com.echothree.control.user.printer.common.result.EditPrinterGroupResult;
023import com.echothree.control.user.printer.common.result.PrinterResultFactory;
024import com.echothree.control.user.printer.common.spec.PrinterGroupSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.printer.server.control.PrinterControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.control.uom.common.UomConstants;
030import com.echothree.model.control.uom.server.logic.UnitOfMeasureTypeLogic;
031import com.echothree.model.data.printer.server.entity.PrinterGroup;
032import com.echothree.model.data.printer.server.entity.PrinterGroupDescription;
033import com.echothree.model.data.printer.server.entity.PrinterGroupDetail;
034import com.echothree.model.data.printer.server.value.PrinterGroupDescriptionValue;
035import com.echothree.model.data.printer.server.value.PrinterGroupDetailValue;
036import com.echothree.model.data.user.common.pk.UserVisitPK;
037import com.echothree.util.common.message.ExecutionErrors;
038import com.echothree.util.common.validation.FieldDefinition;
039import com.echothree.util.common.validation.FieldType;
040import com.echothree.util.common.command.EditMode;
041import com.echothree.util.server.control.BaseAbstractEditCommand;
042import com.echothree.util.server.control.CommandSecurityDefinition;
043import com.echothree.util.server.control.PartyTypeDefinition;
044import com.echothree.util.server.control.SecurityRoleDefinition;
045import com.echothree.util.server.persistence.Session;
046import java.util.Arrays;
047import java.util.Collections;
048import java.util.List;
049
050public class EditPrinterGroupCommand
051        extends BaseAbstractEditCommand<PrinterGroupSpec, PrinterGroupEdit, EditPrinterGroupResult, PrinterGroup, PrinterGroup> {
052
053    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
054    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
055    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
056
057    static {
058        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
059                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
060                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
061                        new SecurityRoleDefinition(SecurityRoleGroups.PrinterGroup.name(), SecurityRoles.Edit.name())
062                        )))
063                )));
064
065        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("PrinterGroupName", FieldType.ENTITY_NAME, true, null, null)
067                ));
068
069        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
070                new FieldDefinition("PrinterGroupName", FieldType.ENTITY_NAME, true, null, null),
071                new FieldDefinition("KeepPrintedJobsTime", FieldType.UNSIGNED_LONG, false, null, null),
072                new FieldDefinition("KeepPrintedJobsTimeUnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null),
073                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
074                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
075                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
076                ));
077    }
078
079    /** Creates a new instance of EditPrinterGroupCommand */
080    public EditPrinterGroupCommand(UserVisitPK userVisitPK, EditPrinterGroupForm form) {
081        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
082    }
083
084    @Override
085    public EditPrinterGroupResult getResult() {
086        return PrinterResultFactory.getEditPrinterGroupResult();
087    }
088
089    @Override
090    public PrinterGroupEdit getEdit() {
091        return PrinterEditFactory.getPrinterGroupEdit();
092    }
093
094    @Override
095    public PrinterGroup getEntity(EditPrinterGroupResult result) {
096        var printerControl = Session.getModelController(PrinterControl.class);
097        PrinterGroup printerGroup = null;
098        String printerGroupName = spec.getPrinterGroupName();
099
100        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
101            printerGroup = printerControl.getPrinterGroupByName(printerGroupName);
102        } else { // EditMode.UPDATE
103            printerGroup = printerControl.getPrinterGroupByNameForUpdate(printerGroupName);
104        }
105
106        if(printerGroup != null) {
107            result.setPrinterGroup(printerControl.getPrinterGroupTransfer(getUserVisit(), printerGroup));
108        } else {
109            addExecutionError(ExecutionErrors.UnknownPrinterGroupName.name(), printerGroupName);
110        }
111
112        return printerGroup;
113    }
114
115    @Override
116    public PrinterGroup getLockEntity(PrinterGroup printerGroup) {
117        return printerGroup;
118    }
119
120    @Override
121    public void fillInResult(EditPrinterGroupResult result, PrinterGroup printerGroup) {
122        var printerControl = Session.getModelController(PrinterControl.class);
123
124        result.setPrinterGroup(printerControl.getPrinterGroupTransfer(getUserVisit(), printerGroup));
125    }
126
127    @Override
128    public void doLock(PrinterGroupEdit edit, PrinterGroup printerGroup) {
129        var printerControl = Session.getModelController(PrinterControl.class);
130        UnitOfMeasureTypeLogic unitOfMeasureTypeLogic = UnitOfMeasureTypeLogic.getInstance();
131        PrinterGroupDescription printerGroupDescription = printerControl.getPrinterGroupDescription(printerGroup, getPreferredLanguage());
132        PrinterGroupDetail printerGroupDetail = printerGroup.getLastDetail();
133        UnitOfMeasureTypeLogic.StringUnitOfMeasure stringUnitOfMeasure;
134
135        edit.setPrinterGroupName(printerGroupDetail.getPrinterGroupName());
136        stringUnitOfMeasure = unitOfMeasureTypeLogic.unitOfMeasureToString(this, UomConstants.UnitOfMeasureKindUseType_TIME, printerGroupDetail.getKeepPrintedJobsTime());
137        edit.setKeepPrintedJobsTimeUnitOfMeasureTypeName(stringUnitOfMeasure.getUnitOfMeasureTypeName());
138        edit.setKeepPrintedJobsTime(stringUnitOfMeasure.getValue());
139        edit.setIsDefault(printerGroupDetail.getIsDefault().toString());
140        edit.setSortOrder(printerGroupDetail.getSortOrder().toString());
141
142        if(printerGroupDescription != null) {
143            edit.setDescription(printerGroupDescription.getDescription());
144        }
145    }
146
147    Long keepPrintedJobsTime;
148
149    @Override
150    public void canUpdate(PrinterGroup printerGroup) {
151        var printerControl = Session.getModelController(PrinterControl.class);
152        String printerGroupName = edit.getPrinterGroupName();
153        PrinterGroup duplicatePrinterGroup = printerControl.getPrinterGroupByName(printerGroupName);
154
155        if(duplicatePrinterGroup != null && !printerGroup.equals(duplicatePrinterGroup)) {
156            addExecutionError(ExecutionErrors.DuplicatePrinterGroupName.name(), printerGroupName);
157        } else {
158            UnitOfMeasureTypeLogic unitOfMeasureTypeLogic = UnitOfMeasureTypeLogic.getInstance();
159
160            keepPrintedJobsTime = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_TIME,
161                    edit.getKeepPrintedJobsTime(), edit.getKeepPrintedJobsTimeUnitOfMeasureTypeName(),
162                    null, ExecutionErrors.MissingRequiredKeepPrintedJobsTime.name(), null, ExecutionErrors.MissingRequiredKeepPrintedJobsTimeUnitOfMeasureTypeName.name(),
163                    null, ExecutionErrors.UnknownKeepPrintedJobsTimeUnitOfMeasureTypeName.name());
164        }
165    }
166
167    @Override
168    public void doUpdate(PrinterGroup printerGroup) {
169        var printerControl = Session.getModelController(PrinterControl.class);
170        var partyPK = getPartyPK();
171        PrinterGroupDetailValue printerGroupDetailValue = printerControl.getPrinterGroupDetailValueForUpdate(printerGroup);
172        PrinterGroupDescription printerGroupDescription = printerControl.getPrinterGroupDescriptionForUpdate(printerGroup, getPreferredLanguage());
173        String description = edit.getDescription();
174
175        printerGroupDetailValue.setPrinterGroupName(edit.getPrinterGroupName());
176        printerGroupDetailValue.setKeepPrintedJobsTime(keepPrintedJobsTime);
177        printerGroupDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
178        printerGroupDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
179
180        printerControl.updatePrinterGroupFromValue(printerGroupDetailValue, partyPK);
181
182        if(printerGroupDescription == null && description != null) {
183            printerControl.createPrinterGroupDescription(printerGroup, getPreferredLanguage(), description, partyPK);
184        } else if(printerGroupDescription != null && description == null) {
185            printerControl.deletePrinterGroupDescription(printerGroupDescription, partyPK);
186        } else if(printerGroupDescription != null && description != null) {
187            PrinterGroupDescriptionValue printerGroupDescriptionValue = printerControl.getPrinterGroupDescriptionValue(printerGroupDescription);
188
189            printerGroupDescriptionValue.setDescription(description);
190            printerControl.updatePrinterGroupDescriptionFromValue(printerGroupDescriptionValue, partyPK);
191        }
192    }
193
194}