Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
PolicyContext |
|
| 1.0;1 |
1 | /* | |
2 | * Copyright (c) 2009, Swiss Federal Department of Defence Civil Protection and Sport | |
3 | * (http://www.vbs.admin.ch) | |
4 | * Copyright (c) 2009, Ergon Informatik AG (http://www.ergon.ch) | |
5 | * All rights reserved. | |
6 | * | |
7 | * Licensed under the Open Permis License which accompanies this distribution, | |
8 | * and is available at http://www.openpermis.org/BSDlicenceKent.txt | |
9 | */ | |
10 | package org.openpermis.editor.policy.presenter; | |
11 | ||
12 | import org.openpermis.editor.policy.command.CommandDispatcher; | |
13 | import org.openpermis.policy.bean.ActionBean; | |
14 | import org.openpermis.policy.bean.AuthorityBean; | |
15 | import org.openpermis.policy.bean.DomainBean; | |
16 | import org.openpermis.policy.bean.ObligationBean; | |
17 | import org.openpermis.policy.bean.PartBeanFactory; | |
18 | import org.openpermis.policy.bean.PolicyBean; | |
19 | import org.openpermis.policy.bean.TargetBean; | |
20 | ||
21 | ||
22 | /** | |
23 | * Context for policies that provides additional information for presenters. | |
24 | * @since 0.1.0 | |
25 | */ | |
26 | public interface PolicyContext { | |
27 | ||
28 | //---- Methods | |
29 | ||
30 | /** | |
31 | * Returns the policy bean. | |
32 | * @return returns the policy bean. | |
33 | * @since 0.1.0 | |
34 | */ | |
35 | public PolicyBean getPolicyBean (); | |
36 | ||
37 | ||
38 | /** | |
39 | * Returns a part bean factory. | |
40 | * @return returns a part bean factory, never {@code null}. | |
41 | * @since 0.1.0 | |
42 | */ | |
43 | public PartBeanFactory getPartBeanFactory (); | |
44 | ||
45 | /** | |
46 | * Returns the dispatcher for commands that operate on the policy. | |
47 | * @return returns the command dispatcher, never {@code null}. | |
48 | * @since 0.1.0 | |
49 | */ | |
50 | public CommandDispatcher getCommandDispatcher (); | |
51 | ||
52 | /** | |
53 | * Returns the policy pool. | |
54 | * @return Returns the policy pool. | |
55 | * @since 0.1.0 | |
56 | */ | |
57 | public PolicyPartPool<ActionBean> getActionPool (); | |
58 | ||
59 | /** | |
60 | * Returns the pool of obligations. | |
61 | * @return Returns the pool of obligations. | |
62 | * @since 0.3.0 | |
63 | */ | |
64 | public PolicyPartPool<ObligationBean> getObligationPool (); | |
65 | ||
66 | /** | |
67 | * Returns the pool with all authorities. | |
68 | * @return the pool with all authorities. | |
69 | * @since 0.3.0 | |
70 | */ | |
71 | public PolicyPartPool<AuthorityBean> getAuthorityPool (); | |
72 | ||
73 | ||
74 | /** | |
75 | * Returns the policy pool. | |
76 | * @return Returns the policy pool. | |
77 | * @since 0.1.0 | |
78 | */ | |
79 | public PolicyPartPool<DomainBean> getResourceDomainPool (); | |
80 | ||
81 | /** | |
82 | * Returns the policy pool. | |
83 | * @return Returns the policy pool. | |
84 | * @since 0.3.0 | |
85 | */ | |
86 | public PolicyPartPool<DomainBean> getSubjectDomainPool (); | |
87 | ||
88 | /** | |
89 | * Returns the policy pool. | |
90 | * @return Returns the policy pool. | |
91 | * @since 0.1.0 | |
92 | */ | |
93 | public PolicyPartPool<TargetBean> getTargetPool (); | |
94 | ||
95 | /** | |
96 | * Returns the policy pool. | |
97 | * @return Returns the policy pool. | |
98 | * @since 0.3.0 | |
99 | */ | |
100 | public PolicyRoleRefPool getRolePool (); | |
101 | ||
102 | } |