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.GetPurchaseInvoiceStatusChoicesForm;
020import com.echothree.control.user.purchase.common.result.GetPurchaseInvoiceStatusChoicesResult;
021import com.echothree.control.user.purchase.common.result.PurchaseResultFactory;
022import com.echothree.model.control.invoice.server.logic.PurchaseInvoiceLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.invoice.server.entity.Invoice;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039
040public class GetPurchaseInvoiceStatusChoicesCommand
041        extends BaseSimpleCommand<GetPurchaseInvoiceStatusChoicesForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
049                    new SecurityRoleDefinition(SecurityRoleGroups.PurchaseInvoiceStatus.name(), SecurityRoles.Choices.name())
050                    )))
051                )));
052        
053        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
054            new FieldDefinition("InvoiceName", FieldType.ENTITY_NAME, false, null, null),
055            new FieldDefinition("DefaultInvoiceStatusChoice", FieldType.ENTITY_NAME, false, null, null),
056            new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
057        ));
058    }
059    
060    /** Creates a new instance of GetPurchaseInvoiceStatusChoicesCommand */
061    public GetPurchaseInvoiceStatusChoicesCommand(UserVisitPK userVisitPK, GetPurchaseInvoiceStatusChoicesForm form) {
062        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        PurchaseInvoiceLogic purchaseInvoiceLogic = PurchaseInvoiceLogic.getInstance();
068        GetPurchaseInvoiceStatusChoicesResult result = PurchaseResultFactory.getGetPurchaseInvoiceStatusChoicesResult();
069        String invoiceName = form.getInvoiceName();
070        Invoice invoice = purchaseInvoiceLogic.getInvoiceByName(invoiceName);
071        
072        if(invoiceName == null || invoice != null) {
073            String defaultInvoiceStatusChoice = form.getDefaultInvoiceStatusChoice();
074            boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
075            
076            result.setPurchaseInvoiceStatusChoices(purchaseInvoiceLogic.getPurchaseInvoiceStatusChoices(defaultInvoiceStatusChoice, getPreferredLanguage(), allowNullChoice, invoice,
077                    getPartyPK()));
078        } else {
079            addExecutionError(ExecutionErrors.UnknownPurchaseInvoiceName.name(), invoiceName);
080        }
081        
082        return result;
083    }
084    
085}