001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.party.server.command;
018
019import com.echothree.control.user.party.common.form.GetNameSuffixesForm;
020import com.echothree.control.user.party.common.result.PartyResultFactory;
021import com.echothree.model.control.party.server.control.PartyControl;
022import com.echothree.model.data.party.server.entity.NameSuffix;
023import com.echothree.util.common.command.BaseResult;
024import com.echothree.util.common.validation.FieldDefinition;
025import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
026import com.echothree.util.server.persistence.Session;
027import java.util.Collection;
028import java.util.List;
029import javax.enterprise.context.RequestScoped;
030
031@RequestScoped
032public class GetNameSuffixesCommand
033        extends BasePaginatedMultipleEntitiesCommand<NameSuffix, GetNameSuffixesForm> {
034    
035    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
036    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
037
038    static {
039        FORM_FIELD_DEFINITIONS = List.of();
040    }
041    
042    /** Creates a new instance of GetNameSuffixesCommand */
043    public GetNameSuffixesCommand() {
044        super(null, FORM_FIELD_DEFINITIONS, true);
045    }
046
047    @Override
048    protected void handleForm() {
049        // No form fields.
050    }
051
052    @Override
053    protected Long getTotalEntities() {
054        var partyControl = Session.getModelController(PartyControl.class);
055
056        return partyControl.countNameSuffixes();
057    }
058    
059    @Override
060    protected Collection<NameSuffix> getEntities() {
061        var partyControl = Session.getModelController(PartyControl.class);
062        
063        return partyControl.getNameSuffixes();
064    }
065    
066    @Override
067    protected BaseResult getResult(Collection<NameSuffix> entities) {
068        var result = PartyResultFactory.getGetNameSuffixesResult();
069        var partyControl = Session.getModelController(PartyControl.class);
070        
071        result.setNameSuffixes(partyControl.getNameSuffixTransfers(getUserVisit(), entities));
072        
073        return result;
074    }
075    
076}