01: /*
02: * Copyright 2006 Pentaho Corporation. All rights reserved.
03: * This software was developed by Pentaho Corporation and is provided under the terms
04: * of the Mozilla Public License, Version 1.1, or any later version. You may not use
05: * this file except in compliance with the license. If you need a copy of the license,
06: * please go to http://www.mozilla.org/MPL/MPL-1.1.txt. The Original Code is the Pentaho
07: * BI Platform. The Initial Developer is Pentaho Corporation.
08: *
09: * Software distributed under the Mozilla Public License is distributed on an "AS IS"
10: * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. Please refer to
11: * the license for the specific language governing your rights and limitations.
12: *
13: * @created Jun 17, 2005
14: * @author James Dixon
15: *
16: */
17: package org.pentaho.core.solution;
18:
19: import java.io.*;
20:
21: /**
22: * An OutputDef represents one output parameter in a SequenceDefinition or
23: * ActionDefinition.
24: */
25: public interface IOutputDef {
26:
27: /**
28: * Retrieves the type of the output parameter.
29: *
30: * @return the output parameter type
31: */
32: public String getType();
33:
34: /**
35: * Retrieves the name of the output parameter.
36: *
37: * @return the name of the ouotput parameter
38: */
39: public String getName();
40:
41: /**
42: * Determine whether the value associated with this parameter is a list or
43: * not.
44: *
45: * @return rue if the parameter value is a list, otherwise false
46: */
47: public boolean isList();
48:
49: /**
50: * Sets the value of the output parameter.
51: *
52: * @param value
53: * the value to set
54: */
55: public void setValue(Object value);
56:
57: /**
58: * Retrieve the OutputStream associated with this output parameter.
59: *
60: * @return the OutputStream for this parameter
61: */
62: public OutputStream getOutputStream();
63:
64: /**
65: * Adds the given value to the value list for this output parameter.
66: *
67: * @param value
68: * value to add to the parameter value list.
69: */
70: public void addToList(Object value);
71: }
|