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