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 an abstract implementation of the IVoucherGenerator interface.
057: *
058: * @author GautamJ
059: */
060: public abstract class AbstractVoucherGenerator implements
061: IVoucherGenerator {
062:
063: private UOW m_uow = null;
064: private String m_labelToken = null;
065: private String m_prefix = null;
066: private String m_length = null;
067:
068: /** This method should be invoked by a client before all the setters are invoked. Use this to perform initializations.
069: */
070: public void init() {
071: }
072:
073: /** This method should be invoked by a client after the generate is completed. Use this to perform cleanup operations.
074: */
075: public void cleanup() {
076: }
077:
078: /** The client will invoke this method to generate a voucher.
079: * @throws FrameworkException if any framework error occurs.
080: * @throws ApplicationExceptions if any application error occurs.
081: * @return a unique voucher.
082: */
083: public abstract String generate() throws FrameworkException,
084: ApplicationExceptions;
085:
086: /** Getter for the property uow.
087: * @return Value of property uow.
088: */
089: public UOW getUow() {
090: return m_uow;
091: }
092:
093: /** Setter for property uow.
094: * @param uow New value of property uow.
095: */
096: public void setUow(UOW uow) {
097: m_uow = uow;
098: }
099:
100: /** Getter for the property labelToken.
101: * @return Value of property labelToken.
102: */
103: public String getLabelToken() {
104: return m_labelToken;
105: }
106:
107: /** Setter for property labelToken.
108: * @param labelToken New value of property labelToken.
109: */
110: public void setLabelToken(String labelToken) {
111: m_labelToken = labelToken;
112: }
113:
114: /** Getter for the property prefix.
115: * @return Value of property prefix.
116: */
117: public String getPrefix() {
118: return m_prefix;
119: }
120:
121: /** Setter for property prefix.
122: * @param prefix New value of property prefix.
123: */
124: public void setPrefix(String prefix) {
125: m_prefix = prefix;
126: }
127:
128: /** Getter for the property length.
129: * @return Value of property length.
130: */
131: public String getLength() {
132: return m_length;
133: }
134:
135: /** Setter for property length.
136: * @param length New value of property length.
137: */
138: public void setLength(String length) {
139: m_length = length;
140: }
141:
142: }
|