KickJava   Java API By Example, From Geeks To Geeks.

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


1 package org.enhydra.shark.api.client.wfservice;
2
3 /**
4  * Interface used to store mapping information among XPDL participant
5  * definition and shark's WfResource object.
6  * @author Zoran Milakovic
7  */
8 public interface ParticipantMap {
9
10    /**
11     * Sets the Id of participant XPDL definition of this map entry.
12     *
13     * @param id participant XPDL definition id.
14     */
15    public void setParticipantId(String JavaDoc id);
16
17    /**
18     * Returns the Id of participant XPDL definition of this map entry.
19     *
20     * @return participant XPDL definition id.
21     */
22    public String JavaDoc getParticipantId();
23
24    /**
25     * Sets the Id of XPDL package containing participant of this map entry.
26     *
27     * @param id XPDL package id.
28     */
29    public void setPackageId(String JavaDoc id);
30
31    /**
32     * Returns the Id of XPDL package containing participant of this map entry.
33     *
34     * @return XPDL package id.
35     */
36    public String JavaDoc getPackageId();
37
38    /**
39     * Sets the Id of XPDL process definition containing participant
40     * of this map entry. If participant is defined at package level, this
41     * has to be set to null or to empty string.
42     *
43     * @param id XPDL process definition id.
44     */
45    public void setProcessDefinitionId(String JavaDoc id);
46
47    /**
48     * Returns the Id of XPDL process definition containing participant of this
49     * map entry. If participant is defined at package level, this
50     * method returns null or empty string.
51     *
52     * @return XPDL process definition id.
53     */
54    public String JavaDoc getProcessDefinitionId();
55
56    /**
57     * Sets the username of shark's WfResource of this map entry.
58     *
59     * @param username username of shark's WfResource.
60     */
61    public void setUsername(String JavaDoc username);
62
63    /**
64     * Returns the username of shark's WfResource of this map entry.
65     *
66     * @return username of shark's WfResource.
67     */
68    public String JavaDoc getUsername();
69     
70    /**
71     * Returns true is username is usernmae of a group or false if username is
72     * username of a single user.
73     *
74     * @return true is username is usernmae of a group or false if it is
75     * username of a single user.
76     */
77    public boolean getIsGroupUser();
78     
79    /**
80     * Set flag that indicate if the user is a single user or a group of users.
81     *
82     * @param isGroupUser flag that indicate if the user is a single user or
83     * a group of users. true means that the username is usernmae of a group, and
84     * false means that the username is username of a single user.
85     */
86    public void setIsGroupUser(boolean isGroupUser);
87
88 }
89
Popular Tags