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.printer.common;
018
019import com.echothree.control.user.printer.common.form.*;
020import com.echothree.control.user.printer.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 PrinterService
026        extends PrinterForms {
027    
028    // -------------------------------------------------------------------------
029    //   Testing
030    // -------------------------------------------------------------------------
031    
032    String ping();
033    
034    // -------------------------------------------------------------------------
035    //   Printer Groups
036    // -------------------------------------------------------------------------
037    
038    CommandResult<VoidResult> createPrinterGroup(UserVisitPK userVisitPK, CreatePrinterGroupForm form);
039    
040    CommandResult<GetPrinterGroupChoicesResult> getPrinterGroupChoices(UserVisitPK userVisitPK, GetPrinterGroupChoicesForm form);
041
042    CommandResult<GetPrinterGroupResult> getPrinterGroup(UserVisitPK userVisitPK, GetPrinterGroupForm form);
043
044    CommandResult<GetPrinterGroupsResult> getPrinterGroups(UserVisitPK userVisitPK, GetPrinterGroupsForm form);
045    
046    CommandResult<VoidResult> setDefaultPrinterGroup(UserVisitPK userVisitPK, SetDefaultPrinterGroupForm form);
047    
048    CommandResult<EditPrinterGroupResult> editPrinterGroup(UserVisitPK userVisitPK, EditPrinterGroupForm form);
049    
050    CommandResult<GetPrinterGroupStatusChoicesResult> getPrinterGroupStatusChoices(UserVisitPK userVisitPK, GetPrinterGroupStatusChoicesForm form);
051    
052    CommandResult<VoidResult> setPrinterGroupStatus(UserVisitPK userVisitPK, SetPrinterGroupStatusForm form);
053    
054    CommandResult<VoidResult> deletePrinterGroup(UserVisitPK userVisitPK, DeletePrinterGroupForm form);
055    
056    // -------------------------------------------------------------------------
057    //   Printer Group Descriptions
058    // -------------------------------------------------------------------------
059    
060    CommandResult<VoidResult> createPrinterGroupDescription(UserVisitPK userVisitPK, CreatePrinterGroupDescriptionForm form);
061    
062    CommandResult<GetPrinterGroupDescriptionResult> getPrinterGroupDescription(UserVisitPK userVisitPK, GetPrinterGroupDescriptionForm form);
063
064    CommandResult<GetPrinterGroupDescriptionsResult> getPrinterGroupDescriptions(UserVisitPK userVisitPK, GetPrinterGroupDescriptionsForm form);
065
066    CommandResult<EditPrinterGroupDescriptionResult> editPrinterGroupDescription(UserVisitPK userVisitPK, EditPrinterGroupDescriptionForm form);
067    
068    CommandResult<VoidResult> deletePrinterGroupDescription(UserVisitPK userVisitPK, DeletePrinterGroupDescriptionForm form);
069    
070    // -------------------------------------------------------------------------
071    //   Printers
072    // -------------------------------------------------------------------------
073    
074    CommandResult<VoidResult> createPrinter(UserVisitPK userVisitPK, CreatePrinterForm form);
075
076    CommandResult<GetPrinterResult> getPrinter(UserVisitPK userVisitPK, GetPrinterForm form);
077
078    CommandResult<GetPrintersResult> getPrinters(UserVisitPK userVisitPK, GetPrintersForm form);
079    
080    CommandResult<EditPrinterResult> editPrinter(UserVisitPK userVisitPK, EditPrinterForm form);
081    
082    CommandResult<GetPrinterStatusChoicesResult> getPrinterStatusChoices(UserVisitPK userVisitPK, GetPrinterStatusChoicesForm form);
083    
084    CommandResult<VoidResult> setPrinterStatus(UserVisitPK userVisitPK, SetPrinterStatusForm form);
085    
086    CommandResult<VoidResult> deletePrinter(UserVisitPK userVisitPK, DeletePrinterForm form);
087    
088    // -------------------------------------------------------------------------
089    //   Printer Descriptions
090    // -------------------------------------------------------------------------
091    
092    CommandResult<VoidResult> createPrinterDescription(UserVisitPK userVisitPK, CreatePrinterDescriptionForm form);
093    
094    CommandResult<GetPrinterDescriptionResult> getPrinterDescription(UserVisitPK userVisitPK, GetPrinterDescriptionForm form);
095
096    CommandResult<GetPrinterDescriptionsResult> getPrinterDescriptions(UserVisitPK userVisitPK, GetPrinterDescriptionsForm form);
097
098    CommandResult<EditPrinterDescriptionResult> editPrinterDescription(UserVisitPK userVisitPK, EditPrinterDescriptionForm form);
099    
100    CommandResult<VoidResult> deletePrinterDescription(UserVisitPK userVisitPK, DeletePrinterDescriptionForm form);
101    
102    // -------------------------------------------------------------------------
103    //   Printer Group Jobs
104    // -------------------------------------------------------------------------
105    
106    CommandResult<CreatePrinterGroupJobResult> createPrinterGroupJob(UserVisitPK userVisitPK, CreatePrinterGroupJobForm form);
107
108    CommandResult<GetPrinterGroupJobResult> getPrinterGroupJob(UserVisitPK userVisitPK, GetPrinterGroupJobForm form);
109
110    CommandResult<GetPrinterGroupJobsResult> getPrinterGroupJobs(UserVisitPK userVisitPK, GetPrinterGroupJobsForm form);
111
112    CommandResult<GetPrinterGroupJobStatusChoicesResult> getPrinterGroupJobStatusChoices(UserVisitPK userVisitPK, GetPrinterGroupJobStatusChoicesForm form);
113
114    CommandResult<VoidResult> setPrinterGroupJobStatus(UserVisitPK userVisitPK, SetPrinterGroupJobStatusForm form);
115
116    CommandResult<VoidResult> deletePrinterGroupJob(UserVisitPK userVisitPK, DeletePrinterGroupJobForm form);
117    
118    // -------------------------------------------------------------------------
119    //   Printer Group Use Types
120    // -------------------------------------------------------------------------
121
122    CommandResult<VoidResult> createPrinterGroupUseType(UserVisitPK userVisitPK, CreatePrinterGroupUseTypeForm form);
123
124    CommandResult<GetPrinterGroupUseTypeChoicesResult> getPrinterGroupUseTypeChoices(UserVisitPK userVisitPK, GetPrinterGroupUseTypeChoicesForm form);
125
126    CommandResult<GetPrinterGroupUseTypeResult> getPrinterGroupUseType(UserVisitPK userVisitPK, GetPrinterGroupUseTypeForm form);
127
128    CommandResult<GetPrinterGroupUseTypesResult> getPrinterGroupUseTypes(UserVisitPK userVisitPK, GetPrinterGroupUseTypesForm form);
129
130    CommandResult<VoidResult> setDefaultPrinterGroupUseType(UserVisitPK userVisitPK, SetDefaultPrinterGroupUseTypeForm form);
131
132    CommandResult<EditPrinterGroupUseTypeResult> editPrinterGroupUseType(UserVisitPK userVisitPK, EditPrinterGroupUseTypeForm form);
133
134    CommandResult<VoidResult> deletePrinterGroupUseType(UserVisitPK userVisitPK, DeletePrinterGroupUseTypeForm form);
135
136    // -------------------------------------------------------------------------
137    //   Printer Group Use Type Descriptions
138    // -------------------------------------------------------------------------
139
140    CommandResult<VoidResult> createPrinterGroupUseTypeDescription(UserVisitPK userVisitPK, CreatePrinterGroupUseTypeDescriptionForm form);
141
142    CommandResult<GetPrinterGroupUseTypeDescriptionResult> getPrinterGroupUseTypeDescription(UserVisitPK userVisitPK, GetPrinterGroupUseTypeDescriptionForm form);
143
144    CommandResult<GetPrinterGroupUseTypeDescriptionsResult> getPrinterGroupUseTypeDescriptions(UserVisitPK userVisitPK, GetPrinterGroupUseTypeDescriptionsForm form);
145
146    CommandResult<EditPrinterGroupUseTypeDescriptionResult> editPrinterGroupUseTypeDescription(UserVisitPK userVisitPK, EditPrinterGroupUseTypeDescriptionForm form);
147
148    CommandResult<VoidResult> deletePrinterGroupUseTypeDescription(UserVisitPK userVisitPK, DeletePrinterGroupUseTypeDescriptionForm form);
149
150    // -------------------------------------------------------------------------
151    //   Party Printer Group Uses
152    // -------------------------------------------------------------------------
153
154    CommandResult<VoidResult> createPartyPrinterGroupUse(UserVisitPK userVisitPK, CreatePartyPrinterGroupUseForm form);
155
156    CommandResult<GetPartyPrinterGroupUseResult> getPartyPrinterGroupUse(UserVisitPK userVisitPK, GetPartyPrinterGroupUseForm form);
157
158    CommandResult<GetPartyPrinterGroupUsesResult> getPartyPrinterGroupUses(UserVisitPK userVisitPK, GetPartyPrinterGroupUsesForm form);
159
160    CommandResult<EditPartyPrinterGroupUseResult> editPartyPrinterGroupUse(UserVisitPK userVisitPK, EditPartyPrinterGroupUseForm form);
161
162    CommandResult<VoidResult> deletePartyPrinterGroupUse(UserVisitPK userVisitPK, DeletePartyPrinterGroupUseForm form);
163
164}