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 java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
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    @Inject
074    ContentControl contentControl;
075
076    @Inject
077    PartyControl partyControl;
078
079    
080    /** Creates a new instance of EditContentCategoryDescriptionCommand */
081    public EditContentCategoryDescriptionCommand() {
082        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
083    }
084    
085    @Override
086    public EditContentCategoryDescriptionResult getResult() {
087        return ContentResultFactory.getEditContentCategoryDescriptionResult();
088    }
089    
090    @Override
091    public ContentCategoryDescriptionEdit getEdit() {
092        return ContentEditFactory.getContentCategoryDescriptionEdit();
093    }
094    
095    @Override
096    public ContentCategoryDescription getEntity(EditContentCategoryDescriptionResult result) {
097        ContentCategoryDescription contentCategoryDescription = null;
098        var contentCollectionName = spec.getContentCollectionName();
099        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
100        
101        if(contentCollection != null) {
102            var contentCatalogName = spec.getContentCatalogName();
103            var contentCatalog = contentControl.getContentCatalogByName(contentCollection, contentCatalogName);
104            
105            if(contentCatalog != null) {
106                var contentCategoryName = spec.getContentCategoryName();
107                var contentCategory = contentControl.getContentCategoryByName(contentCatalog, contentCategoryName);
108                
109                if(contentCategory != null) {
110                    var languageIsoName = spec.getLanguageIsoName();
111                    var language = partyControl.getLanguageByIsoName(languageIsoName);
112                    
113                    result.setContentCategory(contentControl.getContentCategoryTransfer(getUserVisit(), contentCategory));
114                    
115                    if(language != null) {
116                        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
117                            contentCategoryDescription = contentControl.getContentCategoryDescription(contentCategory, language);
118                        } else { // EditMode.UPDATE
119                            contentCategoryDescription = contentControl.getContentCategoryDescriptionForUpdate(contentCategory, language);
120                        }
121
122                        if(contentCategoryDescription == null) {
123                            addExecutionError(ExecutionErrors.UnknownContentCategoryDescription.name());
124                        }
125                    } else {
126                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
127                    }
128                } else {
129                    addExecutionError(ExecutionErrors.UnknownContentCategoryName.name(), contentCategoryName);
130                }
131            } else {
132                addExecutionError(ExecutionErrors.UnknownContentCatalogName.name(), contentCatalogName);
133            }
134        } else {
135            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
136        }
137
138        return contentCategoryDescription;
139    }
140    
141    @Override
142    public ContentCategory getLockEntity(ContentCategoryDescription contentCategoryDescription) {
143        return contentCategoryDescription.getContentCategory();
144    }
145    
146    @Override
147    public void fillInResult(EditContentCategoryDescriptionResult result, ContentCategoryDescription contentCategoryDescription) {
148        result.setContentCategoryDescription(contentControl.getContentCategoryDescriptionTransfer(getUserVisit(), contentCategoryDescription));
149    }
150    
151    @Override
152    public void doLock(ContentCategoryDescriptionEdit edit, ContentCategoryDescription contentCategoryDescription) {
153        edit.setDescription(contentCategoryDescription.getDescription());
154    }
155    
156    @Override
157    public void doUpdate(ContentCategoryDescription contentCategoryDescription) {
158        var contentCategoryDescriptionValue = contentControl.getContentCategoryDescriptionValue(contentCategoryDescription);
159        contentCategoryDescriptionValue.setDescription(edit.getDescription());
160
161        contentControl.updateContentCategoryDescriptionFromValue(contentCategoryDescriptionValue, getPartyPK());
162    }
163    
164}