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.contact.server.command;
018
019import com.echothree.control.user.contact.common.form.GetContactMechanismPurposesForm;
020import com.echothree.control.user.contact.common.result.ContactResultFactory;
021import com.echothree.model.control.contact.server.control.ContactControl;
022import com.echothree.model.data.contact.server.entity.ContactMechanismPurpose;
023import com.echothree.model.data.contact.server.factory.ContactMechanismPurposeFactory;
024import com.echothree.util.common.command.BaseResult;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
027import java.util.Collection;
028import java.util.List;
029import javax.enterprise.context.Dependent;
030import javax.inject.Inject;
031
032@Dependent
033public class GetContactMechanismPurposesCommand
034        extends BasePaginatedMultipleEntitiesCommand<ContactMechanismPurpose, GetContactMechanismPurposesForm> {
035
036    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038
039    static {
040        FORM_FIELD_DEFINITIONS = List.of();
041    }
042
043    @Inject
044    ContactControl contactControl;
045
046    /** Creates a new instance of GetContactMechanismPurposesCommand */
047    public GetContactMechanismPurposesCommand() {
048        super(null, FORM_FIELD_DEFINITIONS, true);
049    }
050
051    @Override
052    protected void handleForm() {
053        // No form fields.
054    }
055
056    @Override
057    protected Long getTotalEntities() {
058        return contactControl.countContactMechanismPurposes();
059    }
060
061    @Override
062    protected Collection<ContactMechanismPurpose> getEntities() {
063        return contactControl.getContactMechanismPurposes();
064    }
065
066    @Override
067    protected BaseResult getResult(Collection<ContactMechanismPurpose> entities) {
068        var result = ContactResultFactory.getGetContactMechanismPurposesResult();
069
070        if(entities != null) {
071            if(session.hasLimit(ContactMechanismPurposeFactory.class)) {
072                result.setContactMechanismPurposeCount(contactControl.countContactMechanismPurposes());
073            }
074
075            result.setContactMechanismPurposes(contactControl.getContactMechanismPurposeTransfers(getUserVisit(), entities));
076        }
077
078        return result;
079    }
080
081}