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.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.BasePaginatedMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.Collection;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class GetDepartmentsCommand
044        extends BasePaginatedMultipleEntitiesCommand<PartyDepartment, GetDepartmentsForm> {
045
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.Department.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("CompanyName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("DivisionName", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062
063    @Inject
064    PartyControl partyControl;
065
066    @Inject
067    DivisionLogic divisionLogic;
068    
069    /** Creates a new instance of GetDepartmentsCommand */
070    public GetDepartmentsCommand() {
071        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
072    }
073    
074    PartyDivision partyDivision;
075
076    @Override
077    protected void handleForm() {
078        var companyName = form.getCompanyName();
079        var divisionName = form.getDivisionName();
080
081        partyDivision = divisionLogic.getPartyDivisionByName(this, companyName, divisionName, null, null, true);
082    }
083
084    @Override
085    protected Long getTotalEntities() {
086        return hasExecutionErrors() ? null : partyControl.countPartyDepartments(partyDivision.getParty());
087    }
088
089    @Override
090    protected Collection<PartyDepartment> getEntities() {
091        return hasExecutionErrors() ? null : partyControl.getDepartmentsByDivision(partyDivision.getParty());
092    }
093
094    @Override
095    protected BaseResult getResult(Collection<PartyDepartment> entities) {
096        var result = PartyResultFactory.getGetDepartmentsResult();
097
098        if(entities != null) {
099            var userVisit = getUserVisit();
100
101            if(session.hasLimit(PartyDepartmentFactory.class)) {
102                result.setDepartmentCount(getTotalEntities());
103            }
104
105            result.setDivision(partyControl.getDivisionTransfer(userVisit, partyDivision));
106            result.setDepartments(partyControl.getDepartmentTransfers(userVisit, entities));
107        }
108
109        return result;
110    }
111    
112}