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.club.server.command;
018
019import com.echothree.control.user.club.common.form.GetClubForm;
020import com.echothree.control.user.club.common.result.ClubResultFactory;
021import com.echothree.model.control.club.server.control.ClubControl;
022import com.echothree.model.control.club.server.logic.ClubLogic;
023import com.echothree.model.control.core.common.EventTypes;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.club.server.entity.Club;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSingleEntityCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetClubCommand
041        extends BaseSingleEntityCommand<Club, GetClubForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.Club.name(), SecurityRoles.Review.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("ClubName", FieldType.ENTITY_NAME, true, null, null)
056        );
057    }
058
059    @Inject
060    ClubControl clubControl;
061
062    @Inject
063    ClubLogic clubLogic;
064    
065    /** Creates a new instance of GetClubCommand */
066    public GetClubCommand() {
067        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069    
070    @Override
071    protected Club getEntity() {
072        var club = clubLogic.getClubByName(this, form.getClubName());
073        
074        if(club != null) {
075            sendEvent(club.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
076        }
077
078        return club;
079    }
080
081    @Override
082    protected BaseResult getResult(Club club) {
083        var result = ClubResultFactory.getGetClubResult();
084
085        if(club != null) {
086            result.setClub(clubControl.getClubTransfer(getUserVisit(), club));
087        }
088        
089        return result;
090    }
091    
092}