| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| ExemptionService |
|
| 1.0;1 |
| 1 | /** | |
| 2 | * Copyright 2010 The Kuali Foundation Licensed under the | |
| 3 | * Educational Community License, Version 2.0 (the "License"); you may | |
| 4 | * not use this file except in compliance with the License. You may | |
| 5 | * obtain a copy of the License at | |
| 6 | * | |
| 7 | * http://www.osedu.org/licenses/ECL-2.0 | |
| 8 | * | |
| 9 | * Unless required by applicable law or agreed to in writing, | |
| 10 | * software distributed under the License is distributed on an "AS IS" | |
| 11 | * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express | |
| 12 | * or implied. See the License for the specific language governing | |
| 13 | * permissions and limitations under the License. | |
| 14 | */ | |
| 15 | ||
| 16 | package org.kuali.student.r2.core.exemption.service; | |
| 17 | ||
| 18 | import java.util.List; | |
| 19 | ||
| 20 | import javax.jws.WebParam; | |
| 21 | import javax.jws.WebService; | |
| 22 | import javax.jws.soap.SOAPBinding; | |
| 23 | ||
| 24 | import org.kuali.student.r2.core.exemption.dto.ExemptionInfo; | |
| 25 | import org.kuali.student.r2.core.exemption.dto.ExemptionRequestInfo; | |
| 26 | ||
| 27 | ||
| 28 | import org.kuali.student.r2.common.dto.ContextInfo; | |
| 29 | import org.kuali.student.r2.common.dto.StatusInfo; | |
| 30 | import org.kuali.student.r2.common.dto.ValidationResultInfo; | |
| 31 | ||
| 32 | import org.kuali.student.r2.common.exceptions.AlreadyExistsException; | |
| 33 | import org.kuali.student.r2.common.exceptions.DataValidationErrorException; | |
| 34 | import org.kuali.student.r2.common.exceptions.DoesNotExistException; | |
| 35 | import org.kuali.student.r2.common.exceptions.InvalidParameterException; | |
| 36 | import org.kuali.student.r2.common.exceptions.MissingParameterException; | |
| 37 | import org.kuali.student.r2.common.exceptions.OperationFailedException; | |
| 38 | import org.kuali.student.r2.common.exceptions.PermissionDeniedException; | |
| 39 | import org.kuali.student.r2.common.exceptions.VersionMismatchException; | |
| 40 | import org.kuali.student.r2.common.util.constants.ExemptionServiceConstants; | |
| 41 | ||
| 42 | /** | |
| 43 | * Version: DRAFT - NOT READY FOR RELEASE. | |
| 44 | * | |
| 45 | * The Exemption service stores information to permit a person to be | |
| 46 | * exempted from the enforcement of a restriction, deadline, or | |
| 47 | * statement. | |
| 48 | * | |
| 49 | * The service begins with creating an ExemptionRequest for a | |
| 50 | * person. On approval of an ExemptionRequest, one or more Exemptions | |
| 51 | * are created. There are several types of Exemptions. Exemption types | |
| 52 | * govern what data is stored in the Exemption structure. Current | |
| 53 | * types include: | |
| 54 | * | |
| 55 | * Date Exemption: overrides a Milestone in ATP with a Date | |
| 56 | * Milestone Exemption: overrides a Milestone in ATP with another Milestone | |
| 57 | * | |
| 58 | * The Exemption stores the fact that an exemption has been | |
| 59 | * granted. The interpretation and enforcment of the exemption is | |
| 60 | * performed by the caller of this service. The Exemption service | |
| 61 | * provides the information to override a specific check that occurs | |
| 62 | * somewhere in the system based on one of the above Exemption | |
| 63 | * types. | |
| 64 | * | |
| 65 | * @author tom | |
| 66 | * @since Tue Jun 21 14:22:34 EDT 2011 | |
| 67 | */ | |
| 68 | ||
| 69 | @WebService(name = "ExemptionService", targetNamespace = ExemptionServiceConstants.NAMESPACE) | |
| 70 | @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED) | |
| 71 | ||
| 72 | public interface ExemptionService { | |
| 73 | ||
| 74 | /* | |
| 75 | * This section defines methods used to retrieve an exemption to | |
| 76 | * perform overrides on various checks. A separate set of methods | |
| 77 | * are defined to examine all exemptions that exist. | |
| 78 | */ | |
| 79 | ||
| 80 | /** | |
| 81 | * Retrieves an active effective exemption for a person to | |
| 82 | * override a Milestone. An effective exemption is one with an | |
| 83 | * active state, the current date falls within the effective | |
| 84 | * date range, and the use count is less than the use limit. | |
| 85 | * | |
| 86 | * The MilestoneOverride returns a new milstone. | |
| 87 | * | |
| 88 | * Exemptions may have a qualifier which serves to scope the | |
| 89 | * Exemption. An Exemption that is unqualified is global such that | |
| 90 | * any Exemption that is related to the person and check be | |
| 91 | * returned. Otherwise, the qualifier and qualifier type in the | |
| 92 | * Exemption must match the given qualifier and qualifier type. | |
| 93 | * | |
| 94 | * In the case multiple Exemptions meet the criteria, the | |
| 95 | * implementation chooses the one that expires the soonest. | |
| 96 | * | |
| 97 | * @param checkKey a key indicating the check to which the | |
| 98 | * exemption applies | |
| 99 | * @param personId a unique Id of the Person | |
| 100 | * @param milestoneId a unique key for milestone to exempt | |
| 101 | * @param qualifierTypeKey the key for a qualifier type | |
| 102 | * @param qualifierId the Id for a qualifier | |
| 103 | * @param context Context information containing the principalId | |
| 104 | * and locale information about the caller of service | |
| 105 | * operation | |
| 106 | * @return an Exemption if one exists | |
| 107 | * @throws DoesNotExistException no valid exemption exists | |
| 108 | * @throws InvalidParameterException invalid parameter | |
| 109 | * @throws MissingParameterException missing parameter | |
| 110 | * @throws OperationFailedException unable to complete request | |
| 111 | * @throws PermissionDeniedException authorization failure | |
| 112 | */ | |
| 113 | ExemptionInfo retrieveMilestoneExemption(@WebParam(name = "checkKey") String checkKey, @WebParam(name="personId") String personId, @WebParam(name = "milestoneId") String milestoneId, @WebParam(name = "qualifierTypeKey") String qualifierTypeKey, @WebParam(name = "qualifierId") String qualifierId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 114 | ||
| 115 | /** | |
| 116 | * Retrieves an active effective exemption for a person to | |
| 117 | * override a Milestone. An effective exemption is one with an | |
| 118 | * active state, the current date falls within the effective | |
| 119 | * date range, and the use count is less than the use limit. | |
| 120 | * | |
| 121 | * The DateOverride returns a new date. | |
| 122 | * | |
| 123 | * Exemptions may have a qualifier which serves to scope the | |
| 124 | * Exemption. An Exemption that is unqualified is global such that | |
| 125 | * any Exemption that is related to the person and check be | |
| 126 | * returned. Otherwise, the qualifier and qualifier type in the | |
| 127 | * Exemption must match the given qualifier and qualifier type. | |
| 128 | * | |
| 129 | * In the case multiple Exemptions meet the criteria, the | |
| 130 | * implementation chooses the one that expires the soonest. | |
| 131 | * | |
| 132 | * @param checkKey a key indicating the check to which the | |
| 133 | * exemption applies | |
| 134 | * @param personId a unique Id of the Person | |
| 135 | * @param milestoneId a unique key for milestone to exempt | |
| 136 | * @param qualifierTypeKey the key for a qualifier type | |
| 137 | * @param qualifierId the Id for a qualifier | |
| 138 | * @param context Context information containing the principalId | |
| 139 | * and locale information about the caller of service | |
| 140 | * operation | |
| 141 | * @return an Exemption if one exists | |
| 142 | * @throws DoesNotExistException no valid exemption exists | |
| 143 | * @throws InvalidParameterException invalid parameter | |
| 144 | * @throws MissingParameterException missing parameter | |
| 145 | * @throws OperationFailedException unable to complete request | |
| 146 | * @throws PermissionDeniedException authorization failure | |
| 147 | */ | |
| 148 | ExemptionInfo retrieveDateExemption(@WebParam(name = "checkKey") String checkKey, @WebParam(name="personId") String personId, @WebParam(name = "milestoneId") String milestoneId, @WebParam(name = "qualifierTypeKey") String qualifierTypeKey, @WebParam(name = "qualifierId") String qualifierId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 149 | ||
| 150 | /** | |
| 151 | * Indicate that the given Exemption has been used successfully in | |
| 152 | * a transaction. This method increments the Exemption use count. | |
| 153 | * | |
| 154 | * @param exemptionId the Id for the Exemption | |
| 155 | * @param context Context information containing the principalId | |
| 156 | * and locale information about the caller of service | |
| 157 | * operation | |
| 158 | * @return the status | |
| 159 | * @throws DoesNotExistException no valid exemption exists | |
| 160 | * @throws InvalidParameterException invalid parameter | |
| 161 | * @throws MissingParameterException missing parameter | |
| 162 | * @throws OperationFailedException unable to complete request | |
| 163 | * @throws PermissionDeniedException authorization failure | |
| 164 | */ | |
| 165 | StatusInfo addUseToExemption(@WebParam(name = "exeptionId") String exemptionId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 166 | ||
| 167 | ||
| 168 | /* | |
| 169 | * This set of methods examines all Exemptions as it | |
| 170 | * related to a person. | |
| 171 | */ | |
| 172 | ||
| 173 | /** | |
| 174 | * Gets a list of all exemptions for a Person. | |
| 175 | * | |
| 176 | * @param personId a unique Id of the Person | |
| 177 | * @param context Context information containing the principalId | |
| 178 | * and locale information about the caller of service | |
| 179 | * operation | |
| 180 | * @return a list of Exemptions | |
| 181 | * @throws InvalidParameterException invalid parameter | |
| 182 | * @throws MissingParameterException missing parameter | |
| 183 | * @throws OperationFailedException unable to complete request | |
| 184 | * @throws PermissionDeniedException authorization failure | |
| 185 | */ | |
| 186 | public List<ExemptionInfo> getExemptionsForPerson(@WebParam(name = "personId") String personId, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 187 | ||
| 188 | /** | |
| 189 | * Gets a list of all active effective exemptions for a Person. An | |
| 190 | * effective exemption is one with an active state, the current | |
| 191 | * date falls within the effective date range, and the use count | |
| 192 | * is less than the use limit. | |
| 193 | * | |
| 194 | * @param personId a unique Id of the Person | |
| 195 | * @param context Context information containing the principalId | |
| 196 | * and locale information about the caller of service | |
| 197 | * operation | |
| 198 | * @return a list of Exemptions | |
| 199 | * @throws InvalidParameterException invalid parameter | |
| 200 | * @throws MissingParameterException missing parameter | |
| 201 | * @throws OperationFailedException unable to complete request | |
| 202 | * @throws PermissionDeniedException authorization failure | |
| 203 | */ | |
| 204 | public List<ExemptionInfo> getActiveExemptionsForPerson(@WebParam(name = "personId") String personId, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 205 | ||
| 206 | /** | |
| 207 | * Gets a list of all exemptions by Type for a Person. | |
| 208 | * | |
| 209 | * @param typeKey an exemption Type | |
| 210 | * @param personId a unique Id of the Person | |
| 211 | * @param context Context information containing the principalId | |
| 212 | * and locale information about the caller of service | |
| 213 | * operation | |
| 214 | * @return a list of Exemptions | |
| 215 | * @throws InvalidParameterException invalid parameter | |
| 216 | * @throws MissingParameterException missing parameter | |
| 217 | * @throws OperationFailedException unable to complete request | |
| 218 | * @throws PermissionDeniedException authorization failure | |
| 219 | */ | |
| 220 | public List<ExemptionInfo> getExemptionsByTypeForPerson(@WebParam(name = "typeKey") String typeKey, @WebParam(name = "personId") String personId, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 221 | ||
| 222 | /** | |
| 223 | * Gets a list of all effective exemptions by Type for a | |
| 224 | * Person. An effective exemption is one with an active state, the | |
| 225 | * current date falls within the effective date range, and the use | |
| 226 | * count is less than the use limit. | |
| 227 | * | |
| 228 | * @param typeKey an exemption Type | |
| 229 | * @param personId a unique Id of the Person | |
| 230 | * @param context Context information containing the principalId | |
| 231 | * and locale information about the caller of service | |
| 232 | * operation | |
| 233 | * @return a list of Exemptions | |
| 234 | * @throws InvalidParameterException invalid parameter | |
| 235 | * @throws MissingParameterException missing parameter | |
| 236 | * @throws OperationFailedException unable to complete request | |
| 237 | * @throws PermissionDeniedException authorization failure | |
| 238 | */ | |
| 239 | public List<ExemptionInfo> getActiveExemptionsByTypeForPerson(@WebParam(name = "typeKey") String typeKey, @WebParam(name = "personId") String personId, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 240 | ||
| 241 | /** | |
| 242 | * Gets a list of all effective exemptions by Type, Process and check for a | |
| 243 | * Person. An effective exemption is one with an active state, the | |
| 244 | * current date falls within the effective date range, and the use | |
| 245 | * count is less than the use limit. | |
| 246 | * | |
| 247 | * @param typeKey an exemption Type | |
| 248 | * @param personId a unique Id of the Person | |
| 249 | * @param context Context information containing the principalId | |
| 250 | * and locale information about the caller of service | |
| 251 | * operation | |
| 252 | * @return a list of Exemptions | |
| 253 | * @throws InvalidParameterException invalid parameter | |
| 254 | * @throws MissingParameterException missing parameter | |
| 255 | * @throws OperationFailedException unable to complete request | |
| 256 | * @throws PermissionDeniedException authorization failure | |
| 257 | */ | |
| 258 | public List<ExemptionInfo> getActiveExemptionsByTypeProcessAndCheckForPerson(String typeKey, String processKey, String checkKey, String personId, ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 259 | ||
| 260 | ||
| 261 | /* | |
| 262 | * This section defines the standard crud pattern for | |
| 263 | * managing Exemptions and requests. | |
| 264 | */ | |
| 265 | ||
| 266 | /** | |
| 267 | * Retrieves the details of a single Exemption by a exemption Id. | |
| 268 | * | |
| 269 | * @param exemptionId Unique Id of the Exemption to be retrieved | |
| 270 | * @param context Context information containing the principalId | |
| 271 | * and locale information about the caller of service | |
| 272 | * operation | |
| 273 | * @return the details of the Exemption requested | |
| 274 | * @throws DoesNotExistException exemptionId not found | |
| 275 | * @throws InvalidParameterException invalid parameter | |
| 276 | * @throws MissingParameterException missing parameter | |
| 277 | * @throws OperationFailedException unable to complete request | |
| 278 | * @throws PermissionDeniedException authorization failure | |
| 279 | */ | |
| 280 | public ExemptionInfo getExemption(@WebParam(name = "exemptionId") String exemptionId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 281 | ||
| 282 | /** | |
| 283 | * Retrieves a list Exemptions corresponding to a list of | |
| 284 | * exemption Ids. | |
| 285 | * | |
| 286 | * @param exemptionIds list of unique Ids of the | |
| 287 | * Exemption to be retrieved | |
| 288 | * @param context Context information containing the principalId | |
| 289 | * and locale information about the caller of service | |
| 290 | * operation | |
| 291 | * @return a list of Exemptions | |
| 292 | * @throws DoesNotExistException an exemptionId in list not found | |
| 293 | * @throws InvalidParameterException invalid parameter | |
| 294 | * @throws MissingParameterException missing parameter | |
| 295 | * @throws OperationFailedException unable to complete request | |
| 296 | * @throws PermissionDeniedException authorization failure | |
| 297 | */ | |
| 298 | public List<ExemptionInfo> getExemptionsByIds(@WebParam(name = "exemptionIds") List<String> exemptionIds, | |
| 299 | @WebParam(name = "context") ContextInfo context) | |
| 300 | throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 301 | ||
| 302 | /** | |
| 303 | * Retrieves a list Exemption Ids by Type. | |
| 304 | * | |
| 305 | * @param exemptionTypeKey a unique key for an exemption Type | |
| 306 | * @param context Context information containing the principalId | |
| 307 | * and locale information about the caller of service | |
| 308 | * operation | |
| 309 | * @return a list of Exemptions | |
| 310 | * @throws DoesNotExistException an exemptionId in list not found | |
| 311 | * @throws InvalidParameterException invalid parameter | |
| 312 | * @throws MissingParameterException missing parameter | |
| 313 | * @throws OperationFailedException unable to complete request | |
| 314 | * @throws PermissionDeniedException authorization failure | |
| 315 | */ | |
| 316 | public List<String> getExemptionIdsByType(@WebParam(name = "exemptionTypeKey") String exemptionTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 317 | ||
| 318 | /** | |
| 319 | * Validates an Exemption. Depending on the value of validationType, | |
| 320 | * this validation could be limited to tests on just the current | |
| 321 | * object and its directly contained subobjects or expanded to | |
| 322 | * perform all tests related to this object. If an identifier is | |
| 323 | * present for the exemption and a record is found for that identifier, | |
| 324 | * the validation checks if the exemption can be shifted to the new | |
| 325 | * values. If a record cannot be found for the identifier, it is | |
| 326 | * assumed that the record does not exist and as such, the checks | |
| 327 | * performed will be much shallower, typically mimicking those | |
| 328 | * performed by setting the validationType to the current | |
| 329 | * object. This is a slightly different pattern from the standard | |
| 330 | * validation as the caller provides the identifier in the create | |
| 331 | * statement instead of the server assigning an identifier. | |
| 332 | * | |
| 333 | * @param validationTypeKey Identifier of the extent of validation | |
| 334 | * @param exemptionInfo the exemption information to be tested. | |
| 335 | * @param context Context information containing the principalId | |
| 336 | * and locale information about the caller of service | |
| 337 | * operation | |
| 338 | * @return the results from performing the validation | |
| 339 | * @throws DoesNotExistException validationTypeKey not found | |
| 340 | * @throws InvalidParameterException invalid validationTypeKey, exemptionInfo | |
| 341 | * @throws MissingParameterException missing validationTypeKey, exemptionInfo | |
| 342 | * @throws OperationFailedException unable to complete request | |
| 343 | */ | |
| 344 | public List<ValidationResultInfo> validateExemption(@WebParam(name = "validationTypeKey") String validationTypeKey, @WebParam(name = "exemptionInfo") ExemptionInfo exemptionInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 345 | ||
| 346 | /** | |
| 347 | * Creates a new Exemption. Exemptions can only be created off of | |
| 348 | * an exemption request. | |
| 349 | * | |
| 350 | * @param exemptionRequestId an Id for an exemption request | |
| 351 | * @param exemptionInfo Details of the Exemption to be created | |
| 352 | * @param context Context information containing the principalId | |
| 353 | * and locale information about the caller of service | |
| 354 | * operation | |
| 355 | * @return the details of the Exemption just created | |
| 356 | * @throws AlreadyExistsException the Exemption being created already exists | |
| 357 | * @throws DataValidationErrorException One or more values invalid for | |
| 358 | * this operation | |
| 359 | * @throws InvalidParameterException One or more parameters invalid | |
| 360 | * @throws MissingParameterException One or more parameters missing | |
| 361 | * @throws OperationFailedException unable to complete request | |
| 362 | * @throws PermissionDeniedException authorization failure | |
| 363 | */ | |
| 364 | public ExemptionInfo createExemption(@WebParam(name = "exemptionRequestId") String exemptionRequestId, @WebParam(name = "exemptionInfo") ExemptionInfo exemptionInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 365 | ||
| 366 | /** | |
| 367 | * Updates an existing Exemption. | |
| 368 | * | |
| 369 | * @param exemptionId Id of Exemption to be updated | |
| 370 | * @param exemptionInfo Details of updates to the Exemption | |
| 371 | * being updated | |
| 372 | * @param context Context information containing the principalId | |
| 373 | * and locale information about the caller of service | |
| 374 | * operation | |
| 375 | * @return the details of Exemption just updated | |
| 376 | * @throws DataValidationErrorException One or more values invalid for this | |
| 377 | * operation | |
| 378 | * @throws DoesNotExistException the Exemption does not exist | |
| 379 | * @throws InvalidParameterException One or more parameters invalid | |
| 380 | * @throws MissingParameterException One or more parameters missing | |
| 381 | * @throws OperationFailedException unable to complete request | |
| 382 | * @throws PermissionDeniedException authorization failure | |
| 383 | * @throws VersionMismatchException The action was attempted on an out of date | |
| 384 | * version. | |
| 385 | */ | |
| 386 | public ExemptionInfo updateExemption(@WebParam(name = "exemptionId") String exemptionId, @WebParam(name = "exemptionInfo") ExemptionInfo exemptionInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException; | |
| 387 | ||
| 388 | /** | |
| 389 | * Deletes an existing Exemption record. | |
| 390 | * | |
| 391 | * @param exemptionId the Id of the Exemption to be deleted | |
| 392 | * @param context Context information containing the principalId | |
| 393 | * and locale information about the caller of service | |
| 394 | * operation | |
| 395 | * @return status of the operation (success, failed) | |
| 396 | * @throws DoesNotExistException the Exemption does not exist | |
| 397 | * @throws InvalidParameterException One or more parameters invalid | |
| 398 | * @throws MissingParameterException One or more parameters missing | |
| 399 | * @throws OperationFailedException unable to complete request | |
| 400 | * @throws PermissionDeniedException authorization failure | |
| 401 | */ | |
| 402 | public StatusInfo deleteExemption(@WebParam(name = "exemptionId") String exemptionId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 403 | ||
| 404 | /** | |
| 405 | * Gets a list of all exemption requests for a Person. | |
| 406 | * | |
| 407 | * @param personId a unique Id of the Person | |
| 408 | * @param context Context information containing the principalId | |
| 409 | * and locale information about the caller of service | |
| 410 | * operation | |
| 411 | * @return a list of Exemptions | |
| 412 | * @throws InvalidParameterException invalid parameter | |
| 413 | * @throws MissingParameterException missing parameter | |
| 414 | * @throws OperationFailedException unable to complete request | |
| 415 | * @throws PermissionDeniedException authorization failure | |
| 416 | */ | |
| 417 | public List<ExemptionRequestInfo> getRequestsForPerson(@WebParam(name = "personId") String personId, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 418 | ||
| 419 | /** | |
| 420 | * Gets a list of all exemption requests by Type for a Person. | |
| 421 | * | |
| 422 | * @param typeKey an exemption Type | |
| 423 | * @param personId a unique Id of the Person | |
| 424 | * @param context Context information containing the principalId | |
| 425 | * and locale information about the caller of service | |
| 426 | * operation | |
| 427 | * @return a list of Exemptions | |
| 428 | * @throws InvalidParameterException invalid parameter | |
| 429 | * @throws MissingParameterException missing parameter | |
| 430 | * @throws OperationFailedException unable to complete request | |
| 431 | * @throws PermissionDeniedException authorization failure | |
| 432 | */ | |
| 433 | public List<ExemptionRequestInfo> getRequestsByTypeForPerson(@WebParam(name = "typeKey") String typeKey, @WebParam(name = "personId") String personId, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 434 | ||
| 435 | /** | |
| 436 | * Retrieves the details of a single ExemptionRequest by a | |
| 437 | * exemption Id. | |
| 438 | * | |
| 439 | * @param exemptionRequestId Unique Id of the ExemptionRequest to be retrieved | |
| 440 | * @param context Context information containing the principalId | |
| 441 | * and locale information about the caller of service | |
| 442 | * operation | |
| 443 | * @return the details of the ExemptionRequest requested | |
| 444 | * @throws DoesNotExistException exemptionRequestId not found | |
| 445 | * @throws InvalidParameterException invalid exemptionRequestId | |
| 446 | * @throws MissingParameterException missing exemptionRequestId | |
| 447 | * @throws OperationFailedException unable to complete request | |
| 448 | * @throws PermissionDeniedException authorization failure | |
| 449 | */ | |
| 450 | public ExemptionRequestInfo getExemptionRequest(@WebParam(name = "exemptionRequestId") String exemptionRequestId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 451 | ||
| 452 | /** | |
| 453 | * Retrieves a list ExemptionRequests corresponding to a list of | |
| 454 | * exemption request Ids. | |
| 455 | * | |
| 456 | * @param exemptionRequestIds list of unique Ids of the | |
| 457 | * ExemptionRequests to be retrieved | |
| 458 | * @param context Context information containing the principalId | |
| 459 | * and locale information about the caller of service | |
| 460 | * operation | |
| 461 | * @return a list of ExemptionRequests | |
| 462 | * @throws DoesNotExistException an exemptionRequestId in list not found | |
| 463 | * @throws InvalidParameterException invalid exemptionRequestId in list | |
| 464 | * @throws MissingParameterException missing exemptionRequestIds | |
| 465 | * @throws OperationFailedException unable to complete request | |
| 466 | * @throws PermissionDeniedException authorization failure | |
| 467 | */ | |
| 468 | public List<ExemptionRequestInfo> getExemptionRequestsByIds(@WebParam(name = "exemptionRequestIds") List<String> exemptionRequestIds, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 469 | ||
| 470 | /** | |
| 471 | * Retrieves a list Exemption Request Ids by Type. | |
| 472 | * | |
| 473 | * @param exemptionRequestTypeKey a unique key for an exemption | |
| 474 | * requestType | |
| 475 | * @param context Context information containing the principalId | |
| 476 | * and locale information about the caller of service | |
| 477 | * operation | |
| 478 | * @return a list of Exemptions | |
| 479 | * @throws DoesNotExistException an exemptionId in list not found | |
| 480 | * @throws InvalidParameterException invalid parameter | |
| 481 | * @throws MissingParameterException missing parameter | |
| 482 | * @throws OperationFailedException unable to complete request | |
| 483 | * @throws PermissionDeniedException authorization failure | |
| 484 | */ | |
| 485 | public List<String> getExemptionRequestIdsByType(@WebParam(name = "exemptionRequestTypeKey") String exemptionRequestTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 486 | ||
| 487 | /** | |
| 488 | * Retrieves a list Exemption Request Ids by Check Key. | |
| 489 | * | |
| 490 | * @param checkKey a unique key for a Check | |
| 491 | * @param context Context information containing the principalId | |
| 492 | * and locale information about the caller of service | |
| 493 | * operation | |
| 494 | * @return a list of Exemptions | |
| 495 | * @throws InvalidParameterException invalid parameter | |
| 496 | * @throws MissingParameterException missing parameter | |
| 497 | * @throws OperationFailedException unable to complete request | |
| 498 | * @throws PermissionDeniedException authorization failure | |
| 499 | */ | |
| 500 | public List<String> getExemptionRequestIdsByCheck(@WebParam(name = "checkKey") String checkKey, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 501 | ||
| 502 | /** | |
| 503 | * Validates an ExemptionRequest. Depending on the value of | |
| 504 | * validationType, this validation could be limited to tests on | |
| 505 | * just the current object and its directly contained subobjects | |
| 506 | * or expanded to perform all tests related to this object. If an | |
| 507 | * identifier is present for the exemption request and a record is | |
| 508 | * found for that identifier, the validation checks if the | |
| 509 | * exemption request can be shifted to the new values. If a record | |
| 510 | * cannot be found for the identifier, it is assumed that the | |
| 511 | * record does not exist and as such, the checks performed will be | |
| 512 | * much shallower, typically mimicking those performed by setting | |
| 513 | * the validationType to the current object. This is a slightly | |
| 514 | * different pattern from the standard validation as the caller | |
| 515 | * provides the identifier in the create statement instead of the | |
| 516 | * server assigning an identifier. | |
| 517 | * | |
| 518 | * @param validationTypeKey Identifier of the extent of validation | |
| 519 | * @param exemptionRequestInfo the exemption request information to be tested. | |
| 520 | * @param context Context information containing the principalId | |
| 521 | * and locale information about the caller of service | |
| 522 | * operation | |
| 523 | * @return the results from performing the validation | |
| 524 | * @throws DoesNotExistException validationTypeKey not found | |
| 525 | * @throws InvalidParameterException invalid validationTypeKey, exemptionRequestInfo | |
| 526 | * @throws MissingParameterException missing validationTypeKey, exemptionRequestInfo | |
| 527 | * @throws OperationFailedException unable to complete request | |
| 528 | */ | |
| 529 | public List<ValidationResultInfo> validateExemptionRequest(@WebParam(name = "validationTypeKey") String validationTypeKey, @WebParam(name = "exemptionRequestInfo") ExemptionRequestInfo exemptionRequestInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 530 | ||
| 531 | /** | |
| 532 | * Creates a new ExemptionRequst. | |
| 533 | * | |
| 534 | * @param exemptionRequestInfo Details of the Exemption Request to be created | |
| 535 | * @param context Context information containing the principalId | |
| 536 | * and locale information about the caller of service | |
| 537 | * operation | |
| 538 | * @return the details of the Exemption Requst just created | |
| 539 | * @throws AlreadyExistsException the Exemption Request being | |
| 540 | * created already exists | |
| 541 | * @throws DataValidationErrorException One or more values invalid for | |
| 542 | * this operation | |
| 543 | * @throws InvalidParameterException One or more parameters invalid | |
| 544 | * @throws MissingParameterException One or more parameters missing | |
| 545 | * @throws OperationFailedException unable to complete request | |
| 546 | * @throws PermissionDeniedException authorization failure | |
| 547 | */ | |
| 548 | public ExemptionRequestInfo createExemptionRequest(@WebParam(name = "exemptionRequestInfo") ExemptionRequestInfo exemptionRequestInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 549 | ||
| 550 | /** | |
| 551 | * Updates an existing Exemption Request. | |
| 552 | * | |
| 553 | * @param exemptionRequestId Id of Exemption Request to be updated | |
| 554 | * @param exemptionRequestInfo Details of updates to the Exemption | |
| 555 | * Request being updated | |
| 556 | * @param context Context information containing the principalId | |
| 557 | * and locale information about the caller of service | |
| 558 | * operation | |
| 559 | * @return the details of Exemption Request just updated | |
| 560 | * @throws DataValidationErrorException One or more values invalid for this | |
| 561 | * operation | |
| 562 | * @throws DoesNotExistException the Exemption Request does not exist | |
| 563 | * @throws InvalidParameterException One or more parameters invalid | |
| 564 | * @throws MissingParameterException One or more parameters missing | |
| 565 | * @throws OperationFailedException unable to complete request | |
| 566 | * @throws PermissionDeniedException authorization failure | |
| 567 | * @throws VersionMismatchException The action was attempted on an out of date | |
| 568 | * version. | |
| 569 | */ | |
| 570 | public ExemptionRequestInfo updateExemptionRequest(@WebParam(name = "exemptionRequestId") String exemptionRequestId, @WebParam(name = "exemptionRequestInfo") ExemptionRequestInfo exemptionRequestInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException; | |
| 571 | ||
| 572 | /** | |
| 573 | * Deletes an existing Exemption Request record. | |
| 574 | * | |
| 575 | * @param exemptionRequestId the Id of the Exemption Request to be deleted | |
| 576 | * @param context Context information containing the principalId | |
| 577 | * and locale information about the caller of service | |
| 578 | * operation | |
| 579 | * @return status of the operation (success, failed) | |
| 580 | * @throws DoesNotExistException the Exemption Request does not exist | |
| 581 | * @throws InvalidParameterException One or more parameters invalid | |
| 582 | * @throws MissingParameterException One or more parameters missing | |
| 583 | * @throws OperationFailedException unable to complete request | |
| 584 | * @throws PermissionDeniedException authorization failure | |
| 585 | */ | |
| 586 | public StatusInfo deleteExemptionRequest(@WebParam(name = "exemptionRequestId") String exemptionRequestId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 587 | } |