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.CompletionStrategyMetaData;
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: import org.obe.spi.runtime.CompletionStrategy;
053:
054: /**
055: * Provides management and registration for activity completion strategies.
056: *
057: * @author Adrian Price
058: */
059: public interface CompletionStrategyFactory extends WorkflowService {
060: String SERVICE_NAME = "CompletionStrategyFactory";
061:
062: /**
063: * Registers a completion strategy.
064: *
065: * @param strategy The completion strategy definition.
066: * @throws ObjectAlreadyExistsException if the
067: * implementation class is already registered.
068: * @throws RepositoryException if the strategy could not be registered
069: * for some other reason.
070: */
071: void createStrategy(CompletionStrategyMetaData strategy)
072: throws RepositoryException;
073:
074: /**
075: * Unregisters a completion strategy.
076: *
077: * @param implClass The fully qualified implementation class name.
078: * @throws ObjectNotFoundException if the
079: * implementation class is not registered.
080: * @throws RepositoryException if the strategy could not be unregistered
081: * for some other reason.
082: */
083: void deleteStrategy(String implClass) throws RepositoryException;
084:
085: /**
086: * Updates a completion strategy definition.
087: *
088: * @param strategy The completion strategy definition.
089: * @throws ObjectNotFoundException if an function
090: * set for the implementation class in question is not registered.
091: * @throws RepositoryException if the completion strategy could not be updated for
092: * some other reason.
093: */
094: void updateStrategy(CompletionStrategyMetaData strategy)
095: throws RepositoryException;
096:
097: /**
098: * Finds all function types known to the repository. This method is
099: * intended to support design-time clients and management applications.
100: *
101: * @param locale The locale in which the results should be formatted.
102: * @return All strategy types.
103: * @throws RepositoryException if an error occurred.
104: */
105: CompletionStrategyMetaData[] findStrategyTypes(String locale)
106: throws RepositoryException;
107:
108: /**
109: * Returns information about the specified function type. This method is
110: * intended to support design-time clients and management applications.
111: *
112: * @param className The function type (i.e., the fully qualified name of
113: * the implementation class).
114: * @param locale The locale in which the results should be formatted.
115: * @return Information about the specified strategy type.
116: * @throws ObjectNotFoundException if the
117: * strategy type is unknown.
118: * @throws RepositoryException if some other error occurred.
119: */
120: CompletionStrategyMetaData findStrategyType(String className,
121: String locale) throws RepositoryException;
122:
123: /**
124: * Finds meta-data for all strategys. This method is intended to support
125: * design-time clients and management applications.
126: *
127: * @return The list of all strategys.
128: * @throws RepositoryException if an error occurred.
129: */
130: CompletionStrategyMetaData[] findStrategyMetaData()
131: throws RepositoryException;
132:
133: /**
134: * Finds meta-data for an strategy. This method is intended to support
135: * design-time clients and management applications.
136: *
137: * @param strategy The name of the implementation class.
138: * @return Meta-data about the requested completion strategy.
139: * @throws ObjectNotFoundException if a function
140: * set for <code>strategy</code> is not registered.
141: * @throws RepositoryException if some other error occurred.
142: */
143: CompletionStrategyMetaData findStrategyMetaData(String strategy)
144: throws RepositoryException;
145:
146: /**
147: * Finds a completion strategy. This method is called by the engine at run-time
148: * when it needs to invoke a function from the completion strategy with the given
149: * class name.
150: *
151: * @param strategy The fully qualified name of the implementing class.
152: * @return The requested completion strategy.
153: * @throws ObjectNotFoundException if an function
154: * set for <code>strategy</code> is not registered.
155: * @throws RepositoryException if some other error occurred.
156: */
157: CompletionStrategy findStrategy(String strategy)
158: throws RepositoryException;
159: }
|