001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.Arrays;
043import java.util.Collections;
044import java.util.List;
045import javax.enterprise.context.RequestScoped;
046
047@RequestScoped
048public class EditContentCatalogDescriptionCommand
049        extends BaseAbstractEditCommand<ContentCatalogDescriptionSpec, ContentCatalogDescriptionEdit, EditContentCatalogDescriptionResult, ContentCatalogDescription, ContentCatalog> {
050    
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
053    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
054    
055    static {
056        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
059                        new SecurityRoleDefinition(SecurityRoleGroups.ContentCatalog.name(), SecurityRoles.Description.name())
060                        )))
061                )));
062        
063        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("ContentCollectionName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("ContentCatalogName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
067                ));
068        
069        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
070                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
071                ));
072    }
073    
074    /** Creates a new instance of EditContentCatalogDescriptionCommand */
075    public EditContentCatalogDescriptionCommand() {
076        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078    
079    @Override
080    public EditContentCatalogDescriptionResult getResult() {
081        return ContentResultFactory.getEditContentCatalogDescriptionResult();
082    }
083    
084    @Override
085    public ContentCatalogDescriptionEdit getEdit() {
086        return ContentEditFactory.getContentCatalogDescriptionEdit();
087    }
088    
089    @Override
090    public ContentCatalogDescription getEntity(EditContentCatalogDescriptionResult result) {
091        var contentControl = Session.getModelController(ContentControl.class);
092        ContentCatalogDescription contentCatalogDescription = null;
093        var contentCollectionName = spec.getContentCollectionName();
094        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
095        
096        if(contentCollection != null) {
097            var contentCatalogName = spec.getContentCatalogName();
098            var contentCatalog = contentControl.getContentCatalogByName(contentCollection, contentCatalogName);
099            
100            if(contentCatalog != null) {
101                var partyControl = Session.getModelController(PartyControl.class);
102                var languageIsoName = spec.getLanguageIsoName();
103                var language = partyControl.getLanguageByIsoName(languageIsoName);
104
105                result.setContentCatalog(contentControl.getContentCatalogTransfer(getUserVisit(), contentCatalog));
106
107                if(language != null) {
108                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
109                        contentCatalogDescription = contentControl.getContentCatalogDescription(contentCatalog, language);
110                    } else { // EditMode.UPDATE
111                        contentCatalogDescription = contentControl.getContentCatalogDescriptionForUpdate(contentCatalog, language);
112                    }
113
114                    if(contentCatalogDescription == null) {
115                        addExecutionError(ExecutionErrors.UnknownContentCatalogDescription.name());
116                    }
117                } else {
118                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
119                }
120            } else {
121                addExecutionError(ExecutionErrors.UnknownContentCatalogName.name(), contentCatalogName);
122            }
123        } else {
124            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
125        }
126
127        return contentCatalogDescription;
128    }
129    
130    @Override
131    public ContentCatalog getLockEntity(ContentCatalogDescription contentCatalogDescription) {
132        return contentCatalogDescription.getContentCatalog();
133    }
134    
135    @Override
136    public void fillInResult(EditContentCatalogDescriptionResult result, ContentCatalogDescription contentCatalogDescription) {
137        var contentControl = Session.getModelController(ContentControl.class);
138        
139        result.setContentCatalogDescription(contentControl.getContentCatalogDescriptionTransfer(getUserVisit(), contentCatalogDescription));
140    }
141    
142    @Override
143    public void doLock(ContentCatalogDescriptionEdit edit, ContentCatalogDescription contentCatalogDescription) {
144        edit.setDescription(contentCatalogDescription.getDescription());
145    }
146    
147    @Override
148    public void doUpdate(ContentCatalogDescription contentCatalogDescription) {
149        var contentControl = Session.getModelController(ContentControl.class);
150        var contentCatalogDescriptionValue = contentControl.getContentCatalogDescriptionValue(contentCatalogDescription);
151        contentCatalogDescriptionValue.setDescription(edit.getDescription());
152
153        contentControl.updateContentCatalogDescriptionFromValue(contentCatalogDescriptionValue, getPartyPK());
154    }
155    
156}