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.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;
042
043public class GetDivisionsCommand
044        extends BaseMultipleEntitiesCommand<PartyDivision, GetDivisionsForm> {
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.Division.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("CompanyName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetDivisionsCommand */
063    public GetDivisionsCommand(UserVisitPK userVisitPK, GetDivisionsForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066
067
068    PartyCompany partyCompany;
069
070    @Override
071    protected Collection<PartyDivision> getEntities() {
072        var companyName = form.getCompanyName();
073        Collection<PartyDivision> partyDivisions = null;
074
075        partyCompany = CompanyLogic.getInstance().getPartyCompanyByName(this, companyName, null, null, true);
076
077        if(!hasExecutionErrors()) {
078            var partyControl = Session.getModelController(PartyControl.class);
079
080            partyDivisions = partyControl.getDivisionsByCompany(partyCompany.getParty());
081        }
082
083        return partyDivisions;
084    }
085
086    @Override
087    protected BaseResult getResult(Collection<PartyDivision> entities) {
088        var result = PartyResultFactory.getGetDivisionsResult();
089
090        if(entities != null) {
091            var partyControl = Session.getModelController(PartyControl.class);
092            var userVisit = getUserVisit();
093
094            if(session.hasLimit(PartyDivisionFactory.class)) {
095                result.setDivisionCount(partyControl.countPartyDivisions(partyCompany.getParty()));
096            }
097
098            result.setCompany(partyControl.getCompanyTransfer(userVisit, partyCompany));
099            result.setDivisions(partyControl.getDivisionTransfers(userVisit, entities));
100        }
101
102        return result;
103    }
104
105}