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.content.server.command;
018
019import com.echothree.control.user.content.common.edit.ContentEditFactory;
020import com.echothree.control.user.content.common.edit.ContentSectionDescriptionEdit;
021import com.echothree.control.user.content.common.form.EditContentSectionDescriptionForm;
022import com.echothree.control.user.content.common.result.ContentResultFactory;
023import com.echothree.control.user.content.common.result.EditContentSectionDescriptionResult;
024import com.echothree.control.user.content.common.spec.ContentSectionDescriptionSpec;
025import com.echothree.model.control.content.server.control.ContentControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.party.server.control.PartyControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.content.server.entity.ContentSection;
031import com.echothree.model.data.content.server.entity.ContentSectionDescription;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.EditMode;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
044
045@Dependent
046public class EditContentSectionDescriptionCommand
047        extends BaseAbstractEditCommand<ContentSectionDescriptionSpec, ContentSectionDescriptionEdit, EditContentSectionDescriptionResult, ContentSectionDescription, ContentSection> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.ContentSection.name(), SecurityRoles.Description.name())
058                ))
059        ));
060        
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("ContentCollectionName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("ContentSectionName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
065        );
066        
067        EDIT_FIELD_DEFINITIONS = List.of(
068                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
069        );
070    }
071
072    @Inject
073    ContentControl contentControl;
074
075    @Inject
076    PartyControl partyControl;
077
078    
079    /** Creates a new instance of EditContentSectionDescriptionCommand */
080    public EditContentSectionDescriptionCommand() {
081        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
082    }
083    
084    @Override
085    public EditContentSectionDescriptionResult getResult() {
086        return ContentResultFactory.getEditContentSectionDescriptionResult();
087    }
088    
089    @Override
090    public ContentSectionDescriptionEdit getEdit() {
091        return ContentEditFactory.getContentSectionDescriptionEdit();
092    }
093    
094    @Override
095    public ContentSectionDescription getEntity(EditContentSectionDescriptionResult result) {
096        ContentSectionDescription contentSectionDescription = null;
097        var contentCollectionName = spec.getContentCollectionName();
098        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
099        
100        if(contentCollection != null) {
101            var contentSectionName = spec.getContentSectionName();
102            var contentSection = contentControl.getContentSectionByName(contentCollection, contentSectionName);
103            
104            if(contentSection != null) {
105                var languageIsoName = spec.getLanguageIsoName();
106                var language = partyControl.getLanguageByIsoName(languageIsoName);
107
108                result.setContentSection(contentControl.getContentSectionTransfer(getUserVisit(), contentSection));
109
110                if(language != null) {
111                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
112                        contentSectionDescription = contentControl.getContentSectionDescription(contentSection, language);
113                    } else { // EditMode.UPDATE
114                        contentSectionDescription = contentControl.getContentSectionDescriptionForUpdate(contentSection, language);
115                    }
116
117                    if(contentSectionDescription == null) {
118                        addExecutionError(ExecutionErrors.UnknownContentSectionDescription.name());
119                    }
120                } else {
121                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
122                }
123            } else {
124                addExecutionError(ExecutionErrors.UnknownContentSectionName.name(), contentSectionName);
125            }
126        } else {
127            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
128        }
129
130        return contentSectionDescription;
131    }
132    
133    @Override
134    public ContentSection getLockEntity(ContentSectionDescription contentSectionDescription) {
135        return contentSectionDescription.getContentSection();
136    }
137    
138    @Override
139    public void fillInResult(EditContentSectionDescriptionResult result, ContentSectionDescription contentSectionDescription) {
140        result.setContentSectionDescription(contentControl.getContentSectionDescriptionTransfer(getUserVisit(), contentSectionDescription));
141    }
142    
143    @Override
144    public void doLock(ContentSectionDescriptionEdit edit, ContentSectionDescription contentSectionDescription) {
145        edit.setDescription(contentSectionDescription.getDescription());
146    }
147    
148    @Override
149    public void doUpdate(ContentSectionDescription contentSectionDescription) {
150        var contentSectionDescriptionValue = contentControl.getContentSectionDescriptionValue(contentSectionDescription);
151        contentSectionDescriptionValue.setDescription(edit.getDescription());
152
153        contentControl.updateContentSectionDescriptionFromValue(contentSectionDescriptionValue, getPartyPK());
154    }
155    
156}