summaryrefslogtreecommitdiffstats
path: root/ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/service/RoleService.java
blob: 12c9d59eeb8187feb53961d792c59e1145ebe102 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/*
 * ============LICENSE_START==========================================
 * ONAP Portal SDK
 * ===================================================================
 * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * ===================================================================
 *
 * Unless otherwise specified, all software contained herein is licensed
 * under the Apache License, Version 2.0 (the “License”);
 * you may not use this software except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *             http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Unless otherwise specified, all documentation contained herein is licensed
 * under the Creative Commons License, Attribution 4.0 Intl. (the “License”);
 * you may not use this documentation except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *             https://creativecommons.org/licenses/by/4.0/
 *
 * Unless required by applicable law or agreed to in writing, documentation
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * ============LICENSE_END============================================
 *
 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 */
package org.onap.portalsdk.core.service;

import java.util.List;

import org.onap.portalsdk.core.domain.Role;
import org.onap.portalsdk.core.domain.RoleFunction;


public interface RoleService {
	/**
	 * 
	 * @param requestedLoginId loginId
	 * @return returns List of RoleFunction
	 * @throws Exception
	 * Method getRoleFunctions returns list of Role Functions
	 */
	List<RoleFunction> getRoleFunctions(String requestedLoginId) throws Exception;
	
	
	/**
	 * 
	 * @param requestedLoginId
	 * @param roleId
	 * @return returns List of Role
	 * @throws Exception
	 * Method getAvailableChildRoles returns list of avialable child roles
	 */
	List<Role> getAvailableChildRoles(String requestedLoginId,Long roleId) throws Exception;
	
	
	/**
	 * 
	 * @param requestedLoginId
	 * @param id roleId
	 * @return returns role 
	 * @throws Exception
	 * Method getRole returns Role object if requested roleID
	 */
	Role getRole(String requestedLoginId,Long id) throws Exception;
	
	/**
	 * 
	 * @param requestedLoginId
	 * @param domainRole Object to be saved
	 * Method saveRole saves the Role Object
	 */
	void saveRole(String requestedLoginId,Role domainRole) throws Exception;
	
	/**
	 * 
	 * @param requestedLoginId
	 * @param domainRole Object to be removed
	 * Method deleteRole deletes the requested Role Object
	 */
	void deleteRole(String requestedLoginId,Role domainRole) throws Exception;
	
	/**
	 * 
	 * @param requestedLoginId
	 * @return returns list of available roles
	 * @throws Exception
	 * Method getAvailableRoles gets the list of available roles
	 */
	
	List<Role> getAvailableRoles(String requestedLoginId) throws Exception;
	
	/**
	 * 
	 * @param requestedLoginId
	 * @return List of active roles
	 * @throws Exception
	 * Method getActiveRoles gets the list of active roles of application
	 * 
	 */
	List<Role> getActiveRoles(String requestedLoginId) throws Exception;

	/**
	 * 
	 * @param requestedLoginId
	 * @param code function code
	 * @return RoleFunction of requested function code
	 * @throws Exception
	 * Method getRoleFunction returns RoleFunction of requested function code
	 */
	RoleFunction getRoleFunction(String requestedLoginId,String code) throws Exception;
	
	/**
	 * 
	 * @param requestedLoginId
	 * @param domainRoleFunction
	 * Method saveRoleFunction saves the requested RoleFunction object
	 */
	void saveRoleFunction(String requestedLoginId,RoleFunction domainRoleFunction) throws Exception;
	
	/**
	 * 
	 * @param requestedLoginId
	 * @param domainRoleFunction
	 * Method deleteRoleFunction deletes the requested RoleFunction object
	 */
	void deleteRoleFunction(String requestedLoginId,RoleFunction domainRoleFunction) throws Exception;
	
	/**
	 * 
	 * @param requestedLoginId
	 * @param id
	 * Method deleteDependcyRoleRecord deletes the requested object
	 */
	void deleteDependcyRoleRecord(String requestedLoginId,Long id);
}