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.forum.server.command;
018
019import com.echothree.control.user.forum.common.edit.ForumEditFactory;
020import com.echothree.control.user.forum.common.edit.ForumMessageAttachmentDescriptionEdit;
021import com.echothree.control.user.forum.common.form.EditForumMessageAttachmentDescriptionForm;
022import com.echothree.control.user.forum.common.result.EditForumMessageAttachmentDescriptionResult;
023import com.echothree.control.user.forum.common.result.ForumResultFactory;
024import com.echothree.control.user.forum.common.spec.ForumMessageAttachmentDescriptionSpec;
025import com.echothree.model.control.forum.server.control.ForumControl;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.data.forum.server.entity.ForumMessageAttachment;
028import com.echothree.model.data.forum.server.entity.ForumMessageAttachmentDescription;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.EditMode;
034import com.echothree.util.server.control.BaseAbstractEditCommand;
035import com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class EditForumMessageAttachmentDescriptionCommand
041        extends BaseAbstractEditCommand<ForumMessageAttachmentDescriptionSpec, ForumMessageAttachmentDescriptionEdit, EditForumMessageAttachmentDescriptionResult, ForumMessageAttachmentDescription, ForumMessageAttachment> {
042    
043    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
044    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
045    
046    static {
047        SPEC_FIELD_DEFINITIONS = List.of(
048                new FieldDefinition("ForumMessageName", FieldType.ENTITY_NAME, true, null, null),
049                new FieldDefinition("ForumMessageAttachmentSequence", FieldType.UNSIGNED_INTEGER, true, null, null),
050                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
051                );
052
053        EDIT_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
055                );
056    }
057    
058    /** Creates a new instance of EditForumMessageAttachmentDescriptionCommand */
059    public EditForumMessageAttachmentDescriptionCommand() {
060        super(null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
061    }
062
063    @Override
064    public EditForumMessageAttachmentDescriptionResult getResult() {
065        return ForumResultFactory.getEditForumMessageAttachmentDescriptionResult();
066    }
067
068    @Override
069    public ForumMessageAttachmentDescriptionEdit getEdit() {
070        return ForumEditFactory.getForumMessageAttachmentDescriptionEdit();
071    }
072
073    @Override
074    public ForumMessageAttachmentDescription getEntity(EditForumMessageAttachmentDescriptionResult result) {
075        var forumControl = Session.getModelController(ForumControl.class);
076        ForumMessageAttachmentDescription forumMessageAttachmentDescription = null;
077        var forumMessageName = spec.getForumMessageName();
078        var forumMessage = forumControl.getForumMessageByNameForUpdate(forumMessageName);
079
080        if(forumMessage != null) {
081            var forumMessageAttachmentSequence = Integer.valueOf(spec.getForumMessageAttachmentSequence());
082            var forumMessageAttachment = forumControl.getForumMessageAttachmentBySequence(forumMessage, forumMessageAttachmentSequence);
083
084            if(forumMessageAttachment != null) {
085                var partyControl = Session.getModelController(PartyControl.class);
086                var languageIsoName = spec.getLanguageIsoName();
087                var language = partyControl.getLanguageByIsoName(languageIsoName);
088
089                if(language != null) {
090                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
091                        forumMessageAttachmentDescription = forumControl.getForumMessageAttachmentDescription(forumMessageAttachment, language);
092                    } else { // EditMode.UPDATE
093                        forumMessageAttachmentDescription = forumControl.getForumMessageAttachmentDescriptionForUpdate(forumMessageAttachment, language);
094                    }
095
096                    if(forumMessageAttachmentDescription == null) {
097                        addExecutionError(ExecutionErrors.UnknownForumMessageAttachmentDescription.name(), forumMessageName,
098                                forumMessageAttachmentSequence.toString(), languageIsoName);
099                    }
100                } else {
101                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
102                }
103            } else {
104                addExecutionError(ExecutionErrors.UnknownForumMessageAttachment.name(), forumMessageName, forumMessageAttachmentSequence.toString());
105            }
106        } else {
107            addExecutionError(ExecutionErrors.UnknownForumMessageName.name(), forumMessageName);
108        }
109
110        return forumMessageAttachmentDescription;
111    }
112
113    @Override
114    public ForumMessageAttachment getLockEntity(ForumMessageAttachmentDescription forumMessageAttachmentDescription) {
115        return forumMessageAttachmentDescription.getForumMessageAttachment();
116    }
117
118    @Override
119    public void fillInResult(EditForumMessageAttachmentDescriptionResult result, ForumMessageAttachmentDescription forumMessageAttachmentDescription) {
120        var forumControl = Session.getModelController(ForumControl.class);
121
122        result.setForumMessageAttachmentDescription(forumControl.getForumMessageAttachmentDescriptionTransfer(getUserVisit(), forumMessageAttachmentDescription));
123    }
124
125    @Override
126    public void doLock(ForumMessageAttachmentDescriptionEdit edit, ForumMessageAttachmentDescription forumMessageAttachmentDescription) {
127        edit.setDescription(forumMessageAttachmentDescription.getDescription());
128    }
129
130    @Override
131    public void doUpdate(ForumMessageAttachmentDescription forumMessageAttachmentDescription) {
132        var forumControl = Session.getModelController(ForumControl.class);
133        var forumMessageAttachmentDescriptionValue = forumControl.getForumMessageAttachmentDescriptionValue(forumMessageAttachmentDescription);
134
135        forumMessageAttachmentDescriptionValue.setDescription(edit.getDescription());
136
137        forumControl.updateForumMessageAttachmentDescriptionFromValue(forumMessageAttachmentDescriptionValue, getPartyPK());
138    }
139    
140}