001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.party.server.command;
018
019import com.echothree.control.user.party.common.form.GetDepartmentForm;
020import com.echothree.control.user.party.common.result.PartyResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.party.server.logic.DepartmentLogic;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.party.server.entity.PartyDepartment;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class GetDepartmentCommand
042        extends BaseSingleEntityCommand<PartyDepartment, GetDepartmentForm> {
043
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.Department.name(), SecurityRoles.Review.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("CompanyName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("DivisionName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("DepartmentName", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null)
060        );
061    }
062
063    /** Creates a new instance of GetDepartmentCommand */
064    public GetDepartmentCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067
068
069    @Override
070    protected PartyDepartment getEntity() {
071        var companyName = form.getCompanyName();
072        var divisionName = form.getDivisionName();
073        var departmentName = form.getDepartmentName();
074        var partyName = form.getPartyName();
075        var partyDepartment = DepartmentLogic.getInstance().getPartyDepartmentByName(this, companyName,
076                divisionName, departmentName, partyName, form, true);
077
078        if(partyDepartment != null) {
079            sendEvent(partyDepartment.getPartyPK(), EventTypes.READ, null, null, getPartyPK());
080        }
081
082        return partyDepartment;
083    }
084
085    @Override
086    protected BaseResult getResult(PartyDepartment partyDepartment) {
087        var result = PartyResultFactory.getGetDepartmentResult();
088
089        if(partyDepartment != null) {
090            var partyControl = Session.getModelController(PartyControl.class);
091
092            result.setDepartment(partyControl.getDepartmentTransfer(getUserVisit(), partyDepartment));
093        }
094
095        return result;
096    }
097
098}