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.GetDepartmentsForm;
020import com.echothree.control.user.party.common.result.PartyResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.party.server.control.PartyControl;
023import com.echothree.model.control.party.server.logic.DivisionLogic;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.party.server.entity.PartyDepartment;
027import com.echothree.model.data.party.server.entity.PartyDivision;
028import com.echothree.model.data.party.server.factory.PartyDepartmentFactory;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Collection;
039import java.util.List;
040
041public class GetDepartmentsCommand
042        extends BaseMultipleEntitiesCommand<PartyDepartment, GetDepartmentsForm> {
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.List.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("CompanyName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("DivisionName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060    
061    /** Creates a new instance of GetDepartmentsCommand */
062    public GetDepartmentsCommand(UserVisitPK userVisitPK, GetDepartmentsForm form) {
063        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065    
066    PartyDivision partyDivision;
067
068    @Override
069    protected Collection<PartyDepartment> getEntities() {
070        var companyName = form.getCompanyName();
071        var divisionName = form.getDivisionName();
072        Collection<PartyDepartment> partyDepartments = null;
073
074        partyDivision = DivisionLogic.getInstance().getPartyDivisionByName(this, companyName, divisionName, null, null, true);
075
076        if(!hasExecutionErrors()) {
077            var partyControl = Session.getModelController(PartyControl.class);
078
079            partyDepartments = partyControl.getDepartmentsByDivision(partyDivision.getParty());
080        }
081
082        return partyDepartments;
083    }
084
085    @Override
086    protected BaseResult getResult(Collection<PartyDepartment> entities) {
087        var result = PartyResultFactory.getGetDepartmentsResult();
088
089        if(entities != null) {
090            var partyControl = Session.getModelController(PartyControl.class);
091            var userVisit = getUserVisit();
092
093            if(session.hasLimit(PartyDepartmentFactory.class)) {
094                result.setDepartmentCount(partyControl.countPartyDepartments(partyDivision.getParty()));
095            }
096
097            result.setDivision(partyControl.getDivisionTransfer(userVisit, partyDivision));
098            result.setDepartments(partyControl.getDepartmentTransfers(userVisit, entities));
099        }
100
101        return result;
102    }
103    
104}