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.CalendarMetaData;
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.BusinessCalendar;
053:
054: /**
055: * Standard interface for a calendar factory. The calendar factory is used to
056: * retrieve named business calendars, which are used to perform temporal
057: * computations.
058: *
059: * @author Adrian Price
060: */
061: public interface CalendarFactory extends WorkflowService {
062: String SERVICE_NAME = "CalendarFactory";
063:
064: /**
065: * Registers a calendar.
066: *
067: * @param calendar The calendar definition.
068: * @throws ObjectAlreadyExistsException if the calendar ID is already
069: * registered.
070: * @throws RepositoryException if the calendar could not be registered some
071: * other reason.
072: */
073: void createCalendar(CalendarMetaData calendar)
074: throws RepositoryException;
075:
076: /**
077: * Unregisters a calendar.
078: *
079: * @param id The calendar ID.
080: * @throws ObjectNotFoundException if the calendar ID is not registered.
081: * @throws RepositoryException if the calendar could not be unregistered for
082: * some other reason.
083: */
084: void deleteCalendar(String id) throws RepositoryException;
085:
086: /**
087: * Updates a calendar.
088: *
089: * @param calendar The calendar definition.
090: * @throws ObjectNotFoundException if the calendar ID is not registered.
091: * @throws RepositoryException if the calendar could not be updated for some
092: * other reason.
093: */
094: void updateCalendar(CalendarMetaData calendar)
095: throws RepositoryException;
096:
097: /**
098: * Finds all calendar 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 calendar types.
103: * @throws RepositoryException if an error occurred.
104: */
105: CalendarMetaData[] findCalendarTypes(String locale)
106: throws RepositoryException;
107:
108: /**
109: * Returns information about the specified calendar type. This method is
110: * intended to support design-time clients and management applications.
111: *
112: * @param className The calendar 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 calendar type.
116: * @throws ObjectNotFoundException if the calendar type is unknown.
117: * @throws RepositoryException if some other error occurred.
118: */
119: CalendarMetaData findCalendarType(String className, String locale)
120: throws RepositoryException;
121:
122: /**
123: * Finds meta-data for all calendars. This method is intended to support
124: * design-time clients and management applications.
125: *
126: * @return The list of all calendars.
127: * @throws RepositoryException if an error occurred.
128: */
129: CalendarMetaData[] findCalendarMetaData()
130: throws RepositoryException;
131:
132: /**
133: * Finds meta-data for a calendar. This method is intended to support
134: * design-time clients and management applications.
135: *
136: * @param id The calendar ID.
137: * @return Meta-data about the requested calendar.
138: * @throws ObjectNotFoundException if the
139: * calendar ID is not registered.
140: * @throws RepositoryException if some other error occurred.
141: */
142: CalendarMetaData findCalendarMetaData(String id)
143: throws RepositoryException;
144:
145: /**
146: * Finds a calendar. This method is called by the engine at run-time when
147: * it needs to perform a temporal computation using the specified calendar.
148: *
149: * @param id The calendar ID.
150: * @return The requested calendar.
151: * @throws ObjectNotFoundException if the tool ID is not registered.
152: * @throws RepositoryException if some other error occurred.
153: */
154: BusinessCalendar findCalendar(String id) throws RepositoryException;
155: }
|