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.accounting.server.command;
018
019import com.echothree.control.user.accounting.common.form.GetSymbolPositionChoicesForm;
020import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
021import com.echothree.control.user.accounting.common.result.GetSymbolPositionChoicesResult;
022import com.echothree.model.control.accounting.server.control.AccountingControl;
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.user.common.pk.UserVisitPK;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038
039public class GetSymbolPositionChoicesCommand
040        extends BaseSimpleCommand<GetSymbolPositionChoicesForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
048                        new SecurityRoleDefinition(SecurityRoleGroups.SymbolPosition.name(), SecurityRoles.Choices.name())
049                        )))
050                )));
051        
052        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
053                new FieldDefinition("DefaultSymbolPositionChoice", FieldType.ENTITY_NAME, false, null, null),
054                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
055                ));
056    }
057    
058    /** Creates a new instance of GetSymbolPositionChoicesCommand */
059    public GetSymbolPositionChoicesCommand(UserVisitPK userVisitPK, GetSymbolPositionChoicesForm form) {
060        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
061    }
062    
063    @Override
064    protected BaseResult execute() {
065        var accountingControl = Session.getModelController(AccountingControl.class);
066        GetSymbolPositionChoicesResult result = AccountingResultFactory.getGetSymbolPositionChoicesResult();
067        String defaultSymbolPositionChoice = form.getDefaultSymbolPositionChoice();
068        boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
069        
070        result.setSymbolPositionChoices(accountingControl.getSymbolPositionChoices(defaultSymbolPositionChoice,
071                getPreferredLanguage(), allowNullChoice));
072        
073        return result;
074    }
075    
076}