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.core.server.command;
018
019import com.echothree.control.user.core.common.form.GetAppearancesForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.AppearanceControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.core.server.entity.Appearance;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import java.util.Collection;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class GetAppearancesCommand
040        extends BasePaginatedMultipleEntitiesCommand<Appearance, GetAppearancesForm> {
041
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.Appearance.name(), SecurityRoles.List.name())
050                ))
051        ));
052        
053        FORM_FIELD_DEFINITIONS = List.of();
054    }
055
056    @Inject
057    AppearanceControl appearanceControl;
058
059    
060    /** Creates a new instance of GetAppearancesCommand */
061    public GetAppearancesCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
063    }
064
065    @Override
066    protected void handleForm() {
067        // No form fields.
068    }
069
070    @Override
071    protected Long getTotalEntities() {
072        return appearanceControl.countAppearances();
073    }
074
075    @Override
076    protected Collection<Appearance> getEntities() {
077        return appearanceControl.getAppearances();
078    }
079
080    @Override
081    protected BaseResult getResult(Collection<Appearance> entities) {
082        var result = CoreResultFactory.getGetAppearancesResult();
083
084        if(entities != null) {
085            result.setAppearances(appearanceControl.getAppearanceTransfers(getUserVisit(), entities));
086        }
087
088        return result;
089    }
090    
091}