| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| ParameterService |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright 2006-2011 The Kuali Foundation | |
| 3 | * | |
| 4 | * Licensed under the Educational Community License, Version 2.0 (the "License"); | |
| 5 | * you may not use this file except in compliance with the License. | |
| 6 | * You may obtain a copy of the License at | |
| 7 | * | |
| 8 | * http://www.opensource.org/licenses/ecl2.php | |
| 9 | * | |
| 10 | * Unless required by applicable law or agreed to in writing, software | |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| 13 | * See the License for the specific language governing permissions and | |
| 14 | * limitations under the License. | |
| 15 | */ | |
| 16 | ||
| 17 | package org.kuali.rice.core.framework.parameter; | |
| 18 | ||
| 19 | import org.kuali.rice.core.api.parameter.Parameter; | |
| 20 | ||
| 21 | import java.util.Collection; | |
| 22 | ||
| 23 | /** | |
| 24 | * This service is used by krad to interact with {@link Parameter Parameters}. | |
| 25 | * | |
| 26 | * <p> | |
| 27 | * Generally krad client applications will want to use this service since it contains many convenient methods. | |
| 28 | * </p> | |
| 29 | * | |
| 30 | * <p> | |
| 31 | * This service can be viewed a convenient wrapper around the {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService}. | |
| 32 | * Please see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService} for details on the behavior of this service. | |
| 33 | * </p> | |
| 34 | */ | |
| 35 | public interface ParameterService { | |
| 36 | ||
| 37 | /** | |
| 38 | * This will create a {@link Parameter} exactly like the parameter passed in. | |
| 39 | * | |
| 40 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#createParameter(org.kuali.rice.core.api.parameter.Parameter)} for details | |
| 41 | */ | |
| 42 | Parameter createParameter(Parameter parameter); | |
| 43 | ||
| 44 | /** | |
| 45 | * This will update a {@link Parameter}. | |
| 46 | * | |
| 47 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#updateParameter(org.kuali.rice.core.api.parameter.Parameter)} for details | |
| 48 | */ | |
| 49 | Parameter updateParameter(Parameter parameter); | |
| 50 | ||
| 51 | /** | |
| 52 | * This method checks if a parameter exists. It will never return null. | |
| 53 | * | |
| 54 | * <p> | |
| 55 | * The parameter key is constructed from the following: | |
| 56 | * <ul> | |
| 57 | * <li>namespace code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.NAMESPACE} | |
| 58 | * annotation on the componentClass</li> | |
| 59 | * <li>component code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.COMPONENT} | |
| 60 | * annotation on the componentClass</li> | |
| 61 | * <li>parameter name: from the passed in parameter name</li> | |
| 62 | * <li>application id: from the client configuration of the service implementation</li> | |
| 63 | * </ul> | |
| 64 | * </p> | |
| 65 | * | |
| 66 | * <p> | |
| 67 | * If the parameter does not exist under the application | |
| 68 | * code, then this method will check if the parameter | |
| 69 | * exists under the default rice application id and | |
| 70 | * will return that parameter. | |
| 71 | * </p> | |
| 72 | * | |
| 73 | * @param componentClass the class with the namespace & component annotations | |
| 74 | * @param parameterName the parameter name | |
| 75 | * @return true or false | |
| 76 | * @throws IllegalArgumentException if any arguments are null | |
| 77 | * @throws IllegalStateException if the application id is not configured correctly | |
| 78 | */ | |
| 79 | Boolean parameterExists(Class<?> componentClass, String parameterName); | |
| 80 | ||
| 81 | /** | |
| 82 | * This method checks if a parameter exists. It will never return null. | |
| 83 | * | |
| 84 | * <p> | |
| 85 | * The parameter key is constructed from the following: | |
| 86 | * <ul> | |
| 87 | * <li>namespace code: from the passed in namespace code</li> | |
| 88 | * <li>component code: from the passed in component code</li> | |
| 89 | * <li>parameter name: from the passed in parameter name</li> | |
| 90 | * <li>application id: from the client configuration of the service implementation</li> | |
| 91 | * </ul> | |
| 92 | * </p> | |
| 93 | * | |
| 94 | * <p> | |
| 95 | * If the parameter does not exist under the application | |
| 96 | * code, then this method will check if the parameter | |
| 97 | * exists under the default rice application id and | |
| 98 | * will return that parameter. | |
| 99 | * </p> | |
| 100 | * | |
| 101 | * @param namespaceCode the namespace code | |
| 102 | * @param componentCode the component code | |
| 103 | * @param parameterName the parameter name | |
| 104 | * @return true or false | |
| 105 | * @throws IllegalArgumentException if any arguments are null | |
| 106 | * @throws IllegalStateException if the application id is not configured correctly | |
| 107 | */ | |
| 108 | Boolean parameterExists(String namespaceCode, String componentCode, String parameterName); | |
| 109 | ||
| 110 | /** | |
| 111 | * Retrieves a parameter's string value. | |
| 112 | * | |
| 113 | * <p> | |
| 114 | * The parameter key is constructed from the following: | |
| 115 | * <ul> | |
| 116 | * <li>namespace code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.NAMESPACE} | |
| 117 | * annotation on the componentClass</li> | |
| 118 | * <li>component code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.COMPONENT} | |
| 119 | * annotation on the componentClass</li> | |
| 120 | * <li>parameter name: from the passed in parameter name</li> | |
| 121 | * <li>application id: from the client configuration of the service implementation</li> | |
| 122 | * </ul> | |
| 123 | * </p> | |
| 124 | * | |
| 125 | * @param componentClass the class with the namespace & component annotations | |
| 126 | * @param parameterName the parameter name | |
| 127 | * @return string value or null | |
| 128 | * @throws IllegalArgumentException if any arguments are null | |
| 129 | * @throws IllegalStateException if the application id is not configured correctly | |
| 130 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.core.api.parameter.ParameterKey)} for details | |
| 131 | */ | |
| 132 | String getParameterValueAsString(Class<?> componentClass, String parameterName); | |
| 133 | ||
| 134 | /** | |
| 135 | * Retrieves a parameter's string value. If the parameter is not found the default value will be returned. | |
| 136 | * | |
| 137 | * <p> | |
| 138 | * The parameter key is constructed from the following: | |
| 139 | * <ul> | |
| 140 | * <li>namespace code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.NAMESPACE} | |
| 141 | * annotation on the componentClass</li> | |
| 142 | * <li>component code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.COMPONENT} | |
| 143 | * annotation on the componentClass</li> | |
| 144 | * <li>parameter name: from the passed in parameter name</li> | |
| 145 | * <li>application id: from the client configuration of the service implementation</li> | |
| 146 | * </ul> | |
| 147 | * </p> | |
| 148 | * | |
| 149 | * @param componentClass the class with the namespace & component annotations | |
| 150 | * @param parameterName the parameter name | |
| 151 | * @param defaultValue the value to return is the parameter does not exist. Can be any string value including null | |
| 152 | * @return string value or null | |
| 153 | * @throws IllegalArgumentException if any arguments are null | |
| 154 | * @throws IllegalStateException if the application id is not configured correctly | |
| 155 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.core.api.parameter.ParameterKey)} for details | |
| 156 | */ | |
| 157 | String getParameterValueAsString(Class<?> componentClass, String parameterName, String defaultValue); | |
| 158 | ||
| 159 | ||
| 160 | /** | |
| 161 | * Retrieves a parameter's string value. | |
| 162 | * | |
| 163 | * <p> | |
| 164 | * The parameter key is constructed from the following: | |
| 165 | * <ul> | |
| 166 | * <li>namespace code: from the passed in namespace code</li> | |
| 167 | * <li>component code: from the passed in component code</li> | |
| 168 | * <li>parameter name: from the passed in parameter name</li> | |
| 169 | * <li>application id: from the client configuration of the service implementation</li> | |
| 170 | * </ul> | |
| 171 | * </p> | |
| 172 | * | |
| 173 | * @param namespaceCode the namespace code | |
| 174 | * @param componentCode the component code | |
| 175 | * @param parameterName the parameter name | |
| 176 | * @return string value or null | |
| 177 | * @throws IllegalArgumentException if any arguments are null | |
| 178 | * @throws IllegalStateException if the application id is not configured correctly | |
| 179 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.core.api.parameter.ParameterKey)} for details | |
| 180 | */ | |
| 181 | String getParameterValueAsString(String namespaceCode, String componentCode, String parameterName); | |
| 182 | ||
| 183 | /** | |
| 184 | * Retrieves a parameter's string value. If the parameter is not found the default value will be returned. | |
| 185 | * | |
| 186 | * <p> | |
| 187 | * The parameter key is constructed from the following: | |
| 188 | * <ul> | |
| 189 | * <li>namespace code: from the passed in namespace code</li> | |
| 190 | * <li>component code: from the passed in component code</li> | |
| 191 | * <li>parameter name: from the passed in parameter name</li> | |
| 192 | * <li>application id: from the client configuration of the service implementation</li> | |
| 193 | * </ul> | |
| 194 | * </p> | |
| 195 | * | |
| 196 | * @param namespaceCode the namespace code | |
| 197 | * @param componentCode the component code | |
| 198 | * @param parameterName the parameter name | |
| 199 | * @param defaultValue the value to return is the parameter does not exist. Can be any string value including null | |
| 200 | * @return string value or null | |
| 201 | * @throws IllegalArgumentException if any arguments are null | |
| 202 | * @throws IllegalStateException if the application id is not configured correctly | |
| 203 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getParameterValueAsString(org.kuali.rice.core.api.parameter.ParameterKey)} for details | |
| 204 | */ | |
| 205 | String getParameterValueAsString(String namespaceCode, String componentCode, String parameterName, String defaultValue); | |
| 206 | ||
| 207 | /** | |
| 208 | * Retrieves a parameter's boolean value. | |
| 209 | * | |
| 210 | * <p> | |
| 211 | * The parameter key is constructed from the following: | |
| 212 | * <ul> | |
| 213 | * <li>namespace code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.NAMESPACE} | |
| 214 | * annotation on the componentClass</li> | |
| 215 | * <li>component code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.COMPONENT} | |
| 216 | * annotation on the componentClass</li> | |
| 217 | * <li>parameter name: from the passed in parameter name</li> | |
| 218 | * <li>application id: from the client configuration of the service implementation</li> | |
| 219 | * </ul> | |
| 220 | * </p> | |
| 221 | * | |
| 222 | * @param componentClass the class with the namespace & component annotations | |
| 223 | * @param parameterName the parameter name | |
| 224 | * @return true, false, null | |
| 225 | * @throws IllegalArgumentException if any arguments are null | |
| 226 | * @throws IllegalStateException if the application id is not configured correctly | |
| 227 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getParameterValueAsBoolean(org.kuali.rice.core.api.parameter.ParameterKey)} for details | |
| 228 | */ | |
| 229 | Boolean getParameterValueAsBoolean(Class<?> componentClass, String parameterName); | |
| 230 | ||
| 231 | /** | |
| 232 | * Retrieves a parameter's boolean value. If the parameter is not found the default value will be returned. | |
| 233 | * | |
| 234 | * <p> | |
| 235 | * The parameter key is constructed from the following: | |
| 236 | * <ul> | |
| 237 | * <li>namespace code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.NAMESPACE} | |
| 238 | * annotation on the componentClass</li> | |
| 239 | * <li>component code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.COMPONENT} | |
| 240 | * annotation on the componentClass</li> | |
| 241 | * <li>parameter name: from the passed in parameter name</li> | |
| 242 | * <li>application id: from the client configuration of the service implementation</li> | |
| 243 | * </ul> | |
| 244 | * </p> | |
| 245 | * | |
| 246 | * @param componentClass the class with the namespace & component annotations | |
| 247 | * @param parameterName the parameter name | |
| 248 | * @param defaultValue the value to return is the parameter does not exist. Can be any Boolean value including null | |
| 249 | * @return true, false, or the defaultValue | |
| 250 | * @throws IllegalArgumentException if any arguments are null | |
| 251 | * @throws IllegalStateException if the application id is not configured correctly | |
| 252 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getParameterValueAsBoolean(org.kuali.rice.core.api.parameter.ParameterKey)} for details | |
| 253 | */ | |
| 254 | Boolean getParameterValueAsBoolean(Class<?> componentClass, String parameterName, Boolean defaultValue); | |
| 255 | ||
| 256 | /** | |
| 257 | * Retrieves a parameter's boolean value. | |
| 258 | * | |
| 259 | * <p> | |
| 260 | * The parameter key is constructed from the following: | |
| 261 | * <ul> | |
| 262 | * <li>namespace code: from the passed in namespace code</li> | |
| 263 | * <li>component code: from the passed in component code</li> | |
| 264 | * <li>parameter name: from the passed in parameter name</li> | |
| 265 | * <li>application id: from the client configuration of the service implementation</li> | |
| 266 | * </ul> | |
| 267 | * </p> | |
| 268 | * | |
| 269 | * @param namespaceCode the namespace code | |
| 270 | * @param componentCode the component code | |
| 271 | * @param parameterName the parameter name | |
| 272 | * @return true, false, null | |
| 273 | * @throws IllegalArgumentException if any arguments are null | |
| 274 | * @throws IllegalStateException if the application id is not configured correctly | |
| 275 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getParameterValueAsBoolean(org.kuali.rice.core.api.parameter.ParameterKey)} for details | |
| 276 | */ | |
| 277 | Boolean getParameterValueAsBoolean(String namespaceCode, String componentCode, String parameterName); | |
| 278 | ||
| 279 | /** | |
| 280 | * Retrieves a parameter's boolean value. If the parameter is not found the default value will be returned. | |
| 281 | * | |
| 282 | * <p> | |
| 283 | * The parameter key is constructed from the following: | |
| 284 | * <ul> | |
| 285 | * <li>namespace code: from the passed in namespace code</li> | |
| 286 | * <li>component code: from the passed in component code</li> | |
| 287 | * <li>parameter name: from the passed in parameter name</li> | |
| 288 | * <li>application id: from the client configuration of the service implementation</li> | |
| 289 | * </ul> | |
| 290 | * </p> | |
| 291 | * | |
| 292 | * @param namespaceCode the namespace code | |
| 293 | * @param componentCode the component code | |
| 294 | * @param parameterName the parameter name | |
| 295 | * @param defaultValue the value to return is the parameter does not exist. Can be any Boolean value including null | |
| 296 | * @return true, false, or the defaultValue | |
| 297 | * @throws IllegalArgumentException if any arguments are null | |
| 298 | * @throws IllegalStateException if the application id is not configured correctly | |
| 299 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getParameterValueAsBoolean(org.kuali.rice.core.api.parameter.ParameterKey)} for details | |
| 300 | */ | |
| 301 | Boolean getParameterValueAsBoolean(String namespaceCode, String componentCode, String parameterName, Boolean defaultValue); | |
| 302 | ||
| 303 | /** | |
| 304 | * Retrieves a parameter. | |
| 305 | * | |
| 306 | * <p> | |
| 307 | * The parameter key is constructed from the following: | |
| 308 | * <ul> | |
| 309 | * <li>namespace code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.NAMESPACE} | |
| 310 | * annotation on the componentClass</li> | |
| 311 | * <li>component code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.COMPONENT} | |
| 312 | * annotation on the componentClass</li> | |
| 313 | * <li>parameter name: from the passed in parameter name</li> | |
| 314 | * <li>application id: from the client configuration of the service implementation</li> | |
| 315 | * </ul> | |
| 316 | * </p> | |
| 317 | * | |
| 318 | * @param componentClass the class with the namespace & component annotations | |
| 319 | * @param parameterName the parameter name | |
| 320 | * @return true or false | |
| 321 | * @throws IllegalArgumentException if any arguments are null | |
| 322 | * @throws IllegalStateException if the application id is not configured correctly | |
| 323 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getParameter(org.kuali.rice.core.api.parameter.ParameterKey)} for details | |
| 324 | */ | |
| 325 | Parameter getParameter(Class<?> componentClass, String parameterName); | |
| 326 | ||
| 327 | /** | |
| 328 | * Retrieves a parameter. | |
| 329 | * | |
| 330 | * <p> | |
| 331 | * The parameter key is constructed from the following: | |
| 332 | * <ul> | |
| 333 | * <li>namespace code: from the passed in namespace code</li> | |
| 334 | * <li>component code: from the passed in component code</li> | |
| 335 | * <li>parameter name: from the passed in parameter name</li> | |
| 336 | * <li>application id: from the client configuration of the service implementation</li> | |
| 337 | * </ul> | |
| 338 | * </p> | |
| 339 | * | |
| 340 | * @param namespaceCode the namespace code | |
| 341 | * @param componentCode the component code | |
| 342 | * @param parameterName the parameter name | |
| 343 | * @return true or false | |
| 344 | * @throws IllegalArgumentException if any arguments are null | |
| 345 | * @throws IllegalStateException if the application id is not configured correctly | |
| 346 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getParameter(org.kuali.rice.core.api.parameter.ParameterKey)} for details | |
| 347 | */ | |
| 348 | Parameter getParameter(String namespaceCode, String componentCode, String parameterName); | |
| 349 | ||
| 350 | /** | |
| 351 | * Retrieves a parameter's string values where a parameter contains 0 or more values. | |
| 352 | * | |
| 353 | * <p> | |
| 354 | * The parameter key is constructed from the following: | |
| 355 | * <ul> | |
| 356 | * <li>namespace code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.NAMESPACE} | |
| 357 | * annotation on the componentClass</li> | |
| 358 | * <li>component code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.COMPONENT} | |
| 359 | * annotation on the componentClass</li> | |
| 360 | * <li>parameter name: from the passed in parameter name</li> | |
| 361 | * <li>application id: from the client configuration of the service implementation</li> | |
| 362 | * </ul> | |
| 363 | * </p> | |
| 364 | * | |
| 365 | * @param componentClass the class with the namespace & component annotations | |
| 366 | * @param parameterName the parameter name | |
| 367 | * @return string values or empty Collection | |
| 368 | * @throws IllegalArgumentException if any arguments are null | |
| 369 | * @throws IllegalStateException if the application id is not configured correctly | |
| 370 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getParameterValuesAsString(org.kuali.rice.core.api.parameter.ParameterKey)} for details | |
| 371 | */ | |
| 372 | Collection<String> getParameterValuesAsString(Class<?> componentClass, String parameterName); | |
| 373 | ||
| 374 | /** | |
| 375 | * Retrieves a parameter's string values where a parameter contains 0 or more values. | |
| 376 | * | |
| 377 | * <p> | |
| 378 | * The parameter key is constructed from the following: | |
| 379 | * <ul> | |
| 380 | * <li>namespace code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.NAMESPACE} | |
| 381 | * annotation on the componentClass</li> | |
| 382 | * <li>component code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.COMPONENT} | |
| 383 | * annotation on the componentClass</li> | |
| 384 | * <li>parameter name: from the passed in parameter name</li> | |
| 385 | * <li>application id: from the client configuration of the service implementation</li> | |
| 386 | * </ul> | |
| 387 | * </p> | |
| 388 | * | |
| 389 | * @param namespaceCode the namespace code | |
| 390 | * @param componentCode the component code | |
| 391 | * @param parameterName the parameter name | |
| 392 | * @return string values or empty Collection | |
| 393 | * @throws IllegalArgumentException if any arguments are null | |
| 394 | * @throws IllegalStateException if the application id is not configured correctly | |
| 395 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getParameterValuesAsString(org.kuali.rice.core.api.parameter.ParameterKey)} for details | |
| 396 | */ | |
| 397 | Collection<String> getParameterValuesAsString(String namespaceCode, String componentCode, String parameterName); | |
| 398 | ||
| 399 | /** | |
| 400 | * Retrieves a subParameter's string value. | |
| 401 | * | |
| 402 | * <p> | |
| 403 | * The parameter key is constructed from the following: | |
| 404 | * <ul> | |
| 405 | * <li>namespace code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.NAMESPACE} | |
| 406 | * annotation on the componentClass</li> | |
| 407 | * <li>component code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.COMPONENT} | |
| 408 | * annotation on the componentClass</li> | |
| 409 | * <li>parameter name: from the passed in parameter name</li> | |
| 410 | * <li>application id: from the client configuration of the service implementation</li> | |
| 411 | * </ul> | |
| 412 | * </p> | |
| 413 | * | |
| 414 | * @param componentClass the class with the namespace & component annotations | |
| 415 | * @param parameterName the parameter name | |
| 416 | * @return string value or null | |
| 417 | * @param subParameterName the subParameter name | |
| 418 | * @throws IllegalArgumentException if any arguments are null | |
| 419 | * @throws IllegalStateException if the application id is not configured correctly | |
| 420 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getSubParameterValueAsString(org.kuali.rice.core.api.parameter.ParameterKey, String)} for details | |
| 421 | */ | |
| 422 | String getSubParameterValueAsString(Class<?> componentClass, String parameterName, String subParameterName); | |
| 423 | ||
| 424 | /** | |
| 425 | * Retrieves a subParameter's string value. | |
| 426 | * | |
| 427 | * <p> | |
| 428 | * The parameter key is constructed from the following: | |
| 429 | * <ul> | |
| 430 | * <li>namespace code: from the passed in namespace code</li> | |
| 431 | * <li>component code: from the passed in component code</li> | |
| 432 | * <li>parameter name: from the passed in parameter name</li> | |
| 433 | * <li>application id: from the client configuration of the service implementation</li> | |
| 434 | * </ul> | |
| 435 | * </p> | |
| 436 | * | |
| 437 | * @param namespaceCode the namespace code | |
| 438 | * @param componentCode the component code | |
| 439 | * @param parameterName the parameter name | |
| 440 | * @param subParameterName the subParameter name | |
| 441 | * @return string value or null | |
| 442 | * @throws IllegalArgumentException if any arguments are null | |
| 443 | * @throws IllegalStateException if the application id is not configured correctly | |
| 444 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getSubParameterValueAsString(org.kuali.rice.core.api.parameter.ParameterKey, String)} for details | |
| 445 | */ | |
| 446 | String getSubParameterValueAsString(String namespaceCode, String componentCode, String parameterName, String subParameterName); | |
| 447 | ||
| 448 | /** | |
| 449 | * Retrieves a subParameter's string values where a subParameter contains 0 or more values. | |
| 450 | * | |
| 451 | * <p> | |
| 452 | * The parameter key is constructed from the following: | |
| 453 | * <ul> | |
| 454 | * <li>namespace code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.NAMESPACE} | |
| 455 | * annotation on the componentClass</li> | |
| 456 | * <li>component code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.COMPONENT} | |
| 457 | * annotation on the componentClass</li> | |
| 458 | * <li>parameter name: from the passed in parameter name</li> | |
| 459 | * <li>application id: from the client configuration of the service implementation</li> | |
| 460 | * </ul> | |
| 461 | * </p> | |
| 462 | * | |
| 463 | * @param componentClass the class with the namespace & component annotations | |
| 464 | * @param parameterName the parameter name | |
| 465 | * @param subParameterName the subParameter name | |
| 466 | * @return string values or empty Collection | |
| 467 | * @throws IllegalArgumentException if any arguments are null | |
| 468 | * @throws IllegalStateException if the application id is not configured correctly | |
| 469 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getSubParameterValuesAsString(org.kuali.rice.core.api.parameter.ParameterKey, String)} for details | |
| 470 | */ | |
| 471 | Collection<String> getSubParameterValuesAsString(Class<?> componentClass, String parameterName, String subParameterName); | |
| 472 | ||
| 473 | /** | |
| 474 | * Retrieves a subParameter's string values where a subParameter contains 0 or more values. | |
| 475 | * | |
| 476 | * <p> | |
| 477 | * The parameter key is constructed from the following: | |
| 478 | * <ul> | |
| 479 | * <li>namespace code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.NAMESPACE} | |
| 480 | * annotation on the componentClass</li> | |
| 481 | * <li>component code: from a {@link org.kuali.rice.core.framework.parameter.ParameterConstants.COMPONENT} | |
| 482 | * annotation on the componentClass</li> | |
| 483 | * <li>parameter name: from the passed in parameter name</li> | |
| 484 | * <li>application id: from the client configuration of the service implementation</li> | |
| 485 | * </ul> | |
| 486 | * </p> | |
| 487 | * | |
| 488 | * @param namespaceCode the namespace code | |
| 489 | * @param componentCode the component code | |
| 490 | * @param parameterName the parameter name | |
| 491 | * @param subParameterName the subParameter name | |
| 492 | * @return string values or empty Collection | |
| 493 | * @throws IllegalArgumentException if any arguments are null | |
| 494 | * @throws IllegalStateException if the application id is not configured correctly | |
| 495 | * @see {@link org.kuali.rice.core.api.parameter.ParameterRepositoryService#getSubParameterValuesAsString(org.kuali.rice.core.api.parameter.ParameterKey, String)} for details | |
| 496 | */ | |
| 497 | Collection<String> getSubParameterValuesAsString(String namespaceCode, String componentCode, String parameterName, String subParameterName); | |
| 498 | } |