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.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.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.core.server.entity.Appearance;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
029import com.echothree.util.server.control.CommandSecurityDefinition;
030import com.echothree.util.server.control.PartyTypeDefinition;
031import com.echothree.util.server.control.SecurityRoleDefinition;
032import java.util.Arrays;
033import java.util.Collection;
034import java.util.Collections;
035import java.util.List;
036
037public class GetAppearancesCommand
038        extends BaseMultipleEntitiesCommand<Appearance, GetAppearancesForm> {
039    
040    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
045                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
047                        new SecurityRoleDefinition(SecurityRoleGroups.Appearance.name(), SecurityRoles.List.name())
048                        )))
049                )));
050        
051        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
052                ));
053    }
054    
055    /** Creates a new instance of GetAppearancesCommand */
056    public GetAppearancesCommand(UserVisitPK userVisitPK, GetAppearancesForm form) {
057        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
058    }
059
060    @Override
061    protected Collection<Appearance> getEntities() {
062        var coreControl = getCoreControl();
063
064        return coreControl.getAppearances();
065    }
066
067    @Override
068    protected BaseResult getResult(Collection<Appearance> entities) {
069        var result = CoreResultFactory.getGetAppearancesResult();
070
071        if(entities != null) {
072            result.setAppearances(getCoreControl().getAppearanceTransfers(getUserVisit(), entities));
073        }
074
075        return result;
076    }
077    
078}