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.contactlist.server.command;
018
019import com.echothree.control.user.contactlist.common.edit.ContactListDescriptionEdit;
020import com.echothree.control.user.contactlist.common.edit.ContactListEditFactory;
021import com.echothree.control.user.contactlist.common.form.EditContactListDescriptionForm;
022import com.echothree.control.user.contactlist.common.result.ContactListResultFactory;
023import com.echothree.control.user.contactlist.common.result.EditContactListDescriptionResult;
024import com.echothree.control.user.contactlist.common.spec.ContactListDescriptionSpec;
025import com.echothree.model.control.contactlist.server.ContactListControl;
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.contactlist.server.entity.ContactList;
031import com.echothree.model.data.contactlist.server.entity.ContactListDescription;
032import com.echothree.model.data.contactlist.server.value.ContactListDescriptionValue;
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 EditContactListDescriptionCommand
049        extends BaseAbstractEditCommand<ContactListDescriptionSpec, ContactListDescriptionEdit, EditContactListDescriptionResult, ContactListDescription, ContactList> {
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.ContactList.name(), SecurityRoles.Description.name())
060                        )))
061                )));
062
063        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("ContactListName", 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 EditContactListDescriptionCommand */
074    public EditContactListDescriptionCommand(UserVisitPK userVisitPK, EditContactListDescriptionForm form) {
075        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077
078    @Override
079    public EditContactListDescriptionResult getResult() {
080        return ContactListResultFactory.getEditContactListDescriptionResult();
081    }
082
083    @Override
084    public ContactListDescriptionEdit getEdit() {
085        return ContactListEditFactory.getContactListDescriptionEdit();
086    }
087
088    @Override
089    public ContactListDescription getEntity(EditContactListDescriptionResult result) {
090        var contactListControl = Session.getModelController(ContactListControl.class);
091        ContactListDescription contactListDescription = null;
092        String contactListName = spec.getContactListName();
093        ContactList contactList = contactListControl.getContactListByName(contactListName);
094
095        if(contactList != null) {
096            var partyControl = Session.getModelController(PartyControl.class);
097            String languageIsoName = spec.getLanguageIsoName();
098            Language language = partyControl.getLanguageByIsoName(languageIsoName);
099
100            if(language != null) {
101                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
102                    contactListDescription = contactListControl.getContactListDescription(contactList, language);
103                } else { // EditMode.UPDATE
104                    contactListDescription = contactListControl.getContactListDescriptionForUpdate(contactList, language);
105                }
106
107                if(contactListDescription == null) {
108                    addExecutionError(ExecutionErrors.UnknownContactListDescription.name(), contactListName, languageIsoName);
109                }
110            } else {
111                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
112            }
113        } else {
114            addExecutionError(ExecutionErrors.UnknownContactListName.name(), contactListName);
115        }
116
117        return contactListDescription;
118    }
119
120    @Override
121    public ContactList getLockEntity(ContactListDescription contactListDescription) {
122        return contactListDescription.getContactList();
123    }
124
125    @Override
126    public void fillInResult(EditContactListDescriptionResult result, ContactListDescription contactListDescription) {
127        var contactListControl = Session.getModelController(ContactListControl.class);
128
129        result.setContactListDescription(contactListControl.getContactListDescriptionTransfer(getUserVisit(), contactListDescription));
130    }
131
132    @Override
133    public void doLock(ContactListDescriptionEdit edit, ContactListDescription contactListDescription) {
134        edit.setDescription(contactListDescription.getDescription());
135    }
136
137    @Override
138    public void doUpdate(ContactListDescription contactListDescription) {
139        var contactListControl = Session.getModelController(ContactListControl.class);
140        ContactListDescriptionValue contactListDescriptionValue = contactListControl.getContactListDescriptionValue(contactListDescription);
141
142        contactListDescriptionValue.setDescription(edit.getDescription());
143
144        contactListControl.updateContactListDescriptionFromValue(contactListDescriptionValue, getPartyPK());
145    }
146
147}