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.GetDivisionsForm;
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.CompanyLogic;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.party.server.entity.PartyCompany;
027import com.echothree.model.data.party.server.entity.PartyDivision;
028import com.echothree.model.data.party.server.factory.PartyDivisionFactory;
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.Arrays;
039import java.util.Collection;
040import java.util.Collections;
041import java.util.List;
042import javax.enterprise.context.RequestScoped;
043
044@RequestScoped
045public class GetDivisionsCommand
046        extends BaseMultipleEntitiesCommand<PartyDivision, GetDivisionsForm> {
047
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.Division.name(), SecurityRoles.List.name())
056                ))
057        ));
058
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("CompanyName", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetDivisionsCommand */
065    public GetDivisionsCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068
069
070    PartyCompany partyCompany;
071
072    @Override
073    protected Collection<PartyDivision> getEntities() {
074        var companyName = form.getCompanyName();
075        Collection<PartyDivision> partyDivisions = null;
076
077        partyCompany = CompanyLogic.getInstance().getPartyCompanyByName(this, companyName, null, null, true);
078
079        if(!hasExecutionErrors()) {
080            var partyControl = Session.getModelController(PartyControl.class);
081
082            partyDivisions = partyControl.getDivisionsByCompany(partyCompany.getParty());
083        }
084
085        return partyDivisions;
086    }
087
088    @Override
089    protected BaseResult getResult(Collection<PartyDivision> entities) {
090        var result = PartyResultFactory.getGetDivisionsResult();
091
092        if(entities != null) {
093            var partyControl = Session.getModelController(PartyControl.class);
094            var userVisit = getUserVisit();
095
096            if(session.hasLimit(PartyDivisionFactory.class)) {
097                result.setDivisionCount(partyControl.countPartyDivisions(partyCompany.getParty()));
098            }
099
100            result.setCompany(partyControl.getCompanyTransfer(userVisit, partyCompany));
101            result.setDivisions(partyControl.getDivisionTransfers(userVisit, entities));
102        }
103
104        return result;
105    }
106
107}