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.index.server.command;
018
019import com.echothree.control.user.index.common.form.GetIndexFieldDescriptionForm;
020import com.echothree.control.user.index.common.result.GetIndexFieldDescriptionResult;
021import com.echothree.control.user.index.common.result.IndexResultFactory;
022import com.echothree.model.control.index.server.control.IndexControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.party.server.control.PartyControl;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.index.server.entity.IndexField;
028import com.echothree.model.data.index.server.entity.IndexFieldDescription;
029import com.echothree.model.data.index.server.entity.IndexType;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.BaseResult;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class GetIndexFieldDescriptionCommand
046        extends BaseSimpleCommand<GetIndexFieldDescriptionForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                        new SecurityRoleDefinition(SecurityRoleGroups.IndexField.name(), SecurityRoles.Description.name())
056                        )))
057                )));
058        
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("IndexTypeName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("IndexFieldName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064    }
065    
066    /** Creates a new instance of GetIndexFieldDescriptionCommand */
067    public GetIndexFieldDescriptionCommand(UserVisitPK userVisitPK, GetIndexFieldDescriptionForm form) {
068        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var indexControl = Session.getModelController(IndexControl.class);
074        GetIndexFieldDescriptionResult result = IndexResultFactory.getGetIndexFieldDescriptionResult();
075        String indexTypeName = form.getIndexTypeName();
076        IndexType indexType = indexControl.getIndexTypeByName(indexTypeName);
077
078        if(indexType != null) {
079            String indexFieldName = form.getIndexFieldName();
080            IndexField indexField = indexControl.getIndexFieldByName(indexType, indexFieldName);
081
082            if(indexField != null) {
083                var partyControl = Session.getModelController(PartyControl.class);
084                String languageIsoName = form.getLanguageIsoName();
085                Language language = partyControl.getLanguageByIsoName(languageIsoName);
086
087                if(language != null) {
088                    IndexFieldDescription indexFieldDescription = indexControl.getIndexFieldDescription(indexField, language);
089
090                    if(indexFieldDescription != null) {
091                        result.setIndexFieldDescription(indexControl.getIndexFieldDescriptionTransfer(getUserVisit(), indexFieldDescription));
092                    } else {
093                        addExecutionError(ExecutionErrors.UnknownIndexFieldDescription.name(), indexTypeName, indexFieldName, languageIsoName);
094                    }
095                } else {
096                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
097                }
098            } else {
099                addExecutionError(ExecutionErrors.UnknownIndexFieldName.name(), indexTypeName, indexFieldName);
100            }
101        } else {
102            addExecutionError(ExecutionErrors.UnknownIndexTypeName.name(), indexTypeName);
103        }
104        
105        return result;
106    }
107    
108}