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.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;
038
039public class GetDepartmentCommand
040        extends BaseSingleEntityCommand<PartyDepartment, GetDepartmentForm> {
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.Department.name(), SecurityRoles.Review.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("CompanyName", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("DivisionName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("DepartmentName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null)
058        );
059    }
060
061    /** Creates a new instance of GetDepartmentCommand */
062    public GetDepartmentCommand(UserVisitPK userVisitPK, GetDepartmentForm form) {
063        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065
066
067    @Override
068    protected PartyDepartment getEntity() {
069        var companyName = form.getCompanyName();
070        var divisionName = form.getDivisionName();
071        var departmentName = form.getDepartmentName();
072        var partyName = form.getPartyName();
073        var partyDepartment = DepartmentLogic.getInstance().getPartyDepartmentByName(this, companyName,
074                divisionName, departmentName, partyName, form, true);
075
076        if(partyDepartment != null) {
077            sendEvent(partyDepartment.getPartyPK(), EventTypes.READ, null, null, getPartyPK());
078        }
079
080        return partyDepartment;
081    }
082
083    @Override
084    protected BaseResult getResult(PartyDepartment partyDepartment) {
085        var result = PartyResultFactory.getGetDepartmentResult();
086
087        if(partyDepartment != null) {
088            var partyControl = Session.getModelController(PartyControl.class);
089
090            result.setDepartment(partyControl.getDepartmentTransfer(getUserVisit(), partyDepartment));
091        }
092
093        return result;
094    }
095
096}