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.GetCompanyForm;
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.CompanyLogic;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.party.server.entity.PartyCompany;
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.Arrays;
038import java.util.Collections;
039import java.util.List;
040
041public class GetCompanyCommand
042        extends BaseSingleEntityCommand<PartyCompany, GetCompanyForm> {
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.Company.name(), SecurityRoles.Review.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("CompanyName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
059                new FieldDefinition("Key", FieldType.KEY, false, null, null),
060                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
061                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
062        );
063    }
064    
065    /** Creates a new instance of GetCompanyCommand */
066    public GetCompanyCommand(UserVisitPK userVisitPK, GetCompanyForm form) {
067        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069
070    @Override
071    protected PartyCompany getEntity() {
072        var companyName = form.getCompanyName();
073        var partyName = form.getPartyName();
074        var partyCompany = CompanyLogic.getInstance().getPartyCompanyByName(this, companyName, partyName, form, true);
075
076        if(partyCompany != null) {
077            sendEvent(partyCompany.getPartyPK(), EventTypes.READ, null, null, getPartyPK());
078        }
079
080        return partyCompany;
081    }
082
083    @Override
084    protected BaseResult getResult(PartyCompany partyCompany) {
085        var result = PartyResultFactory.getGetCompanyResult();
086
087        if(partyCompany != null) {
088            var partyControl = Session.getModelController(PartyControl.class);
089
090            result.setCompany(partyControl.getCompanyTransfer(getUserVisit(), partyCompany));
091        }
092
093        return result;
094    }
095
096}