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.GetAppearanceForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.logic.AppearanceLogic;
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.common.validation.FieldType;
030import com.echothree.util.server.control.BaseSingleEntityCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037
038public class GetAppearanceCommand
039        extends BaseSingleEntityCommand<Appearance, GetAppearanceForm> {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
048                        new SecurityRoleDefinition(SecurityRoleGroups.Appearance.name(), SecurityRoles.Review.name())
049                        )))
050                )));
051        
052        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
053                new FieldDefinition("AppearanceName", FieldType.ENTITY_NAME, false, null, null),
054                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
055                new FieldDefinition("Key", FieldType.KEY, false, null, null),
056                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
057                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
058                ));
059    }
060    
061    /** Creates a new instance of GetAppearanceCommand */
062    public GetAppearanceCommand(UserVisitPK userVisitPK, GetAppearanceForm form) {
063        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065
066    @Override
067    protected Appearance getEntity() {
068        var appearance = AppearanceLogic.getInstance().getAppearanceByUniversalSpec(this, form);
069
070        return appearance;
071    }
072
073    @Override
074    protected BaseResult getResult(Appearance appearance) {
075        var result = CoreResultFactory.getGetAppearanceResult();
076
077        if(appearance != null) {
078            result.setAppearance(getCoreControl().getAppearanceTransfer(getUserVisit(), appearance));
079        }
080
081        return result;
082    }
083
084}