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.purchase.server.command;
018
019import com.echothree.control.user.purchase.common.form.SetPurchaseInvoiceStatusForm;
020import com.echothree.model.control.invoice.server.logic.PurchaseInvoiceLogic;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.data.invoice.server.entity.Invoice;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
024import com.echothree.util.common.message.ExecutionErrors;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.validation.FieldType;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import com.echothree.util.server.control.CommandSecurityDefinition;
030import com.echothree.util.server.control.PartyTypeDefinition;
031import java.util.Arrays;
032import java.util.Collections;
033import java.util.List;
034
035public class SetPurchaseInvoiceStatusCommand
036        extends BaseSimpleCommand<SetPurchaseInvoiceStatusForm> {
037    
038    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
043                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
044                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
045                )));
046        
047        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
048            new FieldDefinition("InvoiceName", FieldType.ENTITY_NAME, true, null, null),
049            new FieldDefinition("InvoiceStatusChoice", FieldType.ENTITY_NAME, true, null, null)
050        ));
051    }
052    
053    /** Creates a new instance of SetPurchaseInvoiceStatusCommand */
054    public SetPurchaseInvoiceStatusCommand(UserVisitPK userVisitPK, SetPurchaseInvoiceStatusForm form) {
055        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
056    }
057    
058    @Override
059    protected BaseResult execute() {
060        PurchaseInvoiceLogic purchaseInvoiceLogic = PurchaseInvoiceLogic.getInstance();
061        String invoiceName = form.getInvoiceName();
062        Invoice invoice = purchaseInvoiceLogic.getInvoiceByName(invoiceName);
063        
064        if(invoice != null) {
065            String invoiceStatusChoice = form.getInvoiceStatusChoice();
066            
067            purchaseInvoiceLogic.setPurchaseInvoiceStatus(this, invoice, invoiceStatusChoice, getPartyPK());
068        } else {
069            addExecutionError(ExecutionErrors.UnknownPurchaseInvoiceName.name(), invoiceName);
070        }
071        
072        return null;
073    }
074    
075}