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.search.server.command;
018
019import com.echothree.control.user.search.common.edit.SearchEditFactory;
020import com.echothree.control.user.search.common.edit.SearchSortDirectionEdit;
021import com.echothree.control.user.search.common.form.EditSearchSortDirectionForm;
022import com.echothree.control.user.search.common.result.EditSearchSortDirectionResult;
023import com.echothree.control.user.search.common.result.SearchResultFactory;
024import com.echothree.control.user.search.common.spec.SearchSortDirectionSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.search.server.control.SearchControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.search.server.entity.SearchSortDirection;
030import com.echothree.model.data.search.server.entity.SearchSortDirectionDescription;
031import com.echothree.model.data.search.server.entity.SearchSortDirectionDetail;
032import com.echothree.model.data.search.server.value.SearchSortDirectionDescriptionValue;
033import com.echothree.model.data.search.server.value.SearchSortDirectionDetailValue;
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 EditSearchSortDirectionCommand
049        extends BaseAbstractEditCommand<SearchSortDirectionSpec, SearchSortDirectionEdit, EditSearchSortDirectionResult, SearchSortDirection, SearchSortDirection> {
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.SearchSortDirection.name(), SecurityRoles.Edit.name())
060                        )))
061                )));
062        
063        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("SearchSortDirectionName", FieldType.ENTITY_NAME, true, null, null)
065                ));
066        
067        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
068                new FieldDefinition("SearchSortDirectionName", FieldType.ENTITY_NAME, true, null, null),
069                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
070                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
071                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
072                ));
073    }
074    
075    /** Creates a new instance of EditSearchSortDirectionCommand */
076    public EditSearchSortDirectionCommand(UserVisitPK userVisitPK, EditSearchSortDirectionForm form) {
077        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    
080    @Override
081    public EditSearchSortDirectionResult getResult() {
082        return SearchResultFactory.getEditSearchSortDirectionResult();
083    }
084
085    @Override
086    public SearchSortDirectionEdit getEdit() {
087        return SearchEditFactory.getSearchSortDirectionEdit();
088    }
089
090    @Override
091    public SearchSortDirection getEntity(EditSearchSortDirectionResult result) {
092        var searchControl = Session.getModelController(SearchControl.class);
093        SearchSortDirection searchSortDirection;
094        String searchSortDirectionName = spec.getSearchSortDirectionName();
095
096        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
097            searchSortDirection = searchControl.getSearchSortDirectionByName(searchSortDirectionName);
098        } else { // EditMode.UPDATE
099            searchSortDirection = searchControl.getSearchSortDirectionByNameForUpdate(searchSortDirectionName);
100        }
101
102        if(searchSortDirection == null) {
103            addExecutionError(ExecutionErrors.UnknownSearchSortDirectionName.name(), searchSortDirectionName);
104        }
105
106        return searchSortDirection;
107    }
108
109    @Override
110    public SearchSortDirection getLockEntity(SearchSortDirection searchSortDirection) {
111        return searchSortDirection;
112    }
113
114    @Override
115    public void fillInResult(EditSearchSortDirectionResult result, SearchSortDirection searchSortDirection) {
116        var searchControl = Session.getModelController(SearchControl.class);
117
118        result.setSearchSortDirection(searchControl.getSearchSortDirectionTransfer(getUserVisit(), searchSortDirection));
119    }
120
121    @Override
122    public void doLock(SearchSortDirectionEdit edit, SearchSortDirection searchSortDirection) {
123        var searchControl = Session.getModelController(SearchControl.class);
124        SearchSortDirectionDescription searchSortDirectionDescription = searchControl.getSearchSortDirectionDescription(searchSortDirection, getPreferredLanguage());
125        SearchSortDirectionDetail searchSortDirectionDetail = searchSortDirection.getLastDetail();
126
127        edit.setSearchSortDirectionName(searchSortDirectionDetail.getSearchSortDirectionName());
128        edit.setIsDefault(searchSortDirectionDetail.getIsDefault().toString());
129        edit.setSortOrder(searchSortDirectionDetail.getSortOrder().toString());
130
131        if(searchSortDirectionDescription != null) {
132            edit.setDescription(searchSortDirectionDescription.getDescription());
133        }
134    }
135
136    @Override
137    public void canUpdate(SearchSortDirection searchSortDirection) {
138        var searchControl = Session.getModelController(SearchControl.class);
139        String searchSortDirectionName = edit.getSearchSortDirectionName();
140        SearchSortDirection duplicateSearchSortDirection = searchControl.getSearchSortDirectionByName(searchSortDirectionName);
141
142        if(duplicateSearchSortDirection != null && !searchSortDirection.equals(duplicateSearchSortDirection)) {
143            addExecutionError(ExecutionErrors.DuplicateSearchSortDirectionName.name(), searchSortDirectionName);
144        }
145    }
146
147    @Override
148    public void doUpdate(SearchSortDirection searchSortDirection) {
149        var searchControl = Session.getModelController(SearchControl.class);
150        var partyPK = getPartyPK();
151        SearchSortDirectionDetailValue searchSortDirectionDetailValue = searchControl.getSearchSortDirectionDetailValueForUpdate(searchSortDirection);
152        SearchSortDirectionDescription searchSortDirectionDescription = searchControl.getSearchSortDirectionDescriptionForUpdate(searchSortDirection, getPreferredLanguage());
153        String description = edit.getDescription();
154
155        searchSortDirectionDetailValue.setSearchSortDirectionName(edit.getSearchSortDirectionName());
156        searchSortDirectionDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
157        searchSortDirectionDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
158
159        searchControl.updateSearchSortDirectionFromValue(searchSortDirectionDetailValue, partyPK);
160
161        if(searchSortDirectionDescription == null && description != null) {
162            searchControl.createSearchSortDirectionDescription(searchSortDirection, getPreferredLanguage(), description, partyPK);
163        } else {
164            if(searchSortDirectionDescription != null && description == null) {
165                searchControl.deleteSearchSortDirectionDescription(searchSortDirectionDescription, partyPK);
166            } else {
167                if(searchSortDirectionDescription != null && description != null) {
168                    SearchSortDirectionDescriptionValue searchSortDirectionDescriptionValue = searchControl.getSearchSortDirectionDescriptionValue(searchSortDirectionDescription);
169
170                    searchSortDirectionDescriptionValue.setDescription(description);
171                    searchControl.updateSearchSortDirectionDescriptionFromValue(searchSortDirectionDescriptionValue, partyPK);
172                }
173            }
174        }
175    }
176    
177}