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.ContentCatalogDescriptionEdit;
020import com.echothree.control.user.content.common.edit.ContentEditFactory;
021import com.echothree.control.user.content.common.form.EditContentCatalogDescriptionForm;
022import com.echothree.control.user.content.common.result.ContentResultFactory;
023import com.echothree.control.user.content.common.result.EditContentCatalogDescriptionResult;
024import com.echothree.control.user.content.common.spec.ContentCatalogDescriptionSpec;
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.ContentCatalog;
031import com.echothree.model.data.content.server.entity.ContentCatalogDescription;
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 EditContentCatalogDescriptionCommand
047        extends BaseAbstractEditCommand<ContentCatalogDescriptionSpec, ContentCatalogDescriptionEdit, EditContentCatalogDescriptionResult, ContentCatalogDescription, ContentCatalog> {
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.ContentCatalog.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("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    /** Creates a new instance of EditContentCatalogDescriptionCommand */
073    public EditContentCatalogDescriptionCommand() {
074        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
075    }
076    
077    @Override
078    public EditContentCatalogDescriptionResult getResult() {
079        return ContentResultFactory.getEditContentCatalogDescriptionResult();
080    }
081    
082    @Override
083    public ContentCatalogDescriptionEdit getEdit() {
084        return ContentEditFactory.getContentCatalogDescriptionEdit();
085    }
086    
087    @Override
088    public ContentCatalogDescription getEntity(EditContentCatalogDescriptionResult result) {
089        var contentControl = Session.getModelController(ContentControl.class);
090        ContentCatalogDescription contentCatalogDescription = null;
091        var contentCollectionName = spec.getContentCollectionName();
092        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
093        
094        if(contentCollection != null) {
095            var contentCatalogName = spec.getContentCatalogName();
096            var contentCatalog = contentControl.getContentCatalogByName(contentCollection, contentCatalogName);
097            
098            if(contentCatalog != null) {
099                var partyControl = Session.getModelController(PartyControl.class);
100                var languageIsoName = spec.getLanguageIsoName();
101                var language = partyControl.getLanguageByIsoName(languageIsoName);
102
103                result.setContentCatalog(contentControl.getContentCatalogTransfer(getUserVisit(), contentCatalog));
104
105                if(language != null) {
106                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
107                        contentCatalogDescription = contentControl.getContentCatalogDescription(contentCatalog, language);
108                    } else { // EditMode.UPDATE
109                        contentCatalogDescription = contentControl.getContentCatalogDescriptionForUpdate(contentCatalog, language);
110                    }
111
112                    if(contentCatalogDescription == null) {
113                        addExecutionError(ExecutionErrors.UnknownContentCatalogDescription.name());
114                    }
115                } else {
116                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
117                }
118            } else {
119                addExecutionError(ExecutionErrors.UnknownContentCatalogName.name(), contentCatalogName);
120            }
121        } else {
122            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
123        }
124
125        return contentCatalogDescription;
126    }
127    
128    @Override
129    public ContentCatalog getLockEntity(ContentCatalogDescription contentCatalogDescription) {
130        return contentCatalogDescription.getContentCatalog();
131    }
132    
133    @Override
134    public void fillInResult(EditContentCatalogDescriptionResult result, ContentCatalogDescription contentCatalogDescription) {
135        var contentControl = Session.getModelController(ContentControl.class);
136        
137        result.setContentCatalogDescription(contentControl.getContentCatalogDescriptionTransfer(getUserVisit(), contentCatalogDescription));
138    }
139    
140    @Override
141    public void doLock(ContentCatalogDescriptionEdit edit, ContentCatalogDescription contentCatalogDescription) {
142        edit.setDescription(contentCatalogDescription.getDescription());
143    }
144    
145    @Override
146    public void doUpdate(ContentCatalogDescription contentCatalogDescription) {
147        var contentControl = Session.getModelController(ContentControl.class);
148        var contentCatalogDescriptionValue = contentControl.getContentCatalogDescriptionValue(contentCatalogDescription);
149        contentCatalogDescriptionValue.setDescription(edit.getDescription());
150
151        contentControl.updateContentCatalogDescriptionFromValue(contentCatalogDescriptionValue, getPartyPK());
152    }
153    
154}