View Javadoc

1   /*
2    * Copyright 2010 Fraunhofer Gesellschaft, Munich, Germany,
3    * for its Fraunhofer Institute for Computer Architecture and Software
4    * Technology (FIRST), Berlin, Germany. All rights reserved.
5    * http://www.first.fraunhofer.de/
6    */
7   package net.kwfgrid.gworkflowdl.structure;
8   
9   /***
10   * The operation candidate is an interface that wrappes arbitrary operations.
11   * Implement this class in order to implement your specific operation candidate.
12   *
13   * @author Andreas Hoheisel
14   *         (<a href="http://www.andreas-hoheisel.de">www.andreas-hoheisel.de</a>)
15   * @version $Id: OperationCandidate.java 1344 2010-01-27 15:36:48Z andreas.hoheisel@first.fraunhofer.de $
16   */
17  public interface OperationCandidate extends Owls {
18  
19      static final String DEFAULT_TYPE = null;
20      static final String DEFAULT_RESOURCENAME = null;
21      static final String DEFAULT_OPERATIONNAME = null;
22      static final boolean DEFAULT_SELECTED = false;
23      static final float  DEFAULT_QUALITY   = 0.0f;
24  
25      /***
26       * set selection state of this operation candidate.
27       * @param selected Set to <code>true</code> if candidate has been selected.
28       */
29      void setSelected(boolean selected);
30  
31      /***
32       * set selection state to <code>true</code>
33       */
34      void setSelected();
35  
36      /***
37       * Test if this candidate has been selected.
38       * @return <code>true</code> if candidate has been selected, <code>false</code> otherwise.
39       */
40      boolean isSelected();
41  
42      /***
43       * Set type.
44       */
45      void setType(String type);
46  
47      /***
48       * Get the type.
49       */
50      String getType();
51  
52      /***
53       * Set operation name.
54       */
55      void setOperationName(String name);
56  
57      /***
58       * Get the operation name.
59       */
60      String getOperationName();
61  
62      /***
63       * Set resource name.
64       */
65      void setResourceName(String name);
66  
67      /***
68       * Get resource name.
69       */
70      String getResourceName();
71  
72      /***
73       * Set quality of this candidate.
74       * @param quality Quality as float value ranging from 0 to 1.
75       */
76      void setQuality(float quality);
77  
78      /***
79       * Get quality of this candidate.
80       * @return Quality as float value ranging from 0 to 1.
81       */
82      float getQuality();
83  
84      /***
85       * get abstraction degree of operation
86       * @return  color
87       */
88      int getAbstractionLevel();
89  
90  }