01: /*
02: * $Header: /export/home/cvsroot/MyPersonalizerRepository/MyPersonalizer/Subsystems/Kernel/Sources/es/udc/mypersonalizer/kernel/model/tasks/Task.java,v 1.1.1.1 2004/03/25 12:08:37 fbellas Exp $
03: * $Revision: 1.1.1.1 $
04: * $Date: 2004/03/25 12:08:37 $
05: *
06: * =============================================================================
07: *
08: * Copyright (c) 2003, The MyPersonalizer Development Group
09: * (http://www.tic.udc.es/~fbellas/mypersonalizer/index.html) at
10: * University Of A Coruna
11: * All rights reserved.
12: *
13: * Redistribution and use in source and binary forms, with or without
14: * modification, are permitted provided that the following conditions are met:
15: *
16: * - Redistributions of source code must retain the above copyright notice,
17: * this list of conditions and the following disclaimer.
18: *
19: * - Redistributions in binary form must reproduce the above copyright notice,
20: * this list of conditions and the following disclaimer in the documentation
21: * and/or other materials provided with the distribution.
22: *
23: * - Neither the name of the University Of A Coruna nor the names of its
24: * contributors may be used to endorse or promote products derived from
25: * this software without specific prior written permission.
26: *
27: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37: * POSSIBILITY OF SUCH DAMAGE.
38: *
39: */
40: package es.udc.mypersonalizer.kernel.model.tasks;
41:
42: import java.util.Collection;
43:
44: import es.udc.mypersonalizer.kernel.model.metainfo.MetaProperty;
45: import es.udc.mypersonalizer.kernel.util.exceptions.InternalErrorException;
46:
47: /**
48: * Interface representing a task to be performed with the query-based task
49: * executor administration tool.
50: *
51: * @author Abel Muinho
52: * @since 1.0
53: */
54: public interface Task {
55:
56: /**
57: * Tells if this task can be executed given properties defined by the
58: * metainformation passed.
59: * @param metadata the metainformation.
60: * @return <code>true</code> if the task can be performed with properties
61: * described by the metadata, <code>false</code> otherwise.
62: */
63: public boolean isCompatibleWith(MetaProperty metadata);
64:
65: /**
66: * Executed the task on the given properties.
67: * @param properties a collection of <code>Property</code> objects.
68: * @throws InternalErrorException if the execution of the action fails.
69: */
70: public void execute(Collection properties)
71: throws InternalErrorException;
72:
73: /**
74: * Returns the messages generated during execution. Each of the items of
75: * the collection must be a <code>String</code> or have a custom
76: * <code>toString()</code> method providing a user-readable description.
77: * @return a collection of generated messages.
78: */
79: public Collection getMessages();
80:
81: }
|