001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.document.server.command;
018
019import com.echothree.control.user.document.common.form.GetPartyDocumentChoicesForm;
020import com.echothree.control.user.document.common.result.DocumentResultFactory;
021import com.echothree.model.control.document.server.control.DocumentControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetPartyDocumentChoicesCommand
041        extends BaseSimpleCommand<GetPartyDocumentChoicesForm> {
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(List.of(
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.PartyDocument.name(), SecurityRoles.Choices.name())
050                        ))
051                ));
052        
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("DocumentTypeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("DefaultDocumentChoice", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
058                );
059    }
060    
061    /** Creates a new instance of GetPartyDocumentChoicesCommand */
062    public GetPartyDocumentChoicesCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var partyControl = Session.getModelController(PartyControl.class);
069        var result = DocumentResultFactory.getGetPartyDocumentChoicesResult();
070        var partyName = form.getPartyName();
071        var party = partyControl.getPartyByName(partyName);
072
073        if(party != null) {
074            var documentControl = Session.getModelController(DocumentControl.class);
075            var documentTypeName = form.getDocumentTypeName();
076            var documentType = documentControl.getDocumentTypeByName(documentTypeName);
077
078            if(documentType != null) {
079                var defaultDocumentChoice = form.getDefaultDocumentChoice();
080                var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
081
082                result.setDocumentChoices(documentControl.getPartyDocumentChoices(defaultDocumentChoice, getPreferredLanguage(), allowNullChoice, party,
083                        documentType));
084            } else {
085                addExecutionError(ExecutionErrors.UnknownDocumentTypeName.name(), documentTypeName);
086            }
087        } else {
088            addExecutionError(ExecutionErrors.UnknownPartyName.name(), partyName);
089        }
090        
091        return result;
092    }
093    
094}