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.letter.server.command;
018
019import com.echothree.control.user.letter.common.form.GetLetterSourceForm;
020import com.echothree.control.user.letter.common.result.LetterResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.letter.server.control.LetterControl;
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.util.common.command.BaseResult;
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.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 java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class GetLetterSourceCommand
040        extends BaseSimpleCommand<GetLetterSourceForm> {
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(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.LetterSource.name(), SecurityRoles.Review.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("LetterSourceName", FieldType.ENTITY_NAME, true, null, null)
055        );
056    }
057
058    @Inject
059    LetterControl letterControl;
060
061    /** Creates a new instance of GetLetterSourceCommand */
062    public GetLetterSourceCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065
066    @Override
067    protected BaseResult execute() {
068        var result = LetterResultFactory.getGetLetterSourceResult();
069        var letterSourceName = form.getLetterSourceName();
070        var letterSource = letterControl.getLetterSourceByName(letterSourceName);
071
072        if(letterSource != null) {
073            result.setLetterSource(letterControl.getLetterSourceTransfer(getUserVisit(), letterSource));
074
075            sendEvent(letterSource.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
076        } else {
077            addExecutionError(ExecutionErrors.UnknownLetterSourceName.name(), letterSourceName);
078        }
079
080        return result;
081    }
082
083}