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.ContentCategoryDescriptionEdit;
020import com.echothree.control.user.content.common.edit.ContentEditFactory;
021import com.echothree.control.user.content.common.form.EditContentCategoryDescriptionForm;
022import com.echothree.control.user.content.common.result.ContentResultFactory;
023import com.echothree.control.user.content.common.result.EditContentCategoryDescriptionResult;
024import com.echothree.control.user.content.common.spec.ContentCategoryDescriptionSpec;
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.ContentCategory;
031import com.echothree.model.data.content.server.entity.ContentCategoryDescription;
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 com.echothree.util.server.persistence.Session;
042import java.util.List;
043import javax.enterprise.context.Dependent;
044
045@Dependent
046public class EditContentCategoryDescriptionCommand
047        extends BaseAbstractEditCommand<ContentCategoryDescriptionSpec, ContentCategoryDescriptionEdit, EditContentCategoryDescriptionResult, ContentCategoryDescription, ContentCategory> {
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.ContentCategory.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("ContentCatalogName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("ContentCategoryName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
066                );
067        
068        EDIT_FIELD_DEFINITIONS = List.of(
069                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
070                );
071    }
072    
073    /** Creates a new instance of EditContentCategoryDescriptionCommand */
074    public EditContentCategoryDescriptionCommand() {
075        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077    
078    @Override
079    public EditContentCategoryDescriptionResult getResult() {
080        return ContentResultFactory.getEditContentCategoryDescriptionResult();
081    }
082    
083    @Override
084    public ContentCategoryDescriptionEdit getEdit() {
085        return ContentEditFactory.getContentCategoryDescriptionEdit();
086    }
087    
088    @Override
089    public ContentCategoryDescription getEntity(EditContentCategoryDescriptionResult result) {
090        var contentControl = Session.getModelController(ContentControl.class);
091        ContentCategoryDescription contentCategoryDescription = null;
092        var contentCollectionName = spec.getContentCollectionName();
093        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
094        
095        if(contentCollection != null) {
096            var contentCatalogName = spec.getContentCatalogName();
097            var contentCatalog = contentControl.getContentCatalogByName(contentCollection, contentCatalogName);
098            
099            if(contentCatalog != null) {
100                var contentCategoryName = spec.getContentCategoryName();
101                var contentCategory = contentControl.getContentCategoryByName(contentCatalog, contentCategoryName);
102                
103                if(contentCategory != null) {
104                    var partyControl = Session.getModelController(PartyControl.class);
105                    var languageIsoName = spec.getLanguageIsoName();
106                    var language = partyControl.getLanguageByIsoName(languageIsoName);
107                    
108                    result.setContentCategory(contentControl.getContentCategoryTransfer(getUserVisit(), contentCategory));
109                    
110                    if(language != null) {
111                        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
112                            contentCategoryDescription = contentControl.getContentCategoryDescription(contentCategory, language);
113                        } else { // EditMode.UPDATE
114                            contentCategoryDescription = contentControl.getContentCategoryDescriptionForUpdate(contentCategory, language);
115                        }
116
117                        if(contentCategoryDescription == null) {
118                            addExecutionError(ExecutionErrors.UnknownContentCategoryDescription.name());
119                        }
120                    } else {
121                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
122                    }
123                } else {
124                    addExecutionError(ExecutionErrors.UnknownContentCategoryName.name(), contentCategoryName);
125                }
126            } else {
127                addExecutionError(ExecutionErrors.UnknownContentCatalogName.name(), contentCatalogName);
128            }
129        } else {
130            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
131        }
132
133        return contentCategoryDescription;
134    }
135    
136    @Override
137    public ContentCategory getLockEntity(ContentCategoryDescription contentCategoryDescription) {
138        return contentCategoryDescription.getContentCategory();
139    }
140    
141    @Override
142    public void fillInResult(EditContentCategoryDescriptionResult result, ContentCategoryDescription contentCategoryDescription) {
143        var contentControl = Session.getModelController(ContentControl.class);
144        
145        result.setContentCategoryDescription(contentControl.getContentCategoryDescriptionTransfer(getUserVisit(), contentCategoryDescription));
146    }
147    
148    @Override
149    public void doLock(ContentCategoryDescriptionEdit edit, ContentCategoryDescription contentCategoryDescription) {
150        edit.setDescription(contentCategoryDescription.getDescription());
151    }
152    
153    @Override
154    public void doUpdate(ContentCategoryDescription contentCategoryDescription) {
155        var contentControl = Session.getModelController(ContentControl.class);
156        var contentCategoryDescriptionValue = contentControl.getContentCategoryDescriptionValue(contentCategoryDescription);
157        contentCategoryDescriptionValue.setDescription(edit.getDescription());
158
159        contentControl.updateContentCategoryDescriptionFromValue(contentCategoryDescriptionValue, getPartyPK());
160    }
161    
162}