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.forum.server.command;
018
019import com.echothree.control.user.forum.common.edit.ForumDescriptionEdit;
020import com.echothree.control.user.forum.common.edit.ForumEditFactory;
021import com.echothree.control.user.forum.common.form.EditForumDescriptionForm;
022import com.echothree.control.user.forum.common.result.EditForumDescriptionResult;
023import com.echothree.control.user.forum.common.result.ForumResultFactory;
024import com.echothree.control.user.forum.common.spec.ForumDescriptionSpec;
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.Forum;
028import com.echothree.model.data.forum.server.entity.ForumDescription;
029import com.echothree.model.data.forum.server.value.ForumDescriptionValue;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.EditMode;
036import com.echothree.util.server.control.BaseAbstractEditCommand;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class EditForumDescriptionCommand
043        extends BaseAbstractEditCommand<ForumDescriptionSpec, ForumDescriptionEdit, EditForumDescriptionResult, ForumDescription, Forum> {
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("ForumName", FieldType.ENTITY_NAME, true, null, null),
051                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
052                ));
053
054        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
056                ));
057    }
058    
059    /** Creates a new instance of EditForumDescriptionCommand */
060    public EditForumDescriptionCommand(UserVisitPK userVisitPK, EditForumDescriptionForm form) {
061        super(userVisitPK, form, null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
062    }
063    
064    @Override
065    public EditForumDescriptionResult getResult() {
066        return ForumResultFactory.getEditForumDescriptionResult();
067    }
068
069    @Override
070    public ForumDescriptionEdit getEdit() {
071        return ForumEditFactory.getForumDescriptionEdit();
072    }
073
074    @Override
075    public ForumDescription getEntity(EditForumDescriptionResult result) {
076        var forumControl = Session.getModelController(ForumControl.class);
077        ForumDescription forumDescription = null;
078        String forumName = spec.getForumName();
079        Forum forum = forumControl.getForumByName(forumName);
080
081        if(forum != null) {
082            var partyControl = Session.getModelController(PartyControl.class);
083            String languageIsoName = spec.getLanguageIsoName();
084            Language language = partyControl.getLanguageByIsoName(languageIsoName);
085
086            if(language != null) {
087                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
088                    forumDescription = forumControl.getForumDescription(forum, language);
089                } else { // EditMode.UPDATE
090                    forumDescription = forumControl.getForumDescriptionForUpdate(forum, language);
091                }
092
093                if(forumDescription == null) {
094                    addExecutionError(ExecutionErrors.UnknownForumDescription.name(), forumName, languageIsoName);
095                }
096            } else {
097                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
098            }
099        } else {
100            addExecutionError(ExecutionErrors.UnknownForumName.name(), forumName);
101        }
102
103        return forumDescription;
104    }
105
106    @Override
107    public Forum getLockEntity(ForumDescription forumDescription) {
108        return forumDescription.getForum();
109    }
110
111    @Override
112    public void fillInResult(EditForumDescriptionResult result, ForumDescription forumDescription) {
113        var forumControl = Session.getModelController(ForumControl.class);
114
115        result.setForumDescription(forumControl.getForumDescriptionTransfer(getUserVisit(), forumDescription));
116    }
117
118    @Override
119    public void doLock(ForumDescriptionEdit edit, ForumDescription forumDescription) {
120        edit.setDescription(forumDescription.getDescription());
121    }
122
123    @Override
124    public void doUpdate(ForumDescription forumDescription) {
125        var forumControl = Session.getModelController(ForumControl.class);
126        ForumDescriptionValue forumDescriptionValue = forumControl.getForumDescriptionValue(forumDescription);
127
128        forumDescriptionValue.setDescription(edit.getDescription());
129
130        forumControl.updateForumDescriptionFromValue(forumDescriptionValue, getPartyPK());
131    }
132    
133}