KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > shark > api > client > wfservice > ApplicationMap


1 package org.enhydra.shark.api.client.wfservice;
2
3 /**
4  * Interface used to store mapping information among XPDL application
5  * definitions and ToolAgent applications.
6  * @author Zoran Milakovic
7  */

8 public interface ApplicationMap {
9
10    /**
11     * Sets the Id of application XPDL definition of this map entry.
12     *
13     * @param id new application XPDL definition Id.
14     */

15    public void setApplicationDefinitionId(String JavaDoc id);
16
17    /**
18     * Returns the Id of XPDL application definition of this map entry.
19     *
20     * @return Aapplication XPDL definition Id.
21     */

22    public String JavaDoc getApplicationDefinitionId();
23
24    /**
25     * Sets the Id of XPDL package containing application definition of this map
26     * entry.
27     *
28     * @param id XPDL package Id.
29     */

30    public void setPackageId(String JavaDoc id);
31
32    /**
33     * Returns the Id of XPDL package containing application definition of
34     * this map entry.
35     *
36     * @return XPDL package Id.
37     */

38    public String JavaDoc getPackageId();
39
40    /**
41     * Sets the Id of XPDL process definition containing application definition
42     * of this map entry. If application is defined at package level, this
43     * has to be set to null or to an empty string.
44     *
45     * @param id XPDL process definition Id.
46     */

47    public void setProcessDefinitionId(String JavaDoc id);
48
49    /**
50     * Returns the Id of XPDL process definition containing application definition
51     * of this map entry. If application is defined at package level, this
52     * method returns null or empty string.
53     *
54     * @return XPDL process definition Id.
55     */

56    public String JavaDoc getProcessDefinitionId();
57
58    /**
59     * Sets the name of tool agent of this map entry.
60     *
61     * @param name tool agent name.
62     */

63    public void setToolAgentClassName(String JavaDoc name);
64
65    /**
66     * Returns the name of tool agent of this map entry.
67     *
68     * @return Tool agent name.
69     */

70    public String JavaDoc getToolAgentClassName();
71
72    /**
73     * Sets the username needed to connect to tool agent of this map entry.
74     *
75     * @param username username for connection.
76     */

77    public void setUsername(String JavaDoc username);
78
79    /**
80     * Returns the username needed to connect to tool agent of this map entry.
81     *
82     * @return Username for connection.
83     */

84    public String JavaDoc getUsername();
85
86    /**
87     * Sets the password needed to connect to tool agent of this map entry.
88     *
89     * @param password password for connection.
90     */

91    public void setPassword(String JavaDoc password);
92
93    /**
94     * Returns the password needed to connect to tool agent of this map entry.
95     *
96     * @return Password for connection.
97     */

98    public String JavaDoc getPassword();
99
100    /**
101     * Sets the application name to be executed by tool agent of this map entry.
102     *
103     * @param name name of the application to be executed.
104     */

105    public void setApplicationName(String JavaDoc name);
106
107    /**
108     * Returns the application name to be executed by tool agent of this map entry.
109     *
110     * @return Name of the application to be executed.
111     */

112    public String JavaDoc getApplicationName();
113
114    /**
115     * Sets the application mode for application executed by tool agent of this
116     * map entry.
117     *
118     * @param mode application mode.
119     */

120    public void setApplicationMode(Integer JavaDoc mode);
121
122    /**
123     * Returns the application mode for application executed by tool agent of
124     * this map entry.
125     *
126     * @return Application mode.
127     */

128    public Integer JavaDoc getApplicationMode();
129
130 }
131
Popular Tags