001: /*
002: * Copyright 2006 The Kuali Foundation.
003: *
004: * Licensed under the Educational Community License, Version 1.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.opensource.org/licenses/ecl1.php
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: package org.kuali.core.impls;
017:
018: import java.sql.Timestamp;
019:
020: import org.kuali.core.bo.user.UniversalUser;
021: import org.kuali.core.service.DocumentService;
022: import org.kuali.core.workflow.service.KualiWorkflowDocument;
023:
024: import edu.iu.uis.eden.clientapp.vo.RouteHeaderVO;
025: import edu.iu.uis.eden.clientapp.vo.UserIdVO;
026: import edu.iu.uis.eden.clientapp.vo.WorkflowAttributeDefinitionVO;
027: import edu.iu.uis.eden.clientapp.vo.WorkgroupIdVO;
028: import edu.iu.uis.eden.exception.WorkflowException;
029:
030: /**
031: * This class is the base class for a MockWorkflowDocument. It can be extended by any other kind of mock document that needs to
032: * override certain methods.
033: *
034: * This class has absolutely no state or behavior. There is no public constructor, and no member variables. All void methods do
035: * nothing. All methods with a return value return null.
036: *
037: * All state and behavior needs to be added via a subclass.
038: *
039: *
040: */
041: public abstract class MockWorkflowDocument implements
042: KualiWorkflowDocument {
043: private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger
044: .getLogger(DocumentService.class);
045:
046: /**
047: * Constructs a MockWorkflowDocument.java.
048: */
049: protected MockWorkflowDocument() {
050: }
051:
052: /**
053: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#isStandardSaveAllowed()
054: */
055: public boolean isStandardSaveAllowed() {
056: LOG.debug("Using MockWorkflowDocument");
057: return false;
058: }
059:
060: /**
061: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getApplicationContent()
062: */
063: public String getApplicationContent() {
064: LOG.debug("Using MockWorkflowDocument");
065: return null;
066: }
067:
068: /**
069: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#setApplicationContent(java.lang.String)
070: */
071: public void setApplicationContent(String applicationContent) {
072: LOG.debug("Using MockWorkflowDocument");
073: }
074:
075: /**
076: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#clearAttributeContent()
077: */
078: public void clearAttributeContent() {
079: LOG.debug("Using MockWorkflowDocument");
080: }
081:
082: /**
083: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getAttributeContent()
084: */
085: public String getAttributeContent() {
086: LOG.debug("Using MockWorkflowDocument");
087: return null;
088: }
089:
090: /**
091: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#addAttributeDefinition(edu.iu.uis.eden.clientapp.vo.WorkflowAttributeDefinitionVO)
092: */
093: public void addAttributeDefinition(
094: WorkflowAttributeDefinitionVO attributeDefinition) {
095: LOG.debug("Using MockWorkflowDocument");
096: }
097:
098: /**
099: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#removeAttributeDefinition(edu.iu.uis.eden.clientapp.vo.WorkflowAttributeDefinitionVO)
100: */
101: public void removeAttributeDefinition(
102: WorkflowAttributeDefinitionVO attributeDefinition) {
103: LOG.debug("Using MockWorkflowDocument");
104: }
105:
106: /**
107: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#clearAttributeDefinitions()
108: */
109: public void clearAttributeDefinitions() {
110: LOG.debug("Using MockWorkflowDocument");
111: }
112:
113: /**
114: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getAttributeDefinitions()
115: */
116: public WorkflowAttributeDefinitionVO[] getAttributeDefinitions() {
117: LOG.debug("Using MockWorkflowDocument");
118: return null;
119: }
120:
121: /**
122: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#addSearchableDefinition(edu.iu.uis.eden.clientapp.vo.WorkflowAttributeDefinitionVO)
123: */
124: public void addSearchableDefinition(
125: WorkflowAttributeDefinitionVO searchableDefinition) {
126: LOG.debug("Using MockWorkflowDocument");
127:
128: }
129:
130: /**
131: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#removeSearchableDefinition(edu.iu.uis.eden.clientapp.vo.WorkflowAttributeDefinitionVO)
132: */
133: public void removeSearchableDefinition(
134: WorkflowAttributeDefinitionVO searchableDefinition) {
135: LOG.debug("Using MockWorkflowDocument");
136:
137: }
138:
139: /**
140: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#clearSearchableDefinitions()
141: */
142: public void clearSearchableDefinitions() {
143: LOG.debug("Using MockWorkflowDocument");
144:
145: }
146:
147: /**
148: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getSearchableDefinitions()
149: */
150: public WorkflowAttributeDefinitionVO[] getSearchableDefinitions() {
151: LOG.debug("Using MockWorkflowDocument");
152: return null;
153: }
154:
155: /**
156: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getRouteHeader()
157: */
158: public RouteHeaderVO getRouteHeader() {
159: LOG.debug("Using MockWorkflowDocument");
160: return null;
161: }
162:
163: /**
164: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getRouteHeaderId()
165: */
166: public Long getRouteHeaderId() throws WorkflowException {
167: LOG.debug("Using MockWorkflowDocument");
168: return null;
169: }
170:
171: /**
172: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#setAppDocId(java.lang.String)
173: */
174: public void setAppDocId(String appDocId) {
175: LOG.debug("Using MockWorkflowDocument");
176:
177: }
178:
179: /**
180: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getAppDocId()
181: */
182: public String getAppDocId() {
183: LOG.debug("Using MockWorkflowDocument");
184: return null;
185: }
186:
187: /**
188: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getInitiatorNetworkId()
189: */
190: public String getInitiatorNetworkId() {
191: LOG.debug("Using MockWorkflowDocument");
192: return null;
193: }
194:
195: /**
196: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getRoutedByUserNetworkId()
197: */
198: public String getRoutedByUserNetworkId() {
199: LOG.debug("Using MockWorkflowDocument");
200: return null;
201: }
202:
203: /**
204: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getTitle()
205: */
206: public String getTitle() {
207: LOG.debug("Using MockWorkflowDocument");
208: return null;
209: }
210:
211: /**
212: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#saveDocument(java.lang.String)
213: */
214: public void saveDocument(String annotation)
215: throws WorkflowException {
216: LOG.debug("Using MockWorkflowDocument");
217:
218: }
219:
220: /**
221: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#routeDocument(java.lang.String)
222: */
223: public void routeDocument(String annotation)
224: throws WorkflowException {
225: LOG.debug("Using MockWorkflowDocument");
226:
227: }
228:
229: /**
230: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#disapprove(java.lang.String)
231: */
232: public void disapprove(String annotation) throws WorkflowException {
233: LOG.debug("Using MockWorkflowDocument");
234:
235: }
236:
237: /**
238: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#approve(java.lang.String)
239: */
240: public void approve(String annotation) throws WorkflowException {
241: LOG.debug("Using MockWorkflowDocument");
242:
243: }
244:
245: /**
246: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#superUserApprove(java.lang.String)
247: */
248: public void super UserApprove(String annotation)
249: throws WorkflowException {
250: LOG.debug("Using MockWorkflowDocument");
251:
252: }
253:
254: /**
255: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#superUserActionRequestApprove(java.lang.Long, java.lang.String)
256: */
257: public void super UserActionRequestApprove(Long actionRequestId,
258: String annotation) throws WorkflowException {
259: LOG.debug("Using MockWorkflowDocument");
260: }
261:
262: /**
263: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#superUserCancel(java.lang.String)
264: */
265: public void super UserCancel(String annotation)
266: throws WorkflowException {
267: LOG.debug("Using MockWorkflowDocument");
268:
269: }
270:
271: /**
272: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#superUserDisapprove(java.lang.String)
273: */
274: public void super UserDisapprove(String annotation)
275: throws WorkflowException {
276: LOG.debug("Using MockWorkflowDocument");
277:
278: }
279:
280: /**
281: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#cancel(java.lang.String)
282: */
283: public void cancel(String annotation) throws WorkflowException {
284: LOG.debug("Using MockWorkflowDocument");
285:
286: }
287:
288: /**
289: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#blanketApprove(java.lang.String)
290: */
291: public void blanketApprove(String annotation)
292: throws WorkflowException {
293: LOG.debug("Using MockWorkflowDocument");
294:
295: }
296:
297: /**
298: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#blanketApprove(java.lang.String, java.lang.Integer)
299: */
300: public void blanketApprove(String annotation, Integer routeLevel)
301: throws WorkflowException {
302: LOG.debug("Using MockWorkflowDocument");
303:
304: }
305:
306: /**
307: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#saveRoutingData()
308: */
309: public void saveRoutingData() throws WorkflowException {
310: LOG.debug("Using MockWorkflowDocument");
311:
312: }
313:
314: /**
315: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#acknowledge(java.lang.String)
316: */
317: public void acknowledge(String annotation) throws WorkflowException {
318: LOG.debug("Using MockWorkflowDocument");
319:
320: }
321:
322: /**
323: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#fyi()
324: */
325: public void fyi() throws WorkflowException {
326: LOG.debug("Using MockWorkflowDocument");
327:
328: }
329:
330: /**
331: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#delete()
332: */
333: public void delete() throws WorkflowException {
334: LOG.debug("Using MockWorkflowDocument");
335:
336: }
337:
338: /**
339: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#refreshContent()
340: */
341: public void refreshContent() throws WorkflowException {
342: LOG.debug("Using MockWorkflowDocument");
343:
344: }
345:
346: /**
347: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#appSpecificRouteDocumentToUser(java.lang.String, java.lang.String,
348: * int, java.lang.String, edu.iu.uis.eden.clientapp.vo.UserIdVO, java.lang.String, boolean)
349: */
350: public void appSpecificRouteDocumentToUser(String actionRequested,
351: String routeTypeName, int priority, String annotation,
352: UserIdVO recipient, String responsibilityDesc,
353: boolean ignorePreviousActions) throws WorkflowException {
354: LOG.debug("Using MockWorkflowDocument");
355:
356: }
357:
358: /**
359: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#appSpecificRouteDocumentToWorkgroup(java.lang.String,
360: * java.lang.String, int, java.lang.String, edu.iu.uis.eden.clientapp.vo.WorkgroupIdVO, java.lang.String, boolean)
361: */
362: public void appSpecificRouteDocumentToWorkgroup(
363: String actionRequested, String routeTypeName, int priority,
364: String annotation, WorkgroupIdVO workgroupId,
365: String responsibilityDesc, boolean ignorePreviousActions)
366: throws WorkflowException {
367: LOG.debug("Using MockWorkflowDocument");
368:
369: }
370:
371: /**
372: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#setTitle(java.lang.String)
373: */
374: public void setTitle(String title) throws WorkflowException {
375: LOG.debug("Using MockWorkflowDocument");
376:
377: }
378:
379: /**
380: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getDocumentType()
381: */
382: public String getDocumentType() {
383: LOG.debug("Using MockWorkflowDocument");
384: return null;
385: }
386:
387: /**
388: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#isAdHocRequested()
389: */
390: public boolean isAdHocRequested() {
391: LOG.debug("Using MockWorkflowDocument");
392: return false;
393: }
394:
395: /**
396: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#isAcknowledgeRequested()
397: */
398: public boolean isAcknowledgeRequested() {
399: LOG.debug("Using MockWorkflowDocument");
400: return false;
401: }
402:
403: /**
404: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#isApprovalRequested()
405: */
406: public boolean isApprovalRequested() {
407: LOG.debug("Using MockWorkflowDocument");
408: return false;
409: }
410:
411: /**
412: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#isCompletionRequested()
413: */
414: public boolean isCompletionRequested() {
415: LOG.debug("Using MockWorkflowDocument");
416: return false;
417: }
418:
419: /**
420: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#isFYIRequested()
421: */
422: public boolean isFYIRequested() {
423: LOG.debug("Using MockWorkflowDocument");
424: return false;
425: }
426:
427: /**
428: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#isBlanketApproveCapable()
429: */
430: public boolean isBlanketApproveCapable() {
431: LOG.debug("Using MockWorkflowDocument");
432: return false;
433: }
434:
435: /**
436: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getDocRouteLevel()
437: */
438: public Integer getDocRouteLevel() {
439: LOG.debug("Using MockWorkflowDocument");
440: return null;
441: }
442:
443: /**
444: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getDocRouteLevelName()
445: */
446: public String getDocRouteLevelName() throws WorkflowException {
447: LOG.debug("Using MockWorkflowDocument");
448: return null;
449: }
450:
451: /**
452: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getRouteTypeName()
453: */
454: public String getRouteTypeName() throws WorkflowException {
455: LOG.debug("Using MockWorkflowDocument");
456: return null;
457: }
458:
459: /**
460: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#complete(java.lang.String)
461: */
462: public void complete(String annotation) throws WorkflowException {
463: LOG.debug("Using MockWorkflowDocument");
464:
465: }
466:
467: /**
468: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#returnToPreviousRouteLevel(java.lang.String, java.lang.Integer)
469: */
470: public void returnToPreviousRouteLevel(String annotation,
471: Integer destRouteLevel) throws WorkflowException {
472: LOG.debug("Using MockWorkflowDocument");
473:
474: }
475:
476: /**
477: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#logDocumentAction(java.lang.String)
478: */
479: public void logDocumentAction(String annotation)
480: throws WorkflowException {
481: LOG.debug("Using MockWorkflowDocument");
482:
483: }
484:
485: /**
486: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#stateIsInitiated()
487: */
488: public boolean stateIsInitiated() {
489: LOG.debug("Using MockWorkflowDocument");
490: return false;
491: }
492:
493: /**
494: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#stateIsSaved()
495: */
496: public boolean stateIsSaved() {
497: LOG.debug("Using MockWorkflowDocument");
498: return false;
499: }
500:
501: /**
502: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#stateIsEnroute()
503: */
504: public boolean stateIsEnroute() {
505: LOG.debug("Using MockWorkflowDocument");
506: return false;
507: }
508:
509: /**
510: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#stateIsFinal()
511: */
512: public boolean stateIsFinal() {
513: LOG.debug("Using MockWorkflowDocument");
514: return false;
515: }
516:
517: /**
518: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#stateIsException()
519: */
520: public boolean stateIsException() {
521: LOG.debug("Using MockWorkflowDocument");
522: return false;
523: }
524:
525: /**
526: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#stateIsCanceled()
527: */
528: public boolean stateIsCanceled() {
529: LOG.debug("Using MockWorkflowDocument");
530: return false;
531: }
532:
533: /**
534: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#stateIsDisapproved()
535: */
536: public boolean stateIsDisapproved() {
537: LOG.debug("Using MockWorkflowDocument");
538: return false;
539: }
540:
541: /**
542: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#stateIsApproved()
543: */
544: public boolean stateIsApproved() {
545: LOG.debug("Using MockWorkflowDocument");
546: return false;
547: }
548:
549: /**
550: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#stateIsProcessed()
551: */
552: public boolean stateIsProcessed() {
553: LOG.debug("Using MockWorkflowDocument");
554: return false;
555: }
556:
557: /**
558: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getStatusDisplayValue()
559: */
560: public String getStatusDisplayValue() {
561: LOG.debug("Using MockWorkflowDocument");
562: return null;
563: }
564:
565: /**
566: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getCreateDate()
567: */
568: public Timestamp getCreateDate() {
569: LOG.debug("Using MockWorkflowDocument");
570: return null;
571: }
572:
573: /**
574: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#userIsInitiator(org.kuali.core.bo.user.UniversalUser)
575: */
576: public boolean userIsInitiator(UniversalUser user) {
577: LOG.debug("Using MockWorkflowDocument");
578: return false;
579: }
580:
581: /**
582: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#userIsRoutedByUser(org.kuali.core.bo.user.UniversalUser)
583: */
584: public boolean userIsRoutedByUser(UniversalUser user) {
585: LOG.debug("Using MockWorkflowDocument");
586: return false;
587: }
588:
589: /**
590: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getNodeNames()
591: */
592: public String[] getNodeNames() throws WorkflowException {
593: LOG.debug("Using MockWorkflowDocument");
594: return null;
595: }
596:
597: /**
598: * @see org.kuali.core.workflow.service.KualiWorkflowDocument#getCurrentRouteNodeNames()
599: */
600: public String getCurrentRouteNodeNames() {
601: LOG.debug("Using MockWorkflowDocument");
602: return null;
603: }
604:
605: }
|