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.workeffort.common;
018
019import com.echothree.control.user.workeffort.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface WorkEffortService
024        extends WorkEffortForms {
025    
026    // -------------------------------------------------------------------------
027    //   Work Effort Types
028    // -------------------------------------------------------------------------
029    
030    CommandResult createWorkEffortType(UserVisitPK userVisitPK, CreateWorkEffortTypeForm form);
031    
032    CommandResult getWorkEffortTypes(UserVisitPK userVisitPK, GetWorkEffortTypesForm form);
033    
034    CommandResult getWorkEffortType(UserVisitPK userVisitPK, GetWorkEffortTypeForm form);
035    
036    CommandResult deleteWorkEffortType(UserVisitPK userVisitPK, DeleteWorkEffortTypeForm form);
037    
038    // -------------------------------------------------------------------------
039    //   Work Effort Type Descriptions
040    // -------------------------------------------------------------------------
041
042    CommandResult createWorkEffortTypeDescription(UserVisitPK userVisitPK, CreateWorkEffortTypeDescriptionForm form);
043
044    CommandResult getWorkEffortTypeDescriptions(UserVisitPK userVisitPK, GetWorkEffortTypeDescriptionsForm form);
045
046    CommandResult editWorkEffortTypeDescription(UserVisitPK userVisitPK, EditWorkEffortTypeDescriptionForm form);
047
048    CommandResult deleteWorkEffortTypeDescription(UserVisitPK userVisitPK, DeleteWorkEffortTypeDescriptionForm form);
049
050    // -------------------------------------------------------------------------
051    //   Work Effort Scopes
052    // -------------------------------------------------------------------------
053    
054    CommandResult createWorkEffortScope(UserVisitPK userVisitPK, CreateWorkEffortScopeForm form);
055    
056    CommandResult getWorkEffortScopes(UserVisitPK userVisitPK, GetWorkEffortScopesForm form);
057    
058    CommandResult getWorkEffortScope(UserVisitPK userVisitPK, GetWorkEffortScopeForm form);
059    
060    CommandResult getWorkEffortScopeChoices(UserVisitPK userVisitPK, GetWorkEffortScopeChoicesForm form);
061    
062    CommandResult setDefaultWorkEffortScope(UserVisitPK userVisitPK, SetDefaultWorkEffortScopeForm form);
063    
064    CommandResult editWorkEffortScope(UserVisitPK userVisitPK, EditWorkEffortScopeForm form);
065
066    CommandResult deleteWorkEffortScope(UserVisitPK userVisitPK, DeleteWorkEffortScopeForm form);
067
068    // -------------------------------------------------------------------------
069    //   Work Effort Scope Descriptions
070    // -------------------------------------------------------------------------
071    
072    CommandResult createWorkEffortScopeDescription(UserVisitPK userVisitPK, CreateWorkEffortScopeDescriptionForm form);
073    
074    CommandResult getWorkEffortScopeDescription(UserVisitPK userVisitPK, GetWorkEffortScopeDescriptionForm form);
075
076    CommandResult getWorkEffortScopeDescriptions(UserVisitPK userVisitPK, GetWorkEffortScopeDescriptionsForm form);
077
078    CommandResult editWorkEffortScopeDescription(UserVisitPK userVisitPK, EditWorkEffortScopeDescriptionForm form);
079    
080    CommandResult deleteWorkEffortScopeDescription(UserVisitPK userVisitPK, DeleteWorkEffortScopeDescriptionForm form);
081    
082    // -------------------------------------------------------------------------
083    //   Work Effort
084    // -------------------------------------------------------------------------
085    
086    CommandResult getWorkEffort(UserVisitPK userVisitPK, GetWorkEffortForm form);
087    
088    // -------------------------------------------------------------------------
089    //   Testing
090    // -------------------------------------------------------------------------
091    
092    String ping();
093        
094}