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.form.GetPrinterStatusChoicesForm;
020import com.echothree.control.user.printer.common.result.GetPrinterStatusChoicesResult;
021import com.echothree.control.user.printer.common.result.PrinterResultFactory;
022import com.echothree.model.control.printer.server.control.PrinterControl;
023import com.echothree.model.data.printer.server.entity.Printer;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.persistence.Session;
031import java.util.Arrays;
032import java.util.Collections;
033import java.util.List;
034
035public class GetPrinterStatusChoicesCommand
036        extends BaseSimpleCommand<GetPrinterStatusChoicesForm> {
037    
038   private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
039
040    static {
041        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
042                new FieldDefinition("PrinterName", FieldType.ENTITY_NAME, true, null, null),
043                new FieldDefinition("DefaultPrinterStatusChoice", FieldType.ENTITY_NAME, false, null, null)
044                ));
045    }
046
047    /** Creates a new instance of GetPrinterStatusChoicesCommand */
048    public GetPrinterStatusChoicesCommand(UserVisitPK userVisitPK, GetPrinterStatusChoicesForm form) {
049        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
050    }
051    
052   @Override
053    protected BaseResult execute() {
054        var printerControl = Session.getModelController(PrinterControl.class);
055        GetPrinterStatusChoicesResult result = PrinterResultFactory.getGetPrinterStatusChoicesResult();
056        String printerName = form.getPrinterName();
057        Printer printer = printerControl.getPrinterByName(printerName);
058        
059        if(printer != null) {
060            String defaultPrinterStatusChoice = form.getDefaultPrinterStatusChoice();
061            
062            result.setPrinterStatusChoices(printerControl.getPrinterStatusChoices(defaultPrinterStatusChoice, getPreferredLanguage(), printer, getPartyPK()));
063        } else {
064            addExecutionError(ExecutionErrors.UnknownPrinterName.name(), printerName);
065        }
066        
067        return result;
068    }
069    
070}