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.index.server.command;
018
019import com.echothree.control.user.index.common.form.GetIndexFieldsForm;
020import com.echothree.control.user.index.common.result.IndexResultFactory;
021import com.echothree.model.control.index.server.control.IndexControl;
022import com.echothree.model.control.index.server.logic.IndexTypeLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.index.server.entity.IndexField;
027import com.echothree.model.data.index.server.entity.IndexType;
028import com.echothree.model.data.index.server.factory.IndexFieldFactory;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetIndexFieldsCommand
043        extends BasePaginatedMultipleEntitiesCommand<IndexField, GetIndexFieldsForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.IndexField.name(), SecurityRoles.List.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("IndexTypeName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060    
061    @Inject
062    IndexControl indexControl;
063
064    @Inject
065    IndexTypeLogic indexTypeLogic;
066
067    /** Creates a new instance of GetIndexFieldsCommand */
068    public GetIndexFieldsCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
070    }
071
072    IndexType indexType;
073
074    @Override
075    protected void handleForm() {
076        indexType = indexTypeLogic.getIndexTypeByName(this, form.getIndexTypeName());
077    }
078
079    @Override
080    protected Long getTotalEntities() {
081        return hasExecutionErrors() ? null : indexControl.countIndexFieldsByIndexType(indexType);
082    }
083
084    @Override
085    protected Collection<IndexField> getEntities() {
086        return hasExecutionErrors() ? null : indexControl.getIndexFields(indexType);
087    }
088
089    @Override
090    protected BaseResult getResult(Collection<IndexField> entities) {
091        var result = IndexResultFactory.getGetIndexFieldsResult();
092
093        if(entities != null) {
094            var userVisit = getUserVisit();
095
096            result.setIndexType(indexControl.getIndexTypeTransfer(userVisit, indexType));
097
098            if(session.hasLimit(IndexFieldFactory.class)) {
099                result.setIndexFieldCount(getTotalEntities());
100            }
101
102            result.setIndexFields(indexControl.getIndexFieldTransfersByIndexType(userVisit, indexType));
103        }
104
105        return result;
106    }
107    
108}