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