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