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.ContentCollectionDescriptionEdit;
020import com.echothree.control.user.content.common.edit.ContentEditFactory;
021import com.echothree.control.user.content.common.form.EditContentCollectionDescriptionForm;
022import com.echothree.control.user.content.common.result.ContentResultFactory;
023import com.echothree.control.user.content.common.result.EditContentCollectionDescriptionResult;
024import com.echothree.control.user.content.common.spec.ContentCollectionDescriptionSpec;
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.ContentCollection;
031import com.echothree.model.data.content.server.entity.ContentCollectionDescription;
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 EditContentCollectionDescriptionCommand
047        extends BaseAbstractEditCommand<ContentCollectionDescriptionSpec, ContentCollectionDescriptionEdit, EditContentCollectionDescriptionResult, ContentCollectionDescription, ContentCollection> {
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.ContentCollection.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("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
064                );
065        
066        EDIT_FIELD_DEFINITIONS = List.of(
067                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
068                );
069    }
070    
071    /** Creates a new instance of EditContentCollectionDescriptionCommand */
072    public EditContentCollectionDescriptionCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075    
076    @Override
077    public EditContentCollectionDescriptionResult getResult() {
078        return ContentResultFactory.getEditContentCollectionDescriptionResult();
079    }
080    
081    @Override
082    public ContentCollectionDescriptionEdit getEdit() {
083        return ContentEditFactory.getContentCollectionDescriptionEdit();
084    }
085    
086    @Override
087    public ContentCollectionDescription getEntity(EditContentCollectionDescriptionResult result) {
088        var contentControl = Session.getModelController(ContentControl.class);
089        ContentCollectionDescription contentCollectionDescription = null;
090        var contentCollectionName = spec.getContentCollectionName();
091        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
092        
093        if(contentCollection != null) {
094            var partyControl = Session.getModelController(PartyControl.class);
095            var languageIsoName = spec.getLanguageIsoName();
096            var language = partyControl.getLanguageByIsoName(languageIsoName);
097
098            result.setContentCollection(contentControl.getContentCollectionTransfer(getUserVisit(), contentCollection));
099
100            if(language != null) {
101                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
102                    contentCollectionDescription = contentControl.getContentCollectionDescription(contentCollection, language);
103                } else { // EditMode.UPDATE
104                    contentCollectionDescription = contentControl.getContentCollectionDescriptionForUpdate(contentCollection, language);
105                }
106
107                if(contentCollectionDescription == null) {
108                    addExecutionError(ExecutionErrors.UnknownContentCollectionDescription.name());
109                }
110            } else {
111                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
112            }
113        } else {
114            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
115        }
116
117        return contentCollectionDescription;
118    }
119    
120    @Override
121    public ContentCollection getLockEntity(ContentCollectionDescription contentCollectionDescription) {
122        return contentCollectionDescription.getContentCollection();
123    }
124    
125    @Override
126    public void fillInResult(EditContentCollectionDescriptionResult result, ContentCollectionDescription contentCollectionDescription) {
127        var contentControl = Session.getModelController(ContentControl.class);
128        
129        result.setContentCollectionDescription(contentControl.getContentCollectionDescriptionTransfer(getUserVisit(), contentCollectionDescription));
130    }
131    
132    @Override
133    public void doLock(ContentCollectionDescriptionEdit edit, ContentCollectionDescription contentCollectionDescription) {
134        edit.setDescription(contentCollectionDescription.getDescription());
135    }
136    
137    @Override
138    public void doUpdate(ContentCollectionDescription contentCollectionDescription) {
139        var contentControl = Session.getModelController(ContentControl.class);
140        var contentCollectionDescriptionValue = contentControl.getContentCollectionDescriptionValue(contentCollectionDescription);
141        contentCollectionDescriptionValue.setDescription(edit.getDescription());
142
143        contentControl.updateContentCollectionDescriptionFromValue(contentCollectionDescriptionValue, getPartyPK());
144    }
145    
146}