001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.content.server.value.ContentCollectionDescriptionValue;
033import com.echothree.model.data.party.server.entity.Language;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.EditMode;
039import com.echothree.util.server.control.BaseAbstractEditCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import com.echothree.util.server.persistence.Session;
044import java.util.Arrays;
045import java.util.Collections;
046import java.util.List;
047
048public class EditContentCollectionDescriptionCommand
049        extends BaseAbstractEditCommand<ContentCollectionDescriptionSpec, ContentCollectionDescriptionEdit, EditContentCollectionDescriptionResult, ContentCollectionDescription, ContentCollection> {
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.ContentCollection.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("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
066                ));
067        
068        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
069                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
070                ));
071    }
072    
073    /** Creates a new instance of EditContentCollectionDescriptionCommand */
074    public EditContentCollectionDescriptionCommand(UserVisitPK userVisitPK, EditContentCollectionDescriptionForm form) {
075        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077    
078    @Override
079    public EditContentCollectionDescriptionResult getResult() {
080        return ContentResultFactory.getEditContentCollectionDescriptionResult();
081    }
082    
083    @Override
084    public ContentCollectionDescriptionEdit getEdit() {
085        return ContentEditFactory.getContentCollectionDescriptionEdit();
086    }
087    
088    @Override
089    public ContentCollectionDescription getEntity(EditContentCollectionDescriptionResult result) {
090        var contentControl = Session.getModelController(ContentControl.class);
091        ContentCollectionDescription contentCollectionDescription = null;
092        String contentCollectionName = spec.getContentCollectionName();
093        ContentCollection contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
094        
095        if(contentCollection != null) {
096            var partyControl = Session.getModelController(PartyControl.class);
097            String languageIsoName = spec.getLanguageIsoName();
098            Language language = partyControl.getLanguageByIsoName(languageIsoName);
099
100            result.setContentCollection(contentControl.getContentCollectionTransfer(getUserVisit(), contentCollection));
101
102            if(language != null) {
103                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
104                    contentCollectionDescription = contentControl.getContentCollectionDescription(contentCollection, language);
105                } else { // EditMode.UPDATE
106                    contentCollectionDescription = contentControl.getContentCollectionDescriptionForUpdate(contentCollection, language);
107                }
108
109                if(contentCollectionDescription == null) {
110                    addExecutionError(ExecutionErrors.UnknownContentCollectionDescription.name());
111                }
112            } else {
113                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
114            }
115        } else {
116            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
117        }
118
119        return contentCollectionDescription;
120    }
121    
122    @Override
123    public ContentCollection getLockEntity(ContentCollectionDescription contentCollectionDescription) {
124        return contentCollectionDescription.getContentCollection();
125    }
126    
127    @Override
128    public void fillInResult(EditContentCollectionDescriptionResult result, ContentCollectionDescription contentCollectionDescription) {
129        var contentControl = Session.getModelController(ContentControl.class);
130        
131        result.setContentCollectionDescription(contentControl.getContentCollectionDescriptionTransfer(getUserVisit(), contentCollectionDescription));
132    }
133    
134    @Override
135    public void doLock(ContentCollectionDescriptionEdit edit, ContentCollectionDescription contentCollectionDescription) {
136        edit.setDescription(contentCollectionDescription.getDescription());
137    }
138    
139    @Override
140    public void doUpdate(ContentCollectionDescription contentCollectionDescription) {
141        var contentControl = Session.getModelController(ContentControl.class);
142        ContentCollectionDescriptionValue contentCollectionDescriptionValue = contentControl.getContentCollectionDescriptionValue(contentCollectionDescription);
143        contentCollectionDescriptionValue.setDescription(edit.getDescription());
144
145        contentControl.updateContentCollectionDescriptionFromValue(contentCollectionDescriptionValue, getPartyPK());
146    }
147    
148}