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.GetPrinterGroupJobStatusChoicesForm;
020import com.echothree.control.user.printer.common.result.GetPrinterGroupJobStatusChoicesResult;
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.PrinterGroupJob;
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 GetPrinterGroupJobStatusChoicesCommand
036        extends BaseSimpleCommand<GetPrinterGroupJobStatusChoicesForm> {
037    
038   private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
039
040    static {
041        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
042                new FieldDefinition("PrinterGroupJobName", FieldType.ENTITY_NAME, true, null, null),
043                new FieldDefinition("DefaultPrinterGroupJobStatusChoice", FieldType.ENTITY_NAME, false, null, null)
044                ));
045    }
046
047    /** Creates a new instance of GetPrinterGroupJobStatusChoicesCommand */
048    public GetPrinterGroupJobStatusChoicesCommand(UserVisitPK userVisitPK, GetPrinterGroupJobStatusChoicesForm 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        GetPrinterGroupJobStatusChoicesResult result = PrinterResultFactory.getGetPrinterGroupJobStatusChoicesResult();
056        String printerGroupJobName = form.getPrinterGroupJobName();
057        PrinterGroupJob printerGroupJob = printerControl.getPrinterGroupJobByName(printerGroupJobName);
058        
059        if(printerGroupJob != null) {
060            String defaultPrinterGroupJobStatusChoice = form.getDefaultPrinterGroupJobStatusChoice();
061            
062            result.setPrinterGroupJobStatusChoices(printerControl.getPrinterGroupJobStatusChoices(defaultPrinterGroupJobStatusChoice,
063                    getPreferredLanguage(), printerGroupJob, getPartyPK()));
064        } else {
065            addExecutionError(ExecutionErrors.UnknownPrinterGroupJobName.name(), printerGroupJobName);
066        }
067        
068        return result;
069    }
070    
071}