001: /*--
002:
003: Copyright (C) 2002-2005 Adrian Price.
004: All rights reserved.
005:
006: Redistribution and use in source and binary forms, with or without
007: modification, are permitted provided that the following conditions
008: are met:
009:
010: 1. Redistributions of source code must retain the above copyright
011: notice, this list of conditions, and the following disclaimer.
012:
013: 2. Redistributions in binary form must reproduce the above copyright
014: notice, this list of conditions, and the disclaimer that follows
015: these conditions in the documentation and/or other materials
016: provided with the distribution.
017:
018: 3. The names "OBE" and "Open Business Engine" must not be used to
019: endorse or promote products derived from this software without prior
020: written permission. For written permission, please contact
021: adrianprice@sourceforge.net.
022:
023: 4. Products derived from this software may not be called "OBE" or
024: "Open Business Engine", nor may "OBE" or "Open Business Engine"
025: appear in their name, without prior written permission from
026: Adrian Price (adrianprice@users.sourceforge.net).
027:
028: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
029: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
030: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
031: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
032: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
033: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
034: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
035: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
036: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
037: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
038: POSSIBILITY OF SUCH DAMAGE.
039:
040: For more information on OBE, please see
041: <http://obe.sourceforge.net/>.
042:
043: */
044:
045: package org.obe.spi.service;
046:
047: import org.obe.client.api.repository.FunctionSetMetaData;
048: import org.obe.client.api.repository.ObjectAlreadyExistsException;
049: import org.obe.client.api.repository.ObjectNotFoundException;
050: import org.obe.client.api.repository.RepositoryException;
051: import org.obe.spi.WorkflowService;
052:
053: /**
054: * Provides management and registration for pluggable script functions.
055: *
056: * @author Adrian Price
057: */
058: public interface FunctionFactory extends WorkflowService {
059: String SERVICE_NAME = "FunctionFactory";
060:
061: /**
062: * Registers a function set.
063: *
064: * @param funcs The function set definition.
065: * @throws ObjectAlreadyExistsException if the
066: * implementation class is already registered.
067: * @throws RepositoryException if the evaluator could not be registered
068: * for some other reason.
069: */
070: void createFunctionSet(FunctionSetMetaData funcs)
071: throws RepositoryException;
072:
073: /**
074: * Unregisters a function set.
075: *
076: * @param implClass The fully qualified implementation class name.
077: * @throws ObjectNotFoundException if the
078: * implementation class is not registered.
079: * @throws RepositoryException if the evaluator could not be unregistered
080: * for some other reason.
081: */
082: void deleteFunctionSet(String implClass) throws RepositoryException;
083:
084: /**
085: * Updates a function set definition.
086: *
087: * @param funcs The function set definition.
088: * @throws ObjectNotFoundException if an function
089: * set for the implementation class in question is not registered.
090: * @throws RepositoryException if the function set could not be updated for
091: * some other reason.
092: */
093: void updateFunctionSet(FunctionSetMetaData funcs)
094: throws RepositoryException;
095:
096: /**
097: * Finds all function types known to the repository. This method is
098: * intended to support design-time clients and management applications.
099: *
100: * @param locale The locale in which the results should be formatted.
101: * @return All evaluator types.
102: * @throws RepositoryException if an error occurred.
103: */
104: FunctionSetMetaData[] findFunctionTypes(String locale)
105: throws RepositoryException;
106:
107: /**
108: * Returns information about the specified function type. This method is
109: * intended to support design-time clients and management applications.
110: *
111: * @param className The function type (i.e., the fully qualified name of
112: * the implementation class).
113: * @param locale The locale in which the results should be formatted.
114: * @return Information about the specified evaluator type.
115: * @throws ObjectNotFoundException if the
116: * evaluator type is unknown.
117: * @throws RepositoryException if some other error occurred.
118: */
119: FunctionSetMetaData findFunctionType(String className, String locale)
120: throws RepositoryException;
121:
122: /**
123: * Finds meta-data for all evaluators. This method is intended to support
124: * design-time clients and management applications.
125: *
126: * @return The list of all evaluators.
127: * @throws RepositoryException if an error occurred.
128: */
129: FunctionSetMetaData[] findFunctionMetaData()
130: throws RepositoryException;
131:
132: /**
133: * Finds meta-data for an evaluator. This method is intended to support
134: * design-time clients and management applications.
135: *
136: * @param className The name of the implementation class.
137: * @return Meta-data about the requested function set.
138: * @throws ObjectNotFoundException if a function
139: * set for <code>className</code> is not registered.
140: * @throws RepositoryException if some other error occurred.
141: */
142: FunctionSetMetaData findFunctionMetaData(String className)
143: throws RepositoryException;
144:
145: /**
146: * Finds a function set. This method is called by the engine at run-time
147: * when it needs to invoke a function from the function set with the given
148: * class name.
149: *
150: * @param className The fully qualified name of the implementing class.
151: * @return The requested function set.
152: * @throws ObjectNotFoundException if an function
153: * set for <code>className</code> is not registered.
154: * @throws RepositoryException if some other error occurred.
155: */
156: Class findFunctionSet(String className) throws RepositoryException;
157: }
|