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