View Javadoc
1   /*
2    * Copyright 2006 The Kuali Foundation
3    * 
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    * http://www.opensource.org/licenses/ecl2.php
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.ole.module.purap.document;
17  
18  import org.kuali.ole.coa.businessobject.Account;
19  import org.kuali.ole.coa.businessobject.Chart;
20  import org.kuali.ole.coa.businessobject.Organization;
21  import org.kuali.ole.integration.purap.CapitalAssetSystem;
22  import org.kuali.ole.module.purap.businessobject.*;
23  import org.kuali.ole.module.purap.document.service.PurchasingDocumentSpecificService;
24  import org.kuali.ole.module.purap.util.ItemParser;
25  import org.kuali.ole.vnd.businessobject.CampusParameter;
26  import org.kuali.ole.vnd.businessobject.PurchaseOrderCostSource;
27  import org.kuali.ole.vnd.businessobject.VendorContract;
28  import org.kuali.ole.vnd.businessobject.VendorDetail;
29  import org.kuali.rice.core.api.util.type.KualiDecimal;
30  
31  import java.sql.Date;
32  import java.util.List;
33  
34  
35  /**
36   * Interface for Purchasing Documents.
37   */
38  public interface PurchasingDocument extends PurchasingAccountsPayableDocument {
39  
40      /**
41       * Gets the appropriate <code>{@link ItemParser}</code> for the <code>PurchasingDocument</code>
42       *
43       * @return an ItemParser instance
44       */
45      public ItemParser getItemParser();
46  
47      public String getDocumentFundingSourceCode();
48  
49      public void setDocumentFundingSourceCode(String fundingSourceCode);
50  
51      public String getRequisitionSourceCode();
52  
53      public void setRequisitionSourceCode(String requisitionSourceCode);
54  
55      public String getPurchaseOrderTransmissionMethodCode();
56  
57      public void setPurchaseOrderTransmissionMethodCode(String purchaseOrderTransmissionMethodCode);
58  
59      public String getPurchaseOrderCostSourceCode();
60  
61      public void setPurchaseOrderCostSourceCode(String purchaseOrderCostSourceCode);
62  
63      public String getDeliveryRequiredDateReasonCode();
64  
65      public void setDeliveryRequiredDateReasonCode(String deliveryRequiredDateReasonCode);
66  
67      public String getRecurringPaymentTypeCode();
68  
69      public void setRecurringPaymentTypeCode(String recurringPaymentTypeCode);
70  
71      public String getChartOfAccountsCode();
72  
73      public void setChartOfAccountsCode(String chartOfAccountsCode);
74  
75      public String getOrganizationCode();
76  
77      public void setOrganizationCode(String organizationCode);
78  
79      public String getDeliveryCampusCode();
80  
81      public void setDeliveryCampusCode(String deliveryCampusCode);
82  
83      public KualiDecimal getPurchaseOrderTotalLimit();
84  
85      public void setPurchaseOrderTotalLimit(KualiDecimal purchaseOrderTotalLimit);
86  
87      public String getVendorName();
88  
89      public void setVendorName(String vendorName);
90  
91      public String getVendorLine1Address();
92  
93      public void setVendorLine1Address(String vendorLine1Address);
94  
95      public String getVendorLine2Address();
96  
97      public void setVendorLine2Address(String vendorLine2Address);
98  
99      public String getVendorCityName();
100 
101     public void setVendorCityName(String vendorCityName);
102 
103     public String getVendorStateCode();
104 
105     public void setVendorStateCode(String vendorStateCode);
106 
107     public String getVendorPostalCode();
108 
109     public void setVendorPostalCode(String vendorPostalCode);
110 
111     public String getVendorCountryCode();
112 
113     public void setVendorCountryCode(String vendorCountryCode);
114 
115     public Boolean getVendorRestrictedIndicator();
116 
117     public void setVendorRestrictedIndicator(Boolean vendorRestrictedIndicator);
118 
119     public String getVendorPhoneNumber();
120 
121     public void setVendorPhoneNumber(String vendorPhoneNumber);
122 
123     public String getVendorFaxNumber();
124 
125     public void setVendorFaxNumber(String vendorFaxNumber);
126 
127     public Integer getVendorContractGeneratedIdentifier();
128 
129     public void setVendorContractGeneratedIdentifier(Integer vendorContractGeneratedIdentifier);
130 
131     public String getVendorNoteText();
132 
133     public void setVendorNoteText(String vendorNoteText);
134 
135     public String getRequestorPersonName();
136 
137     public void setRequestorPersonName(String requestorPersonName);
138 
139     public String getRequestorPersonEmailAddress();
140 
141     public void setRequestorPersonEmailAddress(String requestorPersonEmailAddress);
142 
143     public String getRequestorPersonPhoneNumber();
144 
145     public void setRequestorPersonPhoneNumber(String requestorPersonPhoneNumber);
146 
147     public String getNonInstitutionFundOrgChartOfAccountsCode();
148 
149     public void setNonInstitutionFundOrgChartOfAccountsCode(String nonInstitutionFundOrgChartOfAccountsCode);
150 
151     public String getNonInstitutionFundOrganizationCode();
152 
153     public void setNonInstitutionFundOrganizationCode(String nonInstitutionFundOrganizationCode);
154 
155     public String getNonInstitutionFundChartOfAccountsCode();
156 
157     public void setNonInstitutionFundChartOfAccountsCode(String nonInstitutionFundChartOfAccountsCode);
158 
159     public String getNonInstitutionFundAccountNumber();
160 
161     public void setNonInstitutionFundAccountNumber(String nonInstitutionFundAccountNumber);
162 
163     public String getDeliveryBuildingCode();
164 
165     public void setDeliveryBuildingCode(String deliveryBuildingCode);
166 
167     public String getDeliveryBuildingName();
168 
169     public void setDeliveryBuildingName(String deliveryBuildingName);
170 
171     public String getDeliveryBuildingRoomNumber();
172 
173     public void setDeliveryBuildingRoomNumber(String deliveryBuildingRoomNumber);
174 
175     public String getDeliveryBuildingLine1Address();
176 
177     public void setDeliveryBuildingLine1Address(String deliveryBuildingLine1Address);
178 
179     public String getDeliveryBuildingLine2Address();
180 
181     public void setDeliveryBuildingLine2Address(String deliveryBuildingLine2Address);
182 
183     public String getDeliveryCityName();
184 
185     public void setDeliveryCityName(String deliveryCityName);
186 
187     public String getDeliveryStateCode();
188 
189     public void setDeliveryStateCode(String deliveryStateCode);
190 
191     public String getDeliveryPostalCode();
192 
193     public void setDeliveryPostalCode(String deliveryPostalCode);
194 
195     public String getDeliveryCountryCode();
196 
197     public String getDeliveryCountryName();
198 
199     public void setDeliveryCountryCode(String deliveryCountryCode);
200 
201     public String getDeliveryToName();
202 
203     public void setDeliveryToName(String deliveryToName);
204 
205     public String getDeliveryToEmailAddress();
206 
207     public void setDeliveryToEmailAddress(String deliveryToEmailAddress);
208 
209     public String getDeliveryToPhoneNumber();
210 
211     public void setDeliveryToPhoneNumber(String deliveryToPhoneNumber);
212 
213     public Date getDeliveryRequiredDate();
214 
215     public void setDeliveryRequiredDate(Date deliveryRequiredDate);
216 
217     public String getDeliveryInstructionText();
218 
219     public void setDeliveryInstructionText(String deliveryInstructionText);
220 
221     public Date getPurchaseOrderBeginDate();
222 
223     public void setPurchaseOrderBeginDate(Date purchaseOrderBeginDate);
224 
225     public Date getPurchaseOrderEndDate();
226 
227     public void setPurchaseOrderEndDate(Date purchaseOrderEndDate);
228 
229     public String getInstitutionContactName();
230 
231     public void setInstitutionContactName(String institutionContactName);
232 
233     public String getInstitutionContactPhoneNumber();
234 
235     public void setInstitutionContactPhoneNumber(String institutionContactPhoneNumber);
236 
237     public String getInstitutionContactEmailAddress();
238 
239     public void setInstitutionContactEmailAddress(String institutionContactEmailAddress);
240 
241     public String getBillingName();
242 
243     public void setBillingName(String billingName);
244 
245     public String getBillingLine1Address();
246 
247     public void setBillingLine1Address(String billingLine1Address);
248 
249     public String getBillingLine2Address();
250 
251     public void setBillingLine2Address(String billingLine2Address);
252 
253     public String getBillingCityName();
254 
255     public void setBillingCityName(String billingCityName);
256 
257     public String getBillingStateCode();
258 
259     public void setBillingStateCode(String billingStateCode);
260 
261     public String getBillingPostalCode();
262 
263     public void setBillingPostalCode(String billingPostalCode);
264 
265     public String getBillingCountryCode();
266 
267     public void setBillingCountryCode(String billingCountryCode);
268 
269     public String getBillingCountryName();
270 
271     public String getBillingPhoneNumber();
272 
273     public void setBillingPhoneNumber(String receivingPhoneNumber);
274 
275     public String getReceivingName();
276 
277     public void setReceivingName(String receivingName);
278 
279     public String getReceivingLine1Address();
280 
281     public void setReceivingLine1Address(String receivingLine1Address);
282 
283     public String getReceivingLine2Address();
284 
285     public void setReceivingLine2Address(String receivingLine2Address);
286 
287     public String getReceivingCityName();
288 
289     public void setReceivingCityName(String receivingCityName);
290 
291     public String getReceivingStateCode();
292 
293     public void setReceivingStateCode(String receivingStateCode);
294 
295     public String getReceivingPostalCode();
296 
297     public void setReceivingPostalCode(String receivingPostalCode);
298 
299     public String getReceivingCountryCode();
300 
301     public String getReceivingCountryName();
302 
303     public void setReceivingCountryCode(String receivingCountryCode);
304 
305     public boolean getAddressToVendorIndicator();
306 
307     public void setAddressToVendorIndicator(boolean addressToVendorIndicator);
308 
309     public String getExternalOrganizationB2bSupplierIdentifier();
310 
311     public void setExternalOrganizationB2bSupplierIdentifier(String externalOrganizationB2bSupplierIdentifier);
312 
313     public boolean getPurchaseOrderAutomaticIndicator();
314 
315     public void setPurchaseOrderAutomaticIndicator(boolean purchaseOrderAutomaticIndicator);
316 
317     public FundingSource getFundingSource();
318 
319     public void setFundingSource(FundingSource fundingSource);
320 
321     public RequisitionSource getRequisitionSource();
322 
323     /**
324      * @deprecated
325      */
326     public void setRequisitionSource(RequisitionSource requisitionSource);
327 
328     public PurchaseOrderTransmissionMethod getPurchaseOrderTransmissionMethod();
329 
330     /**
331      * @deprecated
332      */
333     public void setPurchaseOrderTransmissionMethod(PurchaseOrderTransmissionMethod purchaseOrderTransmissionMethod);
334 
335     public PurchaseOrderCostSource getPurchaseOrderCostSource();
336 
337     /**
338      * @deprecated
339      */
340     public void setPurchaseOrderCostSource(PurchaseOrderCostSource purchaseOrderCostSource);
341 
342     public DeliveryRequiredDateReason getDeliveryRequiredDateReason();
343 
344     /**
345      * @deprecated
346      */
347     public void setDeliveryRequiredDateReason(DeliveryRequiredDateReason deliveryRequiredDateReason);
348 
349     public RecurringPaymentType getRecurringPaymentType();
350 
351     /**
352      * @deprecated
353      */
354     public void setRecurringPaymentType(RecurringPaymentType recurringPaymentType);
355 
356     public Organization getOrganization();
357 
358     /**
359      * @deprecated
360      */
361     public void setOrganization(Organization organization);
362 
363     public Chart getChartOfAccounts();
364 
365     /**
366      * @deprecated
367      */
368     public void setChartOfAccounts(Chart chartOfAccounts);
369 
370     public CampusParameter getDeliveryCampus();
371 
372     /**
373      * @deprecated
374      */
375     public void setDeliveryCampus(CampusParameter deliveryCampus);
376 
377     public Chart getNonInstitutionFundOrgChartOfAccounts();
378 
379     /**
380      * @deprecated
381      */
382     public void setNonInstitutionFundOrgChartOfAccounts(Chart nonInstitutionFundOrgChartOfAccounts);
383 
384     public Organization getNonInstitutionFundOrganization();
385 
386     /**
387      * @deprecated
388      */
389     public void setNonInstitutionFundOrganization(Organization nonInstitutionFundOrganization);
390 
391     public Account getNonInstitutionFundAccount();
392 
393     /**
394      * @deprecated
395      */
396     public void setNonInstitutionFundAccount(Account nonInstitutionFundAccount);
397 
398     public Chart getNonInstitutionFundChartOfAccounts();
399 
400     /**
401      * @deprecated
402      */
403     public void setNonInstitutionFundChartOfAccounts(Chart nonInstitutionFundChartOfAccounts);
404 
405     public String getVendorPaymentTermsCode();
406 
407     public void setVendorPaymentTermsCode(String vendorPaymentTermsCode);
408 
409     public String getVendorShippingPaymentTermsCode();
410 
411     public void setVendorShippingPaymentTermsCode(String vendorShippingPaymentTermsCode);
412 
413     public String getVendorShippingTitleCode();
414 
415     public void setVendorShippingTitleCode(String vendorShippingTitleCode);
416 
417     public boolean isDeliveryBuildingOtherIndicator();
418 
419     public void setDeliveryBuildingOtherIndicator(boolean deliveryBuildingOtherIndicator);
420 
421     public List<PurApItem> getItems();
422 
423     public void setItems(List items);
424 
425     /**
426      * @see org.kuali.ole.module.purap.document.PurchasingAccountsPayableDocument#getItem(int)
427      */
428     public PurApItem getItem(int pos);
429 
430     /**
431      * @see org.kuali.ole.module.purap.document.PurchasingAccountsPayableDocument#addItem(PurApItem item)
432      */
433     public void addItem(PurApItem item);
434 
435     /**
436      * @see org.kuali.ole.module.purap.document.PurchasingAccountsPayableDocument#deleteItem(int lineNum)
437      */
438     public void deleteItem(int lineNum);
439 
440     /**
441      * @see org.kuali.ole.sys.document.AccountingDocumentBase#getTotalDollarAmount()
442      */
443     public KualiDecimal getTotalDollarAmount();
444 
445     /**
446      * Sets vendor detail fields based on the specified Vendor Detail.
447      *
448      * @param vendorDetail the specified Vendor Detail.
449      */
450     public void templateVendorDetail(VendorDetail vendorDetail);
451 
452     /**
453      * Sets vendor contract fields based on the specified Vendor Contract.
454      *
455      * @param vendorContract the specified Vendor Contract.
456      */
457     public void templateVendorContract(VendorContract vendorContract);
458 
459     /**
460      * Sets billing address fields based on the specified Billing Address.
461      *
462      * @param billingAddress the specified Billing Address.
463      */
464     public void templateBillingAddress(BillingAddress billingAddress);
465 
466     /**
467      * Sets receiving address fields based on the specified Receiving Address.
468      *
469      * @param receivingAddress the specified Receiving Address.
470      */
471     public void templateReceivingAddress(ReceivingAddress receivingAddress);
472 
473     /**
474      * Loads the default receiving address from database corresponding to the chart/org of this document.
475      */
476     public void loadReceivingAddress();
477 
478     public boolean isReceivingDocumentRequiredIndicator();
479 
480     public void setReceivingDocumentRequiredIndicator(boolean receivingDocumentRequiredIndicator);
481 
482     public boolean isPaymentRequestPositiveApprovalIndicator();
483 
484     public void setPaymentRequestPositiveApprovalIndicator(boolean paymentRequestPositiveApprovalIndicator);
485 
486     public String getCapitalAssetSystemTypeCode();
487 
488     public void setCapitalAssetSystemTypeCode(String capitalAssetSystemTypeCode);
489 
490     public String getCapitalAssetSystemStateCode();
491 
492     public void setCapitalAssetSystemStateCode(String capitalAssetSystemStateCode);
493 
494     public CapitalAssetSystemType getCapitalAssetSystemType();
495 
496     public void setCapitalAssetSystemType(CapitalAssetSystemType capitalAssetSystemType);
497 
498     public CapitalAssetSystemState getCapitalAssetSystemState();
499 
500     public void setCapitalAssetSystemState(CapitalAssetSystemState capitalAssetSystemState);
501 
502     public List<CapitalAssetSystem> getPurchasingCapitalAssetSystems();
503 
504     public void setPurchasingCapitalAssetSystems(List<CapitalAssetSystem> purchasingCapitalAssetSystems);
505 
506     public List<PurchasingCapitalAssetItem> getPurchasingCapitalAssetItems();
507 
508     public void setPurchasingCapitalAssetItems(List<PurchasingCapitalAssetItem> purchasingCapitalAssetItems);
509 
510     public abstract Class getPurchasingCapitalAssetItemClass();
511 
512     public abstract Class getPurchasingCapitalAssetSystemClass();
513 
514     public PurchasingItem getPurchasingItem(Integer itemIdentifier);
515 
516     public PurchasingCapitalAssetItem getPurchasingCapitalAssetItem(Integer itemIdentifier);
517 
518     public abstract PurchasingDocumentSpecificService getDocumentSpecificService();
519 
520     public void clearCapitalAssetFields();
521 
522     public boolean shouldGiveErrorForEmptyAccountsProration();
523 }