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.term.server.command;
018
019import com.echothree.control.user.term.common.form.GetTermForm;
020import com.echothree.control.user.term.common.result.TermResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.term.server.control.TermControl;
023import com.echothree.model.control.term.server.logic.TermLogic;
024import com.echothree.model.data.term.server.entity.Term;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSingleEntityCommand;
030import com.echothree.util.server.persistence.Session;
031import java.util.List;
032
033public class GetTermCommand
034        extends BaseSingleEntityCommand<Term, GetTermForm> {
035    
036    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
037    
038    static {
039        FORM_FIELD_DEFINITIONS = List.of(
040                new FieldDefinition("TermName", FieldType.ENTITY_NAME, false, null, null),
041                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
042                new FieldDefinition("Key", FieldType.KEY, false, null, null),
043                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
044                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
045        );
046    }
047    
048    /** Creates a new instance of GetTermCommand */
049    public GetTermCommand(UserVisitPK userVisitPK, GetTermForm form) {
050        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
051    }
052
053    @Override
054    protected Term getEntity() {
055        var term = TermLogic.getInstance().getTermByUniversalSpec(this, form, true);
056
057        if(term != null) {
058            sendEvent(term.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
059        }
060
061        return term;
062    }
063
064    @Override
065    protected BaseResult getResult(Term term) {
066        var result = TermResultFactory.getGetTermResult();
067        var termControl = Session.getModelController(TermControl.class);
068
069        if(term != null) {
070            result.setTerm(termControl.getTermTransfer(getUserVisit(), term));
071        }
072
073        return result;
074    }
075    
076}