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.workrequirement.common;
018
019import com.echothree.control.user.workrequirement.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface WorkRequirementService
024        extends WorkRequirementForms {
025    
026    // -------------------------------------------------------------------------
027    //   Work Requirement Types
028    // -------------------------------------------------------------------------
029    
030    CommandResult createWorkRequirementType(UserVisitPK userVisitPK, CreateWorkRequirementTypeForm form);
031    
032    CommandResult getWorkRequirementTypes(UserVisitPK userVisitPK, GetWorkRequirementTypesForm form);
033    
034    CommandResult getWorkRequirementType(UserVisitPK userVisitPK, GetWorkRequirementTypeForm form);
035    
036    CommandResult deleteWorkRequirementType(UserVisitPK userVisitPK, DeleteWorkRequirementTypeForm form);
037    
038    // -------------------------------------------------------------------------
039    //   Work Requirement Type Descriptions
040    // -------------------------------------------------------------------------
041    
042    CommandResult createWorkRequirementTypeDescription(UserVisitPK userVisitPK, CreateWorkRequirementTypeDescriptionForm form);
043    
044    CommandResult getWorkRequirementTypeDescriptions(UserVisitPK userVisitPK, GetWorkRequirementTypeDescriptionsForm form);
045    
046    CommandResult editWorkRequirementTypeDescription(UserVisitPK userVisitPK, EditWorkRequirementTypeDescriptionForm form);
047    
048    CommandResult deleteWorkRequirementTypeDescription(UserVisitPK userVisitPK, DeleteWorkRequirementTypeDescriptionForm form);
049    
050    // -------------------------------------------------------------------------
051    //   Work Requirement Scopes
052    // -------------------------------------------------------------------------
053    
054    CommandResult getWorkRequirementScopes(UserVisitPK userVisitPK, GetWorkRequirementScopesForm form);
055    
056    CommandResult getWorkRequirementScope(UserVisitPK userVisitPK, GetWorkRequirementScopeForm form);
057    
058    // -------------------------------------------------------------------------
059    //   Work Requirements
060    // -------------------------------------------------------------------------
061    
062    CommandResult getWorkRequirement(UserVisitPK userVisitPK, GetWorkRequirementForm form);
063    
064    // -------------------------------------------------------------------------
065    //   Work Assignments
066    // -------------------------------------------------------------------------
067
068    public CommandResult getWorkAssignments(UserVisitPK userVisitPK, GetWorkAssignmentsForm form);
069
070    // -------------------------------------------------------------------------
071    //   Testing
072    // -------------------------------------------------------------------------
073    
074    String ping();
075    
076}