001: /*
002: * ====================================================================
003: * JAFFA - Java Application Framework For All
004: *
005: * Copyright (C) 2002 JAFFA Development Group
006: *
007: * This library is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU Lesser General Public
009: * License as published by the Free Software Foundation; either
010: * version 2.1 of the License, or (at your option) any later version.
011: *
012: * This library is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this library; if not, write to the Free Software
019: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020: *
021: * Redistribution and use of this software and associated documentation ("Software"),
022: * with or without modification, are permitted provided that the following conditions are met:
023: * 1. Redistributions of source code must retain copyright statements and notices.
024: * Redistributions must also contain a copy of this document.
025: * 2. Redistributions in binary form must reproduce the above copyright notice,
026: * this list of conditions and the following disclaimer in the documentation
027: * and/or other materials provided with the distribution.
028: * 3. The name "JAFFA" must not be used to endorse or promote products derived from
029: * this Software without prior written permission. For written permission,
030: * please contact mail to: jaffagroup@yahoo.com.
031: * 4. Products derived from this Software may not be called "JAFFA" nor may "JAFFA"
032: * appear in their names without prior written permission.
033: * 5. Due credit should be given to the JAFFA Project (http://jaffa.sourceforge.net).
034: *
035: * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
036: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
039: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046: * SUCH DAMAGE.
047: * ====================================================================
048: */
049:
050: package org.jaffa.components.voucher;
051:
052: import org.jaffa.persistence.UOW;
053: import org.jaffa.exceptions.ApplicationExceptions;
054: import org.jaffa.exceptions.FrameworkException;
055:
056: /** This is the interface for a class generating vouchers. A client will typically create an instance of a VoucherGenerator. It will then invoke the init() method, all the setters, the generate() method and finally the cleanup() method.
057: */
058: public interface IVoucherGenerator {
059:
060: /** This method should be invoked by a client before all the setters are invoked. Use this to perform initializations.
061: */
062: public void init();
063:
064: /** This method should be invoked by a client after the generate is completed. Use this to perform cleanup operations.
065: */
066: public void cleanup();
067:
068: /** The client will invoke this method to generate a voucher.
069: * @throws FrameworkException if any framework error occurs.
070: * @throws ApplicationExceptions if any application error occurs.
071: * @return a unique voucher.
072: */
073: public String generate() throws FrameworkException,
074: ApplicationExceptions;
075:
076: /** Getter for the property uow.
077: * @return Value of property uow.
078: */
079: public UOW getUow();
080:
081: /** Setter for property uow.
082: * @param uow New value of property uow.
083: */
084: public void setUow(UOW uow);
085:
086: /** Getter for the property labelToken.
087: * @return Value of property labelToken.
088: */
089: public String getLabelToken();
090:
091: /** Setter for property labelToken.
092: * @param labelToken New value of property labelToken.
093: */
094: public void setLabelToken(String labelToken);
095:
096: /** Getter for the property prefix.
097: * @return Value of property prefix.
098: */
099: public String getPrefix();
100:
101: /** Setter for property prefix.
102: * @param prefix New value of property prefix.
103: */
104: public void setPrefix(String prefix);
105:
106: /** Getter for the property length.
107: * @return Value of property length.
108: */
109: public String getLength();
110:
111: /** Setter for property length.
112: * @param length New value of property length.
113: */
114: public void setLength(String length);
115:
116: }
|