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.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.user.common.pk.UserVisitPK;
024import com.echothree.util.common.command.BaseResult;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
027import com.echothree.util.server.persistence.Session;
028import java.util.Collection;
029import java.util.List;
030import javax.enterprise.context.RequestScoped;
031
032@RequestScoped
033public class GetContactMechanismPurposesCommand
034        extends BasePaginatedMultipleEntitiesCommand<ContactMechanismPurpose, GetContactMechanismPurposesForm> {
035
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 GetContactMechanismPurposesCommand */
043    public GetContactMechanismPurposesCommand() {
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 contactControl = Session.getModelController(ContactControl.class);
055
056        return contactControl.countContactMechanismPurposes();
057    }
058
059    @Override
060    protected Collection<ContactMechanismPurpose> getEntities() {
061        var contactControl = Session.getModelController(ContactControl.class);
062
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            var contactControl = Session.getModelController(ContactControl.class);
072
073            result.setContactMechanismPurposes(contactControl.getContactMechanismPurposeTransfers(getUserVisit(), entities));
074        }
075
076        return result;
077    }
078
079}