| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| LuService |
|
| 1.0;1 |
| 1 | /** | |
| 2 | * Copyright 2010 The Kuali Foundation | |
| 3 | * | |
| 4 | * Licensed under the the Educational Community License, Version 1.0 | |
| 5 | * (the "License"); you may not use this file except in compliance | |
| 6 | * with the License. You may obtain a copy of the License at | |
| 7 | * | |
| 8 | * http://www.opensource.org/licenses/ecl1.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 | |
| 13 | * implied. See the License for the specific language governing | |
| 14 | * permissions and limitations under the License. | |
| 15 | */ | |
| 16 | ||
| 17 | package org.kuali.student.lum.lu.service; | |
| 18 | ||
| 19 | import org.kuali.student.common.exceptions.OperationFailedException; | |
| 20 | import org.kuali.student.common.exceptions.VersionMismatchException; | |
| 21 | import org.kuali.student.common.exceptions.IllegalVersionSequencingException; | |
| 22 | import org.kuali.student.common.exceptions.CircularRelationshipException; | |
| 23 | import org.kuali.student.common.exceptions.MissingParameterException; | |
| 24 | import org.kuali.student.common.exceptions.InvalidParameterException; | |
| 25 | import org.kuali.student.common.exceptions.DataValidationErrorException; | |
| 26 | import org.kuali.student.common.exceptions.DoesNotExistException; | |
| 27 | import org.kuali.student.common.exceptions.PermissionDeniedException; | |
| 28 | import org.kuali.student.common.exceptions.UnsupportedActionException; | |
| 29 | import org.kuali.student.common.exceptions.AlreadyExistsException; | |
| 30 | import org.kuali.student.common.exceptions.DependentObjectsExistException; | |
| 31 | import org.kuali.student.common.dto.ContextInfo; | |
| 32 | import org.kuali.student.core.dictionary.service.DictionaryService; | |
| 33 | import org.kuali.student.core.dto.StatusInfo; | |
| 34 | import org.kuali.student.common.exceptions.*; | |
| 35 | import org.kuali.student.core.search.service.SearchService; | |
| 36 | import org.kuali.student.core.versionmanagement.service.VersionManagementService; | |
| 37 | import org.kuali.student.lum.lu.dto.*; | |
| 38 | ||
| 39 | import javax.jws.WebParam; | |
| 40 | import javax.jws.WebService; | |
| 41 | import javax.jws.soap.SOAPBinding; | |
| 42 | import java.util.Date; | |
| 43 | import java.util.List; | |
| 44 | import org.kuali.student.common.dto.ValidationResultInfo; | |
| 45 | ||
| 46 | ||
| 47 | /** | |
| 48 | * Learning Unit (LU) Service | |
| 49 | * | |
| 50 | * Manages Cannonical Learning Units such as courses and programs that appear in catalogs. | |
| 51 | * | |
| 52 | * Version: 1.0 (Dev) | |
| 53 | * | |
| 54 | * | |
| 55 | * @Author KSContractMojo | |
| 56 | * @Author Tom | |
| 57 | * @Since Thu Mar 3 15:18:59 EST 2011 | |
| 58 | */ | |
| 59 | ||
| 60 | @WebService(name = "LuService", targetNamespace = LuServiceConstants.LU_NAMESPACE) | |
| 61 | @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED) | |
| 62 | ||
| 63 | public interface LuService extends DictionaryService, SearchService, VersionManagementService { | |
| 64 | ||
| 65 | /** | |
| 66 | * Retrieves the list of delivery method types. | |
| 67 | * | |
| 68 | * @param context Context information containing the principalId | |
| 69 | * and locale information about the caller of service | |
| 70 | * operation | |
| 71 | * @return list of delivery method type information | |
| 72 | * @throws OperationFailedException unable to complete request | |
| 73 | */ | |
| 74 | ||
| 75 | public List<DeliveryMethodTypeInfo> getDeliveryMethodTypes(@WebParam(name = "context") ContextInfo context) throws OperationFailedException; | |
| 76 | ||
| 77 | ||
| 78 | /** | |
| 79 | * Retrieves information about a delivery method type. | |
| 80 | * | |
| 81 | * @param deliveryMethodTypeKey Key of the Delivery Method Type | |
| 82 | * @param context Context information containing the principalId | |
| 83 | * and locale information about the caller of service | |
| 84 | * operation | |
| 85 | * @return information about a Delivery Method Type | |
| 86 | * @throws DoesNotExistException deliveryMethodType not found | |
| 87 | * @throws InvalidParameterException invalid deliveryMethodType | |
| 88 | * @throws MissingParameterException missing deliveryMethodType | |
| 89 | * @throws OperationFailedException unable to complete request | |
| 90 | */ | |
| 91 | ||
| 92 | public DeliveryMethodTypeInfo getDeliveryMethodType(@WebParam(name = "deliveryMethodTypeKey") String deliveryMethodTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 93 | ||
| 94 | ||
| 95 | /** | |
| 96 | * Retrieves the list of instructional format types. | |
| 97 | * | |
| 98 | * @return list of instructional format type information | |
| 99 | * @throws OperationFailedException unable to complete request | |
| 100 | */ | |
| 101 | ||
| 102 | public List<InstructionalFormatTypeInfo> getInstructionalFormatTypes(@WebParam(name = "context") ContextInfo context) throws OperationFailedException; | |
| 103 | ||
| 104 | ||
| 105 | /** | |
| 106 | * Retrieves information about a Instructional Format Type. | |
| 107 | * | |
| 108 | * @param instructionalFormatTypeKey Key of the Instructional | |
| 109 | * Format Type | |
| 110 | * @param context Context information containing the principalId | |
| 111 | * and locale information about the caller of service | |
| 112 | * operation | |
| 113 | * @return information about a Instructional Format Type | |
| 114 | * @throws DoesNotExistException instructionalFormatType not found | |
| 115 | * @throws InvalidParameterException invalid instructionalFormatType | |
| 116 | * @throws MissingParameterException missing instructionalFormatType | |
| 117 | * @throws OperationFailedException unable to complete request | |
| 118 | */ | |
| 119 | ||
| 120 | public InstructionalFormatTypeInfo getInstructionalFormatType(@WebParam(name = "instructionalFormatTypeKey") String instructionalFormatTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 121 | ||
| 122 | ||
| 123 | /** | |
| 124 | * Retrieves the list of LU types. | |
| 125 | * | |
| 126 | * @param context Context information containing the principalId | |
| 127 | * and locale information about the caller of service | |
| 128 | * operation | |
| 129 | * @return list of LU type information | |
| 130 | * @throws OperationFailedException unable to complete request | |
| 131 | */ | |
| 132 | ||
| 133 | public List<LuTypeInfo> getLuTypes(@WebParam(name = "context") ContextInfo context) throws OperationFailedException; | |
| 134 | ||
| 135 | ||
| 136 | /** | |
| 137 | * Retrieves information about a LU Type. | |
| 138 | * | |
| 139 | * @param luTypeKey Key of the LU Type | |
| 140 | * @param context Context information containing the principalId | |
| 141 | * and locale information about the caller of service | |
| 142 | * operation | |
| 143 | * @return information about a LU Type | |
| 144 | * @throws DoesNotExistException luType not found | |
| 145 | * @throws InvalidParameterException invalid luType | |
| 146 | * @throws MissingParameterException missing luType | |
| 147 | * @throws OperationFailedException unable to complete request | |
| 148 | */ | |
| 149 | ||
| 150 | public LuTypeInfo getLuType(@WebParam(name = "luTypeKey") String luTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 151 | ||
| 152 | ||
| 153 | /** | |
| 154 | * Retrieves the list of learning unit code types. | |
| 155 | * | |
| 156 | * @param context Context information containing the principalId | |
| 157 | * and locale information about the caller of service | |
| 158 | * operation | |
| 159 | * @return list of lu code type information | |
| 160 | * @throws OperationFailedException unable to complete request | |
| 161 | */ | |
| 162 | ||
| 163 | public List<LuCodeTypeInfo> getLuCodeTypes(@WebParam(name = "context") ContextInfo context) throws OperationFailedException; | |
| 164 | ||
| 165 | ||
| 166 | /** | |
| 167 | * Retrieves information about a learning unit code type. | |
| 168 | * | |
| 169 | * @param luCodeTypeKey Key of the learning unit code type | |
| 170 | * @param context Context information containing the principalId | |
| 171 | * and locale information about the caller of service | |
| 172 | * operation | |
| 173 | * @return information about a learning unit code type | |
| 174 | * @throws DoesNotExistException luCodeTypeKey not found | |
| 175 | * @throws InvalidParameterException invalid luCodeTypeKey | |
| 176 | * @throws MissingParameterException missing luCodeTypeKey | |
| 177 | * @throws OperationFailedException unable to complete request | |
| 178 | */ | |
| 179 | ||
| 180 | public LuCodeTypeInfo getLuCodeType(@WebParam(name = "luCodeTypeKey") String luCodeTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 181 | ||
| 182 | ||
| 183 | /** | |
| 184 | * Retrieves the complete list of LU to LU relation types. | |
| 185 | * | |
| 186 | * @param context Context information containing the principalId | |
| 187 | * and locale information about the caller of service | |
| 188 | * operation | |
| 189 | * @return list of LU to LU relation type information | |
| 190 | * @throws OperationFailedException unable to complete request | |
| 191 | */ | |
| 192 | ||
| 193 | public List<LuLuRelationTypeInfo> getLuLuRelationTypes(@WebParam(name = "context") ContextInfo context) throws OperationFailedException; | |
| 194 | ||
| 195 | ||
| 196 | /** | |
| 197 | * Retrieves the LU to LU relation type. | |
| 198 | * | |
| 199 | * @param luLuRelationTypeKey Key of the LU to LU Relation Type | |
| 200 | * @param context Context information containing the principalId | |
| 201 | * and locale information about the caller of service | |
| 202 | * operation | |
| 203 | * @return LU to LU relation type information | |
| 204 | * @throws OperationFailedException unable to complete request | |
| 205 | * @throws MissingParameterException missing luLuRelationTypeKey | |
| 206 | * @throws DoesNotExistException luLuRelationTypeKey not found | |
| 207 | */ | |
| 208 | ||
| 209 | public LuLuRelationTypeInfo getLuLuRelationType(@WebParam(name = "luLuRelationTypeKey") String luLuRelationTypeKey, @WebParam(name = "context") ContextInfo context) throws OperationFailedException, MissingParameterException, DoesNotExistException; | |
| 210 | ||
| 211 | ||
| 212 | /** | |
| 213 | * Retrieves the list of allowed relation types between the two | |
| 214 | * specified LU Types. | |
| 215 | * | |
| 216 | * @param luTypeKey Key of the first LU Type | |
| 217 | * @param relatedLuTypeKey Key of the second LU Type | |
| 218 | * @param context Context information containing the principalId | |
| 219 | * and locale information about the caller of service | |
| 220 | * operation | |
| 221 | * @return list of LU to LU relation types | |
| 222 | * @throws DoesNotExistException luTypeKey, relatedLuTypeKey not found | |
| 223 | * @throws InvalidParameterException invalid luTypeKey, relatedLuTypeKey | |
| 224 | * @throws MissingParameterException missing luTypeKey, relatedLuTypeKey | |
| 225 | * @throws OperationFailedException unable to complete request | |
| 226 | */ | |
| 227 | ||
| 228 | public List<String> getAllowedLuLuRelationTypesForLuType(@WebParam(name = "luTypeKey") String luTypeKey, @WebParam(name = "relatedLuTypeKey") String relatedLuTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 229 | ||
| 230 | ||
| 231 | /** | |
| 232 | * Retrieves the list of Learning Unit publication types. | |
| 233 | * | |
| 234 | * @param context Context information containing the principalId | |
| 235 | * and locale information about the caller of service | |
| 236 | * operation | |
| 237 | * @return list of Learning Unit publication type information | |
| 238 | * @throws OperationFailedException unable to complete request | |
| 239 | */ | |
| 240 | ||
| 241 | public List<LuPublicationTypeInfo> getLuPublicationTypes(@WebParam(name = "context") ContextInfo context) throws OperationFailedException; | |
| 242 | ||
| 243 | ||
| 244 | /** | |
| 245 | * Retrieves information about a publication type. | |
| 246 | * | |
| 247 | * @param luPublicationTypeKey Key of the Learning Unit Publication | |
| 248 | * Type | |
| 249 | * @param context Context information containing the principalId | |
| 250 | * and locale information about the caller of service | |
| 251 | * operation | |
| 252 | * @return information about a Learning Unit Publication Type | |
| 253 | * @throws DoesNotExistException luPublicationType not found | |
| 254 | * @throws InvalidParameterException invalid luPublicationType | |
| 255 | * @throws MissingParameterException missing luPublicationType | |
| 256 | * @throws OperationFailedException unable to complete request | |
| 257 | */ | |
| 258 | ||
| 259 | public LuPublicationTypeInfo getLuPublicationType(@WebParam(name = "luPublicationTypeKey") String luPublicationTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 260 | ||
| 261 | ||
| 262 | /** | |
| 263 | * Retrieves information about a publication type. | |
| 264 | * | |
| 265 | * @param luTypeKey Key of the LU Type | |
| 266 | * @param context Context information containing the principalId | |
| 267 | * and locale information about the caller of service | |
| 268 | * operation | |
| 269 | * @return list of LU publication types | |
| 270 | * @throws DoesNotExistException luPublicationType not found | |
| 271 | * @throws InvalidParameterException invalid luPublicationType | |
| 272 | * @throws MissingParameterException missing luPublicationType | |
| 273 | * @throws OperationFailedException unable to complete request | |
| 274 | */ | |
| 275 | ||
| 276 | public List<String> getLuPublicationTypesForLuType(@WebParam(name = "luTypeKey") String luTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 277 | ||
| 278 | ||
| 279 | /** | |
| 280 | * Retrieves a list of types for clu result objects. | |
| 281 | * | |
| 282 | * @param context Context information containing the principalId | |
| 283 | * and locale information about the caller of service | |
| 284 | * operation | |
| 285 | * @return list of clu result type information | |
| 286 | * @throws OperationFailedException unable to complete request | |
| 287 | */ | |
| 288 | ||
| 289 | public List<CluResultTypeInfo> getCluResultTypes(@WebParam(name = "context") ContextInfo context) throws OperationFailedException; | |
| 290 | ||
| 291 | ||
| 292 | /** | |
| 293 | * Retrieves information about a publication type. | |
| 294 | * | |
| 295 | * @param cluResultTypeKey Key of the Canonical Learning Unit | |
| 296 | * Result Type | |
| 297 | * @param context Context information containing the principalId | |
| 298 | * and locale information about the caller of service | |
| 299 | * operation | |
| 300 | * @return information about a Learning Unit Publication Type | |
| 301 | * @throws DoesNotExistException luPublicationType not found | |
| 302 | * @throws InvalidParameterException invalid luPublicationType | |
| 303 | * @throws MissingParameterException missing luPublicationType | |
| 304 | * @throws OperationFailedException unable to complete request | |
| 305 | */ | |
| 306 | ||
| 307 | public CluResultTypeInfo getCluResultType(@WebParam(name = "cluResultTypeKey") String cluResultTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 308 | ||
| 309 | ||
| 310 | /** | |
| 311 | * Retrieves the list of clu result types which are allowed to be | |
| 312 | * used in conjunction with a particular lu type. | |
| 313 | * | |
| 314 | * @param luTypeKey luTypeKey | |
| 315 | * @param context Context information containing the principalId | |
| 316 | * and locale information about the caller of service | |
| 317 | * operation | |
| 318 | * @return list of clu result types | |
| 319 | * @throws DoesNotExistException luTypeKey not found | |
| 320 | * @throws InvalidParameterException invalid luTypeKey | |
| 321 | * @throws MissingParameterException missing luTypeKey | |
| 322 | * @throws OperationFailedException unable to complete request | |
| 323 | */ | |
| 324 | ||
| 325 | public List<CluResultTypeInfo> getCluResultTypesForLuType(@WebParam(name = "luTypeKey") String luTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 326 | ||
| 327 | ||
| 328 | /** | |
| 329 | * Retrieves a list of result usage types. | |
| 330 | * | |
| 331 | * @param context Context information containing the principalId | |
| 332 | * and locale information about the caller of service | |
| 333 | * operation | |
| 334 | * @return list of result usage type information | |
| 335 | * @throws OperationFailedException unable to complete request | |
| 336 | */ | |
| 337 | ||
| 338 | public List<ResultUsageTypeInfo> getResultUsageTypes(@WebParam(name = "context") ContextInfo context) throws OperationFailedException; | |
| 339 | ||
| 340 | ||
| 341 | /** | |
| 342 | * Retrieves information about a Result Usage Type. | |
| 343 | * | |
| 344 | * @param resultUsageTypeKey Key of the Result Usage Type | |
| 345 | * @param context Context information containing the principalId | |
| 346 | * and locale information about the caller of service | |
| 347 | * operation | |
| 348 | * @return information about a Result Usage Type | |
| 349 | * @throws DoesNotExistException resultUsageTypeKey not found | |
| 350 | * @throws InvalidParameterException invalid resultUsageTypeKey | |
| 351 | * @throws MissingParameterException missing resultUsageTypeKey | |
| 352 | * @throws OperationFailedException unable to complete request | |
| 353 | */ | |
| 354 | ||
| 355 | public ResultUsageTypeInfo getResultUsageType(@WebParam(name = "resultUsageTypeKey") String resultUsageTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 356 | ||
| 357 | ||
| 358 | /** | |
| 359 | * Retrieves the list of result usage types which are allowed to | |
| 360 | * be used in conjunction with an lu type. | |
| 361 | * | |
| 362 | * @param luTypeKey luTypeKey | |
| 363 | * @param context Context information containing the principalId | |
| 364 | * and locale information about the caller of service | |
| 365 | * operation | |
| 366 | * @return list of result usage types | |
| 367 | * @throws DoesNotExistException luTypeKey not found | |
| 368 | * @throws InvalidParameterException invalid luTypeKey | |
| 369 | * @throws MissingParameterException missing luTypeKey | |
| 370 | * @throws OperationFailedException unable to complete request | |
| 371 | */ | |
| 372 | ||
| 373 | public List<String> getAllowedResultUsageTypesForLuType(@WebParam(name = "luTypeKey") String luTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 374 | ||
| 375 | ||
| 376 | /** | |
| 377 | * Retrieves the list of result component types which are allowed | |
| 378 | * to be used in conjunction with result usage type. | |
| 379 | * | |
| 380 | * @param resultUsageTypeKey resultUsageTypeKey | |
| 381 | * @param context Context information containing the principalId | |
| 382 | * and locale information about the caller of service | |
| 383 | * operation | |
| 384 | * @return list of result component types | |
| 385 | * @throws DoesNotExistException resultUsageTypeKey not found | |
| 386 | * @throws InvalidParameterException invalid resultUsageTypeKey | |
| 387 | * @throws MissingParameterException missing resultUsageTypeKey | |
| 388 | * @throws OperationFailedException unable to complete request | |
| 389 | */ | |
| 390 | ||
| 391 | public List<String> getAllowedResultComponentTypesForResultUsageType(@WebParam(name = "resultUsageTypeKey") String resultUsageTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 392 | ||
| 393 | ||
| 394 | /** | |
| 395 | * Retrieves the complete list of CLU to LO relation types. | |
| 396 | * | |
| 397 | * @param context Context information containing the principalId | |
| 398 | * and locale information about the caller of service | |
| 399 | * operation | |
| 400 | * @return list of CLU to LO relation type information | |
| 401 | * @throws OperationFailedException unable to complete request | |
| 402 | */ | |
| 403 | ||
| 404 | public List<CluLoRelationTypeInfo> getCluLoRelationTypes(@WebParam(name = "context") ContextInfo context) throws OperationFailedException; | |
| 405 | ||
| 406 | ||
| 407 | /** | |
| 408 | * Retrieves information for a specified CLU to LO relation type. | |
| 409 | * | |
| 410 | * @param cluLoRelationTypeKey Key of the CLU to LO Relation Type | |
| 411 | * @param context Context information containing the principalId | |
| 412 | * and locale information about the caller of service | |
| 413 | * operation | |
| 414 | * @return CLU to LO relation type information | |
| 415 | * @throws DoesNotExistException cluLoRelationTypeKey not found | |
| 416 | * @throws InvalidParameterException invalid cluLoRelationTypeKey | |
| 417 | * @throws MissingParameterException missing cluLoRelationTypeKey | |
| 418 | * @throws OperationFailedException unable to complete request | |
| 419 | */ | |
| 420 | ||
| 421 | public CluLoRelationTypeInfo getCluLoRelationType(@WebParam(name = "cluLoRelationTypeKey") String cluLoRelationTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 422 | ||
| 423 | ||
| 424 | /** | |
| 425 | * Retrieves the list of CLU LO relation types which are allowed | |
| 426 | * to be used in conjunction with an lu type. | |
| 427 | * | |
| 428 | * @param luTypeKey luTypeKey | |
| 429 | * @param context Context information containing the principalId | |
| 430 | * and locale information about the caller of service | |
| 431 | * operation | |
| 432 | * @return list of clu lo relation types | |
| 433 | * @throws DoesNotExistException luTypeKey not found | |
| 434 | * @throws InvalidParameterException invalid luTypeKey | |
| 435 | * @throws MissingParameterException missing luTypeKey | |
| 436 | * @throws OperationFailedException unable to complete request | |
| 437 | */ | |
| 438 | ||
| 439 | public List<String> getAllowedCluLoRelationTypesForLuType(@WebParam(name = "luTypeKey") String luTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 440 | ||
| 441 | ||
| 442 | /** | |
| 443 | * Retrieves the list of CLU set types known by the service. | |
| 444 | * | |
| 445 | * @param context Context information containing the principalId | |
| 446 | * and locale information about the caller of service | |
| 447 | * operation | |
| 448 | * @return list of CLU set type information | |
| 449 | * @throws OperationFailedException unable to complete request | |
| 450 | */ | |
| 451 | ||
| 452 | public List<CluSetTypeInfo> getCluSetTypes(@WebParam(name = "context") ContextInfo context) throws OperationFailedException; | |
| 453 | ||
| 454 | ||
| 455 | /** | |
| 456 | * Retrieves information about a specified CLU set type. | |
| 457 | * | |
| 458 | * @param cluSetTypeKey Key of the CLU set type | |
| 459 | * @param context Context information containing the principalId | |
| 460 | * and locale information about the caller of service | |
| 461 | * operation | |
| 462 | * @return information about a CLU set type | |
| 463 | * @throws DoesNotExistException cluSetTypeKey not found | |
| 464 | * @throws InvalidParameterException invalid cluSetTypeKey | |
| 465 | * @throws MissingParameterException missing cluSetTypeKey | |
| 466 | * @throws OperationFailedException unable to complete request | |
| 467 | */ | |
| 468 | ||
| 469 | public CluSetTypeInfo getCluSetType(@WebParam(name = "cluSetTypeKey") String cluSetTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 470 | ||
| 471 | ||
| 472 | /** | |
| 473 | * Retrieves core information about a CLU. | |
| 474 | * | |
| 475 | * @param cluId identifier of the CLU | |
| 476 | * @param context Context information containing the principalId | |
| 477 | * and locale information about the caller of service | |
| 478 | * operation | |
| 479 | * @return information about a CLU | |
| 480 | * @throws DoesNotExistException cluId not found | |
| 481 | * @throws InvalidParameterException invalid cluId | |
| 482 | * @throws MissingParameterException missing cluId | |
| 483 | * @throws OperationFailedException unable to complete request | |
| 484 | */ | |
| 485 | ||
| 486 | public CluInfo getClu(@WebParam(name = "cluId") String cluId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 487 | ||
| 488 | ||
| 489 | /** | |
| 490 | * Retrieves information about CLUs from a list of ids. | |
| 491 | * | |
| 492 | * @param cluIdList List of CLU identifiers | |
| 493 | * @param context Context information containing the principalId | |
| 494 | * and locale information about the caller of service | |
| 495 | * operation | |
| 496 | * @return information a list of CLUs | |
| 497 | * @throws DoesNotExistException One or more cluIds not found | |
| 498 | * @throws InvalidParameterException One or more invalid cluIds | |
| 499 | * @throws MissingParameterException missing cluIdList | |
| 500 | * @throws OperationFailedException unable to complete request | |
| 501 | */ | |
| 502 | ||
| 503 | public List<CluInfo> getClusByIdList(@WebParam(name = "cluIdList") List<String> cluIdList, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 504 | ||
| 505 | ||
| 506 | /** | |
| 507 | * Retrieves the list of CLUs for the specified LU Type and state. | |
| 508 | * | |
| 509 | * @param luTypeKey Type of the CLUs to retrieve | |
| 510 | * @param luState State of the CLUs to retrieve. | |
| 511 | * @param context Context information containing the principalId | |
| 512 | * and locale information about the caller of service | |
| 513 | * operation | |
| 514 | * @return list of CLU information | |
| 515 | * @throws DoesNotExistException luType or luState not found | |
| 516 | * @throws InvalidParameterException invalid luType or luState | |
| 517 | * @throws MissingParameterException missing luType or luState | |
| 518 | * @throws OperationFailedException unable to complete request | |
| 519 | */ | |
| 520 | ||
| 521 | public List<CluInfo> getClusByLuType(@WebParam(name = "luTypeKey") String luTypeKey, @WebParam(name = "luState") String luState, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 522 | ||
| 523 | ||
| 524 | /** | |
| 525 | * Retrieves the list of CLU ids for the specified LU Type and | |
| 526 | * state. | |
| 527 | * | |
| 528 | * @param luTypeKey Type of the CLUs whose identifiers should be | |
| 529 | * retrieved | |
| 530 | * @param luState State of the CLUs whose identifiers should be | |
| 531 | * retrieved | |
| 532 | * @param context Context information containing the principalId | |
| 533 | * and locale information about the caller of service | |
| 534 | * operation | |
| 535 | * @return list of CLU identifiers | |
| 536 | * @throws DoesNotExistException luType or luState not found | |
| 537 | * @throws InvalidParameterException invalid luType or luState | |
| 538 | * @throws MissingParameterException missing luType or luState | |
| 539 | * @throws OperationFailedException unable to complete request | |
| 540 | */ | |
| 541 | ||
| 542 | public List<String> getCluIdsByLuType(@WebParam(name = "luTypeKey") String luTypeKey, @WebParam(name = "luState") String luState, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 543 | ||
| 544 | ||
| 545 | /** | |
| 546 | * Retrieves the list of allowed relation types between the two | |
| 547 | * specified CLUs. | |
| 548 | * | |
| 549 | * @param cluId identifier of the first CLU | |
| 550 | * @param relatedCluId identifier of the second CLU | |
| 551 | * @param context Context information containing the principalId | |
| 552 | * and locale information about the caller of service | |
| 553 | * operation | |
| 554 | * @return list of LU to LU relation types | |
| 555 | * @throws DoesNotExistException clu, relatedClu not found | |
| 556 | * @throws InvalidParameterException invalid cluId, relatedCluId | |
| 557 | * @throws MissingParameterException missing cluId, relatedCluId | |
| 558 | * @throws OperationFailedException unable to complete request | |
| 559 | */ | |
| 560 | ||
| 561 | public List<String> getAllowedLuLuRelationTypesByCluId(@WebParam(name = "cluId") String cluId, @WebParam(name = "relatedCluId") String relatedCluId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 562 | ||
| 563 | ||
| 564 | /** | |
| 565 | * Retrieves the list of CLU information for the CLUs related to a | |
| 566 | * specified CLU Id with a certain LU to LU relation type | |
| 567 | * (getRelatedClusByCluId from the other direction). | |
| 568 | * | |
| 569 | * @param relatedCluId identifier of the child or To CLU | |
| 570 | * @param luLuRelationType the LU to LU relation type | |
| 571 | * @param context Context information containing the principalId | |
| 572 | * and locale information about the caller of service | |
| 573 | * operation | |
| 574 | * @return list of CLU information | |
| 575 | * @throws DoesNotExistException relatedCluId, luLuRelationType not found | |
| 576 | * @throws InvalidParameterException invalid relatedCluId, luLuRelationType | |
| 577 | * @throws MissingParameterException missing relatedCluId, luLuRelationType | |
| 578 | * @throws OperationFailedException unable to complete request | |
| 579 | */ | |
| 580 | ||
| 581 | public List<CluInfo> getClusByRelation(@WebParam(name = "relatedCluId") String relatedCluId, @WebParam(name = "luLuRelationType") String luLuRelationType, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 582 | ||
| 583 | ||
| 584 | /** | |
| 585 | * Retrieves the list of CLU Ids for the specified related CLU Id | |
| 586 | * and LU to LU relation type (getRelatedCluIdsByCluId from the | |
| 587 | * other direction). | |
| 588 | * | |
| 589 | * @param relatedCluId identifier of the child or To CLU | |
| 590 | * @param luLuRelationType the LU to LU relation type | |
| 591 | * @param context Context information containing the principalId | |
| 592 | * and locale information about the caller of service | |
| 593 | * operation | |
| 594 | * @return list of CLU identifiers | |
| 595 | * @throws DoesNotExistException relatedClu, luLuRelationType not found | |
| 596 | * @throws InvalidParameterException invalid relatedCluId, luLuRelationType | |
| 597 | * @throws MissingParameterException missing relatedCluId, luLuRelationType | |
| 598 | * @throws OperationFailedException unable to complete request | |
| 599 | */ | |
| 600 | ||
| 601 | public List<String> getCluIdsByRelation(@WebParam(name = "relatedCluId") String relatedCluId, @WebParam(name = "luLuRelationType") String luLuRelationType, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 602 | ||
| 603 | ||
| 604 | /** | |
| 605 | * Retrieves the list of related CLU information for the specified | |
| 606 | * CLU Id and LU to LU relation type (getClusByRelation from the | |
| 607 | * other direction). | |
| 608 | * | |
| 609 | * @param cluId identifier of the parent or From CLU | |
| 610 | * @param luLuRelationType the LU to LU relation type | |
| 611 | * @param context Context information containing the principalId | |
| 612 | * and locale information about the caller of service | |
| 613 | * operation | |
| 614 | * @return list of CLU information | |
| 615 | * @throws DoesNotExistException clu, luLuRelationType not found | |
| 616 | * @throws InvalidParameterException invalid cluId, luLuRelationType | |
| 617 | * @throws MissingParameterException missing cluId, luLuRelationType | |
| 618 | * @throws OperationFailedException unable to complete request | |
| 619 | */ | |
| 620 | ||
| 621 | public List<CluInfo> getRelatedClusByCluId(@WebParam(name = "cluId") String cluId, @WebParam(name = "luLuRelationType") String luLuRelationType, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 622 | ||
| 623 | ||
| 624 | /** | |
| 625 | * Retrieves the list of related CLU Ids for the specified CLU Id | |
| 626 | * and LU to LU relation type (getCluIdsByRelation from the other | |
| 627 | * direction). | |
| 628 | * | |
| 629 | * @param cluId identifier of the parent or From CLU | |
| 630 | * @param luLuRelationType the LU to LU relation type | |
| 631 | * @param context Context information containing the principalId | |
| 632 | * and locale information about the caller of service | |
| 633 | * operation | |
| 634 | * @return list of CLU identifiers | |
| 635 | * @throws DoesNotExistException clu, luLuRelationType not found | |
| 636 | * @throws InvalidParameterException invalid cluId, luLuRelationType | |
| 637 | * @throws MissingParameterException missing cluId, luLuRelationType | |
| 638 | * @throws OperationFailedException unable to complete request | |
| 639 | */ | |
| 640 | ||
| 641 | public List<String> getRelatedCluIdsByCluId(@WebParam(name = "cluId") String cluId, @WebParam(name = "luLuRelationType") String luLuRelationType, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 642 | ||
| 643 | ||
| 644 | /** | |
| 645 | * Retrieves the relationship information between CLUs for a | |
| 646 | * particular Relation instance. | |
| 647 | * | |
| 648 | * @param cluCluRelationId identifier of the CLU to CLU relation | |
| 649 | * @param context Context information containing the principalId | |
| 650 | * and locale information about the caller of service | |
| 651 | * operation | |
| 652 | * @return information on the relation between two CLUs | |
| 653 | * @throws DoesNotExistException cluCluRelation not found | |
| 654 | * @throws InvalidParameterException invalid cluCluRelationId | |
| 655 | * @throws MissingParameterException missing cluCluRelationId | |
| 656 | * @throws OperationFailedException unable to complete request | |
| 657 | */ | |
| 658 | ||
| 659 | public CluCluRelationInfo getCluCluRelation(@WebParam(name = "cluCluRelationId") String cluCluRelationId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 660 | ||
| 661 | ||
| 662 | /** | |
| 663 | * Retrieves the list of relationship information for the | |
| 664 | * specified CLU. | |
| 665 | * | |
| 666 | * @param cluId identifier of the parent or From CLU | |
| 667 | * @param context Context information containing the principalId | |
| 668 | * and locale information about the caller of service | |
| 669 | * operation | |
| 670 | * @return list of CLU to CLU relation information | |
| 671 | * @throws DoesNotExistException clu not found | |
| 672 | * @throws InvalidParameterException invalid cluId | |
| 673 | * @throws MissingParameterException missing cluId | |
| 674 | * @throws OperationFailedException unable to complete request | |
| 675 | */ | |
| 676 | ||
| 677 | public List<CluCluRelationInfo> getCluCluRelationsByClu(@WebParam(name = "cluId") String cluId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 678 | ||
| 679 | ||
| 680 | /** | |
| 681 | * Retrieves a list of publication objects for a particular CLU. | |
| 682 | * | |
| 683 | * @param cluId clu identifier | |
| 684 | * @param context Context information containing the principalId | |
| 685 | * and locale information about the caller of service | |
| 686 | * operation | |
| 687 | * @return list of publication objects used by the specified clu | |
| 688 | * @throws DoesNotExistException clu not found | |
| 689 | * @throws InvalidParameterException invalid cluId | |
| 690 | * @throws MissingParameterException cluId not specified | |
| 691 | * @throws OperationFailedException unable to complete request | |
| 692 | */ | |
| 693 | ||
| 694 | public List<CluPublicationInfo> getCluPublicationsByCluId(@WebParam(name = "cluId") String cluId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 695 | ||
| 696 | ||
| 697 | /** | |
| 698 | * Retrieves a list of publication objects of a particular Type. | |
| 699 | * | |
| 700 | * @param luPublicationTypeKey luPublicationType identifier | |
| 701 | * @param context Context information containing the principalId | |
| 702 | * and locale information about the caller of service | |
| 703 | * operation | |
| 704 | * @return list of CLU Publication objects using the specified type | |
| 705 | * @throws DoesNotExistException luPublicationType not found | |
| 706 | * @throws InvalidParameterException invalid luPublicationTypeKey | |
| 707 | * @throws MissingParameterException luPublicationTypeKey not specified | |
| 708 | * @throws OperationFailedException unable to complete request | |
| 709 | */ | |
| 710 | ||
| 711 | public List<CluPublicationInfo> getCluPublicationsByType(@WebParam(name = "luPublicationTypeKey") String luPublicationTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 712 | ||
| 713 | ||
| 714 | /** | |
| 715 | * Retrieves an LU publication object by its identifier. | |
| 716 | * | |
| 717 | * @param cluPublicationId CLU publication identifier | |
| 718 | * @param context Context information containing the principalId | |
| 719 | * and locale information about the caller of service | |
| 720 | * operation | |
| 721 | * @return CLU Publication information | |
| 722 | * @throws DoesNotExistException CLU Publication not found | |
| 723 | * @throws InvalidParameterException invalid cluPublicationId | |
| 724 | * @throws MissingParameterException cluPublicationId not specified | |
| 725 | * @throws OperationFailedException unable to complete request | |
| 726 | */ | |
| 727 | public CluPublicationInfo getCluPublication(@WebParam(name = "cluPublicationId") String cluPublicationId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 728 | ||
| 729 | ||
| 730 | /** | |
| 731 | * Retrieves information about a Clu Result. | |
| 732 | * | |
| 733 | * @param cluResultId identifier of the Clu Result | |
| 734 | * @param context Context information containing the principalId | |
| 735 | * and locale inqformation about the caller of service | |
| 736 | * operation | |
| 737 | * @return information about a Clu Result | |
| 738 | * @throws DoesNotExistException cluResult not found | |
| 739 | * @throws InvalidParameterException invalid cluResultId | |
| 740 | * @throws MissingParameterException missing cluResultId | |
| 741 | * @throws OperationFailedException unable to complete request | |
| 742 | */ | |
| 743 | ||
| 744 | public CluResultInfo getCluResult(@WebParam(name = "cluResultId") String cluResultId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 745 | ||
| 746 | ||
| 747 | /** | |
| 748 | * Retrieves the cluResult for a particular Clu. | |
| 749 | * | |
| 750 | * @param cluId clu identifier | |
| 751 | * @param context Context information containing the principalId | |
| 752 | * and locale information about the caller of service | |
| 753 | * operation | |
| 754 | * @return result information for a clu | |
| 755 | * @throws DoesNotExistException clu not found | |
| 756 | * @throws InvalidParameterException invalid cluId | |
| 757 | * @throws MissingParameterException cluId not specified | |
| 758 | * @throws OperationFailedException unable to complete request | |
| 759 | */ | |
| 760 | ||
| 761 | public List<CluResultInfo> getCluResultByClu(@WebParam(name = "cluId") String cluId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 762 | ||
| 763 | ||
| 764 | /** | |
| 765 | * Retrieves the list of clu ids with the results of the specified | |
| 766 | * usage type. This would for example allow requests for all clus | |
| 767 | * which have a final grade. | |
| 768 | * | |
| 769 | * @param resultUsageTypeKey identifier of the result usage type | |
| 770 | * @param context Context information containing the principalId | |
| 771 | * and locale information about the caller of service | |
| 772 | * operation | |
| 773 | * @return list of clu ids | |
| 774 | * @throws DoesNotExistException resultUsageType not found | |
| 775 | * @throws InvalidParameterException invalid resultUsageTypeKey | |
| 776 | * @throws MissingParameterException missing resultUsageTypeKey | |
| 777 | * @throws OperationFailedException unable to complete request | |
| 778 | */ | |
| 779 | ||
| 780 | public List<String> getCluIdsByResultUsageType(@WebParam(name = "resultUsageTypeKey") String resultUsageTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 781 | ||
| 782 | ||
| 783 | /** | |
| 784 | * Retrieves the list of clu ids which use a particular result | |
| 785 | * component. | |
| 786 | * | |
| 787 | * @param resultComponentId identifier of the result component | |
| 788 | * @param context Context information containing the principalId | |
| 789 | * and locale information about the caller of service | |
| 790 | * operation | |
| 791 | * @return list of clu ids | |
| 792 | * @throws DoesNotExistException resultComponent not found | |
| 793 | * @throws InvalidParameterException invalid resultComponentId | |
| 794 | * @throws MissingParameterException missing resultComponentId | |
| 795 | * @throws OperationFailedException unable to complete request | |
| 796 | */ | |
| 797 | ||
| 798 | public List<String> getCluIdsByResultComponent(@WebParam(name = "resultComponentId") String resultComponentId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 799 | ||
| 800 | ||
| 801 | /** | |
| 802 | * Retrieve information on a CLU LO Relation. | |
| 803 | * | |
| 804 | * @param cluLoRelationId Identifier of the CLU LO Relation | |
| 805 | * @param context Context information containing the principalId | |
| 806 | * and locale information about the caller of service | |
| 807 | * operation | |
| 808 | * @return The retrieved CLU LO Relation information | |
| 809 | * @throws DoesNotExistException cluLoRelation not found | |
| 810 | * @throws InvalidParameterException invalid cluLoRelationId | |
| 811 | * @throws MissingParameterException missing cluLoRelationId | |
| 812 | * @throws OperationFailedException unable to complete request | |
| 813 | * @throws PermissionDeniedException authorization failure | |
| 814 | */ | |
| 815 | ||
| 816 | public CluLoRelationInfo getCluLoRelation(@WebParam(name = "cluLoRelationId") String cluLoRelationId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 817 | ||
| 818 | /** | |
| 819 | * Retrieves the list of canonical learning unit to learning | |
| 820 | * objective relationships for a given CLU. | |
| 821 | * | |
| 822 | * @param cluId Identifier for the CLU | |
| 823 | * @param context Context information containing the principalId | |
| 824 | * and locale information about the caller of service | |
| 825 | * operation | |
| 826 | * @return List of canonical learning unit to learning objective | |
| 827 | * relationships | |
| 828 | * @throws DoesNotExistException clu not found | |
| 829 | * @throws InvalidParameterException invalid cluId | |
| 830 | * @throws MissingParameterException missing cluId | |
| 831 | * @throws OperationFailedException unable to complete request | |
| 832 | */ | |
| 833 | ||
| 834 | public List<CluLoRelationInfo> getCluLoRelationsByClu(@WebParam(name = "cluId") String cluId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 835 | ||
| 836 | ||
| 837 | /** | |
| 838 | * Retrieves the list of CLU identifiers associated with a given | |
| 839 | * learning objective identifier. | |
| 840 | * | |
| 841 | * @param loId Identifier for the learning objective | |
| 842 | * @param context Context information containing the principalId | |
| 843 | * and locale information about the caller of service | |
| 844 | * operation | |
| 845 | * @return List of CLU LO Relations | |
| 846 | * @throws DoesNotExistException lo not found | |
| 847 | * @throws InvalidParameterException invalid loId | |
| 848 | * @throws MissingParameterException missing loId | |
| 849 | * @throws OperationFailedException unable to complete request | |
| 850 | */ | |
| 851 | ||
| 852 | public List<CluLoRelationInfo> getCluLoRelationsByLo(@WebParam(name = "loId") String loId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 853 | ||
| 854 | ||
| 855 | /** | |
| 856 | * Retrieves the list of Resource requirements for the specified | |
| 857 | * CLU. | |
| 858 | * | |
| 859 | * @param cluId Unique identifier for the CLU | |
| 860 | * @param context Context information containing the principalId | |
| 861 | * and locale information about the caller of service | |
| 862 | * operation | |
| 863 | * @return List of resource requirements | |
| 864 | * @throws DoesNotExistException clu not found | |
| 865 | * @throws InvalidParameterException cluId invalid | |
| 866 | * @throws MissingParameterException cluId missing | |
| 867 | * @throws OperationFailedException unable to complete request | |
| 868 | */ | |
| 869 | ||
| 870 | public List<String> getResourceRequirementsForCluId(@WebParam(name = "cluId") String cluId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 871 | ||
| 872 | ||
| 873 | /** | |
| 874 | * Retrieve information on a CLU set. This information should be | |
| 875 | * about the set itself, and in the case of a dynamic CLU set, | |
| 876 | * should include the criteria used to generate the set. | |
| 877 | * | |
| 878 | * @param cluSetId Identifier of the CLU set | |
| 879 | * @param context Context information containing the principalId | |
| 880 | * and locale information about the caller of service | |
| 881 | * operation | |
| 882 | * @return The retrieved CLU set information | |
| 883 | * @throws DoesNotExistException cluSet not found | |
| 884 | * @throws InvalidParameterException invalid cluSetId | |
| 885 | * @throws MissingParameterException missing cluSetId | |
| 886 | * @throws OperationFailedException unable to complete request | |
| 887 | * @throws PermissionDeniedException authorization failure | |
| 888 | */ | |
| 889 | ||
| 890 | public CluSetInfo getCluSetInfo(@WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 891 | ||
| 892 | ||
| 893 | /** | |
| 894 | * Retrieve information on a CLU set and its sub clu set fully expanded. | |
| 895 | * | |
| 896 | * @param cluSetId Identifier of the CLU set | |
| 897 | * @param context Context information containing the principalId | |
| 898 | * and locale information about the caller of service | |
| 899 | * operation | |
| 900 | * @return The retrieved CLU set tree view information | |
| 901 | * @throws DoesNotExistException cluSet not found | |
| 902 | * @throws InvalidParameterException invalid cluSetId | |
| 903 | * @throws MissingParameterException missing cluSetId | |
| 904 | * @throws OperationFailedException unable to complete request | |
| 905 | * @throws PermissionDeniedException authorization failure | |
| 906 | */ | |
| 907 | ||
| 908 | public CluSetTreeViewInfo getCluSetTreeView(@WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 909 | ||
| 910 | ||
| 911 | /** | |
| 912 | * Retrieve information on CLU sets from a list of cluSet Ids. | |
| 913 | * | |
| 914 | * @param cluSetIdList List of identifiers of CLU sets | |
| 915 | * @param context Context information containing the principalId | |
| 916 | * and locale information about the caller of service | |
| 917 | * operation | |
| 918 | * @return The retrieved list of CLU set information | |
| 919 | * @throws DoesNotExistException One or more cluSets not found | |
| 920 | * @throws InvalidParameterException One or more cluSetIds invalid | |
| 921 | * @throws MissingParameterException missing cluSetIdList | |
| 922 | * @throws OperationFailedException unable to complete request | |
| 923 | * @throws PermissionDeniedException authorization failure | |
| 924 | */ | |
| 925 | ||
| 926 | public List<CluSetInfo> getCluSetInfoByIdList(@WebParam(name = "cluSetIdList") List<String> cluSetIdList, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 927 | ||
| 928 | ||
| 929 | /** | |
| 930 | * Retrieve the list of CLU Set Ids within a CLU Set | |
| 931 | * | |
| 932 | * @param cluSetId Identifier of the CLU set | |
| 933 | * @param context Context information containing the principalId | |
| 934 | * and locale information about the caller of service | |
| 935 | * operation | |
| 936 | * @return The retrieved list of CLU Set Ids within the specified CLU set | |
| 937 | * @throws DoesNotExistException cluSet not found | |
| 938 | * @throws InvalidParameterException invalid cluSetId | |
| 939 | * @throws MissingParameterException missing cluSetId | |
| 940 | * @throws OperationFailedException unable to complete request | |
| 941 | * @throws PermissionDeniedException authorization failure | |
| 942 | */ | |
| 943 | ||
| 944 | public List<String> getCluSetIdsFromCluSet(@WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 945 | ||
| 946 | ||
| 947 | /** | |
| 948 | * Check if the given CluSet is dynamic. | |
| 949 | * | |
| 950 | * @param cluSetId Identifier of the CLU set | |
| 951 | * @param context Context information containing the principalId | |
| 952 | * and locale information about the caller of service | |
| 953 | * operation | |
| 954 | * @return The retrieved list of CLU Set Ids within the specified CLU set | |
| 955 | * @throws DoesNotExistException cluSet not found | |
| 956 | * @throws InvalidParameterException invalid cluSetId | |
| 957 | * @throws MissingParameterException missing cluSetId | |
| 958 | * @throws OperationFailedException unable to complete request | |
| 959 | * @throws PermissionDeniedException authorization failure | |
| 960 | */ | |
| 961 | ||
| 962 | public Boolean isCluSetDynamic(@WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 963 | ||
| 964 | ||
| 965 | /** | |
| 966 | * Retrieves the list of CLUs in a CLU set. This only retrieves | |
| 967 | * the direct members. | |
| 968 | * | |
| 969 | * @param cluSetId Identifier of the CLU set | |
| 970 | * @param context Context information containing the principalId | |
| 971 | * and locale information about the caller of service | |
| 972 | * operation | |
| 973 | * @return The retrieved list of information on the CLUs within | |
| 974 | * the CLU set (flattened and de-duped) | |
| 975 | * @throws DoesNotExistException cluSet not found | |
| 976 | * @throws InvalidParameterException invalid cluSetId | |
| 977 | * @throws MissingParameterException missing cluSetId | |
| 978 | * @throws OperationFailedException unable to complete request | |
| 979 | * @throws PermissionDeniedException authorization failure | |
| 980 | */ | |
| 981 | ||
| 982 | public List<CluInfo> getClusFromCluSet(@WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 983 | ||
| 984 | ||
| 985 | /** | |
| 986 | * Retrieves the list of CLU Identifiers within a CLU Set. This | |
| 987 | * only retrieves the direct members. | |
| 988 | * | |
| 989 | * @param cluSetId Identifier of the CLU set | |
| 990 | * @param context Context information containing the principalId | |
| 991 | * and locale information about the caller of service | |
| 992 | * operation | |
| 993 | * @return The retrieved list of CLU Ids within the specified CLU | |
| 994 | * set (flattened and de-duped) | |
| 995 | * @throws DoesNotExistException cluSet not found | |
| 996 | * @throws InvalidParameterException invalid cluSetId | |
| 997 | * @throws MissingParameterException missing cluSetId | |
| 998 | * @throws OperationFailedException unable to complete request | |
| 999 | * @throws PermissionDeniedException authorization failure | |
| 1000 | */ | |
| 1001 | ||
| 1002 | public List<String> getCluIdsFromCluSet(@WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 1003 | ||
| 1004 | ||
| 1005 | /** | |
| 1006 | * Retrieves the full list of CLUs in this CLU set or any cluset | |
| 1007 | * that is included within that. | |
| 1008 | * | |
| 1009 | * @param cluSetId Identifier of the CLU set | |
| 1010 | * @param context Context information containing the principalId | |
| 1011 | * and locale information about the caller of service | |
| 1012 | * operation | |
| 1013 | * @return The retrieved list of information on the CLUs | |
| 1014 | * @throws DoesNotExistException cluSet not found | |
| 1015 | * @throws InvalidParameterException invalid cluSetId | |
| 1016 | * @throws MissingParameterException missing cluSetId | |
| 1017 | * @throws OperationFailedException unable to complete request | |
| 1018 | * @throws PermissionDeniedException authorization failure | |
| 1019 | */ | |
| 1020 | public List<CluInfo> getAllClusInCluSet(@WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 1021 | ||
| 1022 | ||
| 1023 | /** | |
| 1024 | * Retrieves the list of CLU Identifiers within a CLU Set or any | |
| 1025 | * cluset that is included within that. | |
| 1026 | * | |
| 1027 | * @param cluSetId Identifier of the CLU set | |
| 1028 | * @param context Context information containing the principalId | |
| 1029 | * and locale information about the caller of service | |
| 1030 | * operation | |
| 1031 | * @return The retrieved list of CLU Ids within the specified CLU set | |
| 1032 | * @throws DoesNotExistException cluSet not found | |
| 1033 | * @throws InvalidParameterException invalid cluSetId | |
| 1034 | * @throws MissingParameterException missing cluSetId | |
| 1035 | * @throws OperationFailedException unable to complete request | |
| 1036 | * @throws PermissionDeniedException authorization failure | |
| 1037 | */ | |
| 1038 | public List<String> getAllCluIdsInCluSet(@WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 1039 | ||
| 1040 | ||
| 1041 | /** | |
| 1042 | * Checks if a CLU is a member of a CLU set or any contained CLU | |
| 1043 | * set. | |
| 1044 | * | |
| 1045 | * @param cluId Identifier of the CLU to check | |
| 1046 | * @param cluSetId Identifier of the CLU set | |
| 1047 | * @param context Context information containing the principalId | |
| 1048 | * and locale information about the caller of service | |
| 1049 | * operation | |
| 1050 | * @return True if the CLU is a member of the CLU Set | |
| 1051 | * @throws DoesNotExistException clu, cluSet not found | |
| 1052 | * @throws InvalidParameterException invalid cluId, cluSetId | |
| 1053 | * @throws MissingParameterException missing cluId, cluSetId | |
| 1054 | * @throws OperationFailedException unable to complete request | |
| 1055 | * @throws PermissionDeniedException authorization failure | |
| 1056 | */ | |
| 1057 | ||
| 1058 | public Boolean isCluInCluSet(@WebParam(name = "cluId") String cluId, @WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 1059 | ||
| 1060 | ||
| 1061 | /** | |
| 1062 | * Validates a CLU. Depending on the value of validationType, this | |
| 1063 | * validation could be limited to tests on just the current object | |
| 1064 | * and its directly contained sub-objects or expanded to perform | |
| 1065 | * all tests related to this object. If an identifier is present | |
| 1066 | * for the CLU (and/or one of its contained sub-objects) and a | |
| 1067 | * record is found for that identifier, the validation checks if | |
| 1068 | * the CLU can be shifted to the new values. If an identifier is | |
| 1069 | * not present or a record cannot be found for the identifier, it | |
| 1070 | * is assumed that the record does not exist and as such, the | |
| 1071 | * checks performed will be much shallower, typically mimicking | |
| 1072 | * those performed by setting the validationType to the current | |
| 1073 | * object. | |
| 1074 | * | |
| 1075 | * @param validationType identifier of the extent of validation | |
| 1076 | * @param cluInfo CLU information to be tested. | |
| 1077 | * @param context Context information containing the principalId | |
| 1078 | * and locale information about the caller of service | |
| 1079 | * operation | |
| 1080 | * @return results from performing the validation | |
| 1081 | * @throws DoesNotExistException validationTypeKey not found | |
| 1082 | * @throws InvalidParameterException invalid validationTypeKey, cluInfo | |
| 1083 | * @throws MissingParameterException missing validationTypeKey, cluInfo | |
| 1084 | * @throws OperationFailedException unable to complete request | |
| 1085 | */ | |
| 1086 | ||
| 1087 | public List<ValidationResultInfo> validateClu(@WebParam(name = "validationType") String validationType, @WebParam(name = "cluInfo") CluInfo cluInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 1088 | ||
| 1089 | ||
| 1090 | /** | |
| 1091 | * Creates a new CLU. | |
| 1092 | * | |
| 1093 | * @param luTypeKey identifier of the LU Type for the CLU being created | |
| 1094 | * @param cluInfo information about the CLU being created | |
| 1095 | * @param context Context information containing the principalId | |
| 1096 | * and locale information about the caller of service | |
| 1097 | * operation | |
| 1098 | * @return the created CLU information | |
| 1099 | * @throws AlreadyExistsException CLU already exists | |
| 1100 | * @throws DataValidationErrorException One or more values invalid | |
| 1101 | * for this operation | |
| 1102 | * @throws DoesNotExistException luTypeKey not found | |
| 1103 | * @throws InvalidParameterException invalid luTypeKey, cluInfo | |
| 1104 | * @throws MissingParameterException missing luTypeKey, cluInfo | |
| 1105 | * @throws OperationFailedException unable to complete request | |
| 1106 | * @throws PermissionDeniedException authorization failure | |
| 1107 | */ | |
| 1108 | ||
| 1109 | public CluInfo createClu(@WebParam(name = "luTypeKey") String luTypeKey, @WebParam(name = "cluInfo") CluInfo cluInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 1110 | ||
| 1111 | ||
| 1112 | /** | |
| 1113 | * Updates an existing CLU. | |
| 1114 | * | |
| 1115 | * @param cluId identifier for the CLU to be updated | |
| 1116 | * @param cluInfo updated information about the CLU | |
| 1117 | * @param context Context information containing the principalId | |
| 1118 | * and locale information about the caller of service | |
| 1119 | * operation | |
| 1120 | * @return the updated CLU information | |
| 1121 | * @throws DataValidationErrorException One or more values invalid | |
| 1122 | * for this operation | |
| 1123 | * @throws DoesNotExistException cluId not found | |
| 1124 | * @throws InvalidParameterException invalid cluId, cluInfo | |
| 1125 | * @throws MissingParameterException missing cluId, cluInfo | |
| 1126 | * @throws OperationFailedException unable to complete request | |
| 1127 | * @throws PermissionDeniedException authorization failure | |
| 1128 | * @throws VersionMismatchException The action was attempted on an out of date version | |
| 1129 | */ | |
| 1130 | ||
| 1131 | public CluInfo updateClu(@WebParam(name = "cluId") String cluId, @WebParam(name = "cluInfo") CluInfo cluInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException; | |
| 1132 | ||
| 1133 | ||
| 1134 | /** | |
| 1135 | * Deletes an existing CLU. | |
| 1136 | * | |
| 1137 | * @param cluId identifier for the CLU to be deleted | |
| 1138 | * @param context Context information containing the principalId | |
| 1139 | * and locale information about the caller of service | |
| 1140 | * operation | |
| 1141 | * @return status of the operation | |
| 1142 | * @throws DoesNotExistException cluId not found | |
| 1143 | * @throws InvalidParameterException invalid cluId | |
| 1144 | * @throws MissingParameterException missing cluId | |
| 1145 | * @throws DependentObjectsExistException delete would leave | |
| 1146 | * orphaned objects or violate integrity constraints | |
| 1147 | * @throws OperationFailedException unable to complete request | |
| 1148 | * @throws PermissionDeniedException authorization failure | |
| 1149 | */ | |
| 1150 | ||
| 1151 | public StatusInfo deleteClu(@WebParam(name = "cluId") String cluId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, DependentObjectsExistException, OperationFailedException, PermissionDeniedException; | |
| 1152 | ||
| 1153 | ||
| 1154 | /** | |
| 1155 | * Creates a new CLU version based on the current CLU. | |
| 1156 | * | |
| 1157 | * @param cluId identifier for the CLU to be versioned | |
| 1158 | * @param versionComment comment for the current version | |
| 1159 | * @param context Context information containing the principalId | |
| 1160 | * and locale information about the caller of service | |
| 1161 | * operation | |
| 1162 | * @return the new versioned CLU information | |
| 1163 | * @throws DataValidationErrorException One or more values invalid | |
| 1164 | * for this operation | |
| 1165 | * @throws DoesNotExistException cluId not found | |
| 1166 | * @throws InvalidParameterException invalid cluId | |
| 1167 | * @throws MissingParameterException missing cluId | |
| 1168 | * @throws OperationFailedException unable to complete request | |
| 1169 | * @throws PermissionDeniedException authorization failure | |
| 1170 | * @throws VersionMismatchException The action was attempted on an | |
| 1171 | * out of date version | |
| 1172 | */ | |
| 1173 | ||
| 1174 | public CluInfo createNewCluVersion(@WebParam(name = "cluId") String cluId, @WebParam(name = "versionComment") String versionComment, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException; | |
| 1175 | ||
| 1176 | ||
| 1177 | /** | |
| 1178 | * Sets a specific version of the Clu as current. The sequence | |
| 1179 | * number must be greater than the existing current Clu version. | |
| 1180 | * This will truncate the current version's end date to the | |
| 1181 | * currentVersionStart param. If a Clu exists which is set to | |
| 1182 | * become current in the future, that clu's currentVersionStart | |
| 1183 | * and CurrentVersionEnd will be nullified. The | |
| 1184 | * currentVersionStart must be in the future to prevent changing | |
| 1185 | * historic data. | |
| 1186 | * | |
| 1187 | * @param cluVersionId Version Specific Id of the Clu | |
| 1188 | * @param currentVersionStart Date when this clu becomes | |
| 1189 | * current. Must be in the future and be after the most | |
| 1190 | * current clu's start date. | |
| 1191 | * @param context Context information containing the principalId | |
| 1192 | * and locale information about the caller of service | |
| 1193 | * operation | |
| 1194 | * @return status of the operation | |
| 1195 | * @throws DoesNotExistException cluVersionId not found | |
| 1196 | * @throws InvalidParameterException invalid cluVersionId, | |
| 1197 | * previousState, newState | |
| 1198 | * @throws MissingParameterException missing cluVersionId, | |
| 1199 | * previousState, newState | |
| 1200 | * @throws IllegalVersionSequencingException | |
| 1201 | * a Clu with higher | |
| 1202 | * sequence number from the one provided is marked current | |
| 1203 | * @throws OperationFailedException unable to complete request | |
| 1204 | * @throws PermissionDeniedException authorization failure | |
| 1205 | */ | |
| 1206 | ||
| 1207 | public StatusInfo setCurrentCluVersion(@WebParam(name = "cluVersionId") String cluVersionId, @WebParam(name = "currentVersionStart") Date currentVersionStart, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, IllegalVersionSequencingException, OperationFailedException, PermissionDeniedException; | |
| 1208 | ||
| 1209 | ||
| 1210 | /** | |
| 1211 | * Updates the state of the specified CLU. | |
| 1212 | * | |
| 1213 | * @param cluId identifier for the CLU to be updated | |
| 1214 | * @param luState new state for the CLU. Value is expected to be | |
| 1215 | * constrained to those in the luState enumeration. | |
| 1216 | * @param context Context information containing the principalId | |
| 1217 | * and locale information about the caller of service | |
| 1218 | * operation | |
| 1219 | * @return the updated CLU information | |
| 1220 | * @throws DataValidationErrorException new state not valid for | |
| 1221 | * existing state of CLU | |
| 1222 | * @throws DoesNotExistException cluId, luState not found | |
| 1223 | * @throws InvalidParameterException invalid cluId, luState | |
| 1224 | * @throws MissingParameterException missing cluId, luState | |
| 1225 | * @throws OperationFailedException unable to complete request | |
| 1226 | * @throws PermissionDeniedException authorization failure | |
| 1227 | */ | |
| 1228 | ||
| 1229 | public CluInfo updateCluState(@WebParam(name = "cluId") String cluId, @WebParam(name = "luState") String luState, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 1230 | ||
| 1231 | ||
| 1232 | /** | |
| 1233 | * Validates a cluCluRelation. Depending on the value of | |
| 1234 | * validationType, this validation could be limited to tests on | |
| 1235 | * just the current object and its directly contained sub-objects | |
| 1236 | * or expanded to perform all tests related to this object. If an | |
| 1237 | * identifier is present for the cluCluRelation (and/or one of its | |
| 1238 | * contained sub-objects) and a record is found for that | |
| 1239 | * identifier, the validation checks if the relationship can be | |
| 1240 | * shifted to the new values. If an identifier is not present or a | |
| 1241 | * record cannot be found for the identifier, it is assumed that | |
| 1242 | * the record does not exist and as such, the checks performed | |
| 1243 | * will be much shallower, typically mimicking those performed by | |
| 1244 | * setting the validationType to the current object. | |
| 1245 | * | |
| 1246 | * @param validationType identifier of the extent of validation | |
| 1247 | * @param cluCluRelationInfo cluCluRelation information to be tested. | |
| 1248 | * @param context Context information containing the principalId | |
| 1249 | * and locale information about the caller of service | |
| 1250 | * operation | |
| 1251 | * @return results from performing the validation | |
| 1252 | * @throws DoesNotExistException validationTypeKey not found | |
| 1253 | * @throws InvalidParameterException invalid validationTypeKey, | |
| 1254 | * cluCluRelationInfo | |
| 1255 | * @throws MissingParameterException missing validationTypeKey, | |
| 1256 | * cluCluRelationInfo | |
| 1257 | * @throws OperationFailedException unable to complete request | |
| 1258 | */ | |
| 1259 | ||
| 1260 | public List<ValidationResultInfo> validateCluCluRelation(@WebParam(name = "validationType") String validationType, @WebParam(name = "cluCluRelationInfo") CluCluRelationInfo cluCluRelationInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 1261 | ||
| 1262 | ||
| 1263 | /** | |
| 1264 | * Create a directional relationship between two CLUs | |
| 1265 | * | |
| 1266 | * @param cluId identifier of the first CLU in the relationship - | |
| 1267 | * The From or Parent of the relation | |
| 1268 | * @param relatedCluId identifier of the second CLU in the | |
| 1269 | * relationship to be related to - the To or Child of the | |
| 1270 | * Relation | |
| 1271 | * @param luLuRelationTypeKey the LU to LU relationship type of | |
| 1272 | * the relationship | |
| 1273 | * @param cluCluRelationInfo information about the relationship | |
| 1274 | * between the two CLUs | |
| 1275 | * @param context Context information containing the principalId | |
| 1276 | * and locale information about the caller of service | |
| 1277 | * operation | |
| 1278 | * @return the created CLU to CLU relation information | |
| 1279 | * @throws AlreadyExistsException relationship already exists | |
| 1280 | * @throws CircularRelationshipException cluId equals relatedCluId | |
| 1281 | * @throws DataValidationErrorException One or more values invalid | |
| 1282 | * for this operation | |
| 1283 | * @throws DoesNotExistException cluId, relatedCluId, | |
| 1284 | * luLuRelationType not found | |
| 1285 | * @throws InvalidParameterException invalid cluId, relatedCluId, | |
| 1286 | * luluRelationType, cluCluRelationInfo | |
| 1287 | * @throws MissingParameterException missing cluId, relatedCluId, | |
| 1288 | * luluRelationType, cluCluRelationInfo | |
| 1289 | * @throws OperationFailedException unable to complete request | |
| 1290 | * @throws PermissionDeniedException authorization failure | |
| 1291 | */ | |
| 1292 | ||
| 1293 | public CluCluRelationInfo createCluCluRelation(@WebParam(name = "cluId") String cluId, @WebParam(name = "relatedCluId") String relatedCluId, @WebParam(name = "luLuRelationTypeKey") String luLuRelationTypeKey, @WebParam(name = "cluCluRelationInfo") CluCluRelationInfo cluCluRelationInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, CircularRelationshipException, DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 1294 | ||
| 1295 | ||
| 1296 | /** | |
| 1297 | * Updates a relationship between two CLUs. | |
| 1298 | * | |
| 1299 | * @param cluCluRelationId identifier of the CLU to CLU relation | |
| 1300 | * to be updated | |
| 1301 | * @param cluCluRelationInfo changed information about the CLU to | |
| 1302 | * CLU relationship | |
| 1303 | * @param context Context information containing the principalId | |
| 1304 | * and locale information about the caller of service | |
| 1305 | * operation | |
| 1306 | * @return the updated CLU to CLU relation information | |
| 1307 | * @throws DataValidationErrorException One or more values invalid | |
| 1308 | * for this operation | |
| 1309 | * @throws DoesNotExistException cluCluRelation not found | |
| 1310 | * @throws InvalidParameterException invalid cluCluRelationId, | |
| 1311 | * cluCluRelationInfo | |
| 1312 | * @throws MissingParameterException missing cluCluRelationId, | |
| 1313 | * cluCluRelationInfo | |
| 1314 | * @throws OperationFailedException unable to complete request | |
| 1315 | * @throws PermissionDeniedException authorization failure | |
| 1316 | * @throws VersionMismatchException The action was attempted on an | |
| 1317 | * out of date version. | |
| 1318 | */ | |
| 1319 | ||
| 1320 | public CluCluRelationInfo updateCluCluRelation(@WebParam(name = "cluCluRelationId") String cluCluRelationId, @WebParam(name = "cluCluRelationInfo") CluCluRelationInfo cluCluRelationInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException; | |
| 1321 | ||
| 1322 | ||
| 1323 | /** | |
| 1324 | * Deletes a relationship between two CLUs. | |
| 1325 | * | |
| 1326 | * @param cluCluRelationId identifier of CLU to CLU | |
| 1327 | * relationship to delete | |
| 1328 | * @param context Context information containing the principalId | |
| 1329 | * and locale information about the caller of service | |
| 1330 | * operation | |
| 1331 | * @return status of the operation (success or failure) | |
| 1332 | * @throws DoesNotExistException cluCluRelation not found | |
| 1333 | * @throws InvalidParameterException invalid cluCluRelationId | |
| 1334 | * @throws MissingParameterException missing cluCluRelationId | |
| 1335 | * @throws OperationFailedException unable to complete request | |
| 1336 | * @throws PermissionDeniedException authorization failure | |
| 1337 | */ | |
| 1338 | ||
| 1339 | public StatusInfo deleteCluCluRelation(@WebParam(name = "cluCluRelationId") String cluCluRelationId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 1340 | ||
| 1341 | ||
| 1342 | /** | |
| 1343 | * Validates information about publication for a clu. Depending on | |
| 1344 | * the value of validationType, this validation could be limited | |
| 1345 | * to tests on just the current object and its directly contained | |
| 1346 | * sub-objects or expanded to perform all tests related to this | |
| 1347 | * object. If an identifier is present for the clu publication | |
| 1348 | * object (and/or one of its contained sub-objects) and a record | |
| 1349 | * is found for that identifier, the validation checks if the clu | |
| 1350 | * publication object can be shifted to the new values. If an | |
| 1351 | * identifier is not present or a record cannot be found for the | |
| 1352 | * identifier, it is assumed that the record does not exist and as | |
| 1353 | * such, the checks performed will be much shallower, typically | |
| 1354 | * mimicking those performed by setting the validationType to the | |
| 1355 | * current object. | |
| 1356 | * | |
| 1357 | * @param validationType identifier of the extent of validation | |
| 1358 | * @param cluPublicationInfo CLU publication information to be tested. | |
| 1359 | * @param context Context information containing the principalId | |
| 1360 | * and locale information about the caller of service | |
| 1361 | * operation | |
| 1362 | * @return results from performing the validation | |
| 1363 | * @throws DoesNotExistException validationTypeKey not found | |
| 1364 | * @throws InvalidParameterException invalid validationTypeKey, | |
| 1365 | * cluPublicationInfo | |
| 1366 | * @throws MissingParameterException missing validationTypeKey, | |
| 1367 | * cluPublicationInfo | |
| 1368 | * @throws OperationFailedException unable to complete request | |
| 1369 | */ | |
| 1370 | ||
| 1371 | public List<ValidationResultInfo> validateCluPublication(@WebParam(name = "validationType") String validationType, @WebParam(name = "cluPublicationInfo") CluPublicationInfo cluPublicationInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 1372 | ||
| 1373 | ||
| 1374 | /** | |
| 1375 | * Create a clu publication object, which contains information | |
| 1376 | * about publication for a CLU. | |
| 1377 | * | |
| 1378 | * @param cluId identifier of a clu | |
| 1379 | * @param luPublicationType type of lu publication | |
| 1380 | * @param cluPublicationInfo information about publication for a clu | |
| 1381 | * @param context Context information containing the principalId | |
| 1382 | * and locale information about the caller of service | |
| 1383 | * operation | |
| 1384 | * @return information about the created clu publication object | |
| 1385 | * @throws AlreadyExistsException clu publication object already | |
| 1386 | * exists | |
| 1387 | * @throws DataValidationErrorException One or more values invalid | |
| 1388 | * for this operation | |
| 1389 | * @throws InvalidParameterException invalid cluId, | |
| 1390 | * luPublicationType, cluPublicationInfo | |
| 1391 | * @throws MissingParameterException missing cluId, | |
| 1392 | * luPublicationType, cluPublicationInfo | |
| 1393 | * @throws OperationFailedException unable to complete request | |
| 1394 | * @throws PermissionDeniedException authorization failure | |
| 1395 | */ | |
| 1396 | ||
| 1397 | public CluPublicationInfo createCluPublication(@WebParam(name = "cluId") String cluId, @WebParam(name = "luPublicationType") String luPublicationType, @WebParam(name = "cluPublicationInfo") CluPublicationInfo cluPublicationInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 1398 | ||
| 1399 | ||
| 1400 | /** | |
| 1401 | * Updates an existing clu publication object. | |
| 1402 | * | |
| 1403 | * @param cluPublicationId identifier for the clu publication | |
| 1404 | * object to be updated | |
| 1405 | * @param cluPublicationInfo updated information about the clu | |
| 1406 | * publication object | |
| 1407 | * @param context Context information containing the principalId | |
| 1408 | * and locale information about the caller of service | |
| 1409 | * operation | |
| 1410 | * @return the updated clu publication information | |
| 1411 | * @throws DataValidationErrorException One or more values invalid | |
| 1412 | * for this operation | |
| 1413 | * @throws DoesNotExistException cluPublication not found | |
| 1414 | * @throws InvalidParameterException invalid cluPublicationId, | |
| 1415 | * cluPublicationInfo | |
| 1416 | * @throws MissingParameterException missing cluPublicationId, | |
| 1417 | * cluPublicationInfo | |
| 1418 | * @throws OperationFailedException unable to complete request | |
| 1419 | * @throws PermissionDeniedException authorization failure | |
| 1420 | * @throws VersionMismatchException The action was attempted on an | |
| 1421 | * out of date version. | |
| 1422 | */ | |
| 1423 | ||
| 1424 | public CluPublicationInfo updateCluPublication(@WebParam(name = "cluPublicationId") String cluPublicationId, @WebParam(name = "cluPublicationInfo") CluPublicationInfo cluPublicationInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException; | |
| 1425 | ||
| 1426 | ||
| 1427 | /** | |
| 1428 | * Deletes an existing clu publication object. | |
| 1429 | * | |
| 1430 | * @param cluPublicationId identifier for the clu publication | |
| 1431 | * object to be deleted | |
| 1432 | * @param context Context information containing the principalId | |
| 1433 | * and locale information about the caller of service | |
| 1434 | * operation | |
| 1435 | * @return status of the operation | |
| 1436 | * @throws DoesNotExistException cluPublication not found | |
| 1437 | * @throws InvalidParameterException invalid cluPublicationId | |
| 1438 | * @throws MissingParameterException missing cluPublicationId | |
| 1439 | * @throws DependentObjectsExistException delete would leave | |
| 1440 | * orphaned objects or violate integrity constraints | |
| 1441 | * @throws OperationFailedException unable to complete request | |
| 1442 | * @throws PermissionDeniedException authorization failure | |
| 1443 | */ | |
| 1444 | ||
| 1445 | public StatusInfo deleteCluPublication(@WebParam(name = "cluPublicationId") String cluPublicationId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, DependentObjectsExistException, OperationFailedException, PermissionDeniedException; | |
| 1446 | ||
| 1447 | ||
| 1448 | /** | |
| 1449 | * Validates information about results for a clu. Depending on the | |
| 1450 | * value of validationType, this validation could be limited to | |
| 1451 | * tests on just the current object and its directly contained | |
| 1452 | * sub-objects or expanded to perform all tests related to this | |
| 1453 | * object. If an identifier is present for the clu result object | |
| 1454 | * (and/or one of its contained sub-objects) and a record is found | |
| 1455 | * for that identifier, the validation checks if the clu result | |
| 1456 | * object can be shifted to the new values. If an identifier is | |
| 1457 | * not present or a record cannot be found for the identifier, it | |
| 1458 | * is assumed that the record does not exist and as such, the | |
| 1459 | * checks performed will be much shallower, typically mimicking | |
| 1460 | * those performed by setting the validationType to the current | |
| 1461 | * object. | |
| 1462 | * | |
| 1463 | * @param validationType identifier of the extent of validation | |
| 1464 | * @param cluResultInfo CLU result information to be tested. | |
| 1465 | * @param context Context information containing the principalId | |
| 1466 | * and locale information about the caller of service | |
| 1467 | * operation | |
| 1468 | * @return results from performing the validation | |
| 1469 | * @throws DoesNotExistException validationTypeKey not found | |
| 1470 | * @throws InvalidParameterException invalid validationTypeKey, | |
| 1471 | * cluResultInfo | |
| 1472 | * @throws MissingParameterException missing validationTypeKey, | |
| 1473 | * cluResultInfo | |
| 1474 | * @throws OperationFailedException unable to complete request | |
| 1475 | */ | |
| 1476 | ||
| 1477 | public List<ValidationResultInfo> validateCluResult(@WebParam(name = "validationType") String validationType, @WebParam(name = "cluResultInfo") CluResultInfo cluResultInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 1478 | ||
| 1479 | ||
| 1480 | /** | |
| 1481 | * Create a clu result object, which contains information about | |
| 1482 | * potential results for a clu. | |
| 1483 | * | |
| 1484 | * @param cluId identifier of a clu | |
| 1485 | * @param cluResultType type of clu result | |
| 1486 | * @param cluResultInfo information about potential results for a clu | |
| 1487 | * @param context Context information containing the principalId | |
| 1488 | * and locale information about the caller of service | |
| 1489 | * operation | |
| 1490 | * @return information about the created clu result | |
| 1491 | * @throws AlreadyExistsException clu result already exists | |
| 1492 | * @throws DataValidationErrorException One or more values invalid | |
| 1493 | * for this operation | |
| 1494 | * @throws InvalidParameterException invalid cluId, cluResultType, | |
| 1495 | * cluResultInfo | |
| 1496 | * @throws MissingParameterException missing cluId, cluResultType, | |
| 1497 | * cluResultInfo | |
| 1498 | * @throws OperationFailedException unable to complete request | |
| 1499 | * @throws PermissionDeniedException authorization failure | |
| 1500 | * @throws DoesNotExistException resultUsageTypeKey not found | |
| 1501 | */ | |
| 1502 | ||
| 1503 | public CluResultInfo createCluResult(@WebParam(name = "cluId") String cluId, @WebParam(name = "cluResultType") String cluResultType, @WebParam(name = "cluResultInfo") CluResultInfo cluResultInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, DoesNotExistException; | |
| 1504 | ||
| 1505 | ||
| 1506 | /** | |
| 1507 | * Updates an existing clu result. | |
| 1508 | * | |
| 1509 | * @param cluResultId identifier for the clu result to be updated | |
| 1510 | * @param cluResultInfo updated information about the clu result | |
| 1511 | * @param context Context information containing the principalId | |
| 1512 | * and locale information about the caller of service | |
| 1513 | * operation | |
| 1514 | * @return the updated clu result information | |
| 1515 | * @throws DataValidationErrorException One or more values invalid | |
| 1516 | * for this operation | |
| 1517 | * @throws DoesNotExistException cluResult not found | |
| 1518 | * @throws InvalidParameterException invalid cluResultId, cluResultInfo | |
| 1519 | * @throws MissingParameterException missing cluResultId, cluResultInfo | |
| 1520 | * @throws OperationFailedException unable to complete request | |
| 1521 | * @throws PermissionDeniedException authorization failure | |
| 1522 | * @throws VersionMismatchException The action was attempted on an | |
| 1523 | * out of date version. | |
| 1524 | */ | |
| 1525 | ||
| 1526 | public CluResultInfo updateCluResult(@WebParam(name = "cluResultId") String cluResultId, @WebParam(name = "cluResultInfo") CluResultInfo cluResultInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException; | |
| 1527 | ||
| 1528 | ||
| 1529 | /** | |
| 1530 | * Deletes an existing clu result. | |
| 1531 | * | |
| 1532 | * @param cluResultId identifier for the clu result to be deleted | |
| 1533 | * @param context Context information containing the principalId | |
| 1534 | * and locale information about the caller of service | |
| 1535 | * operation | |
| 1536 | * @return status of the operation | |
| 1537 | * @throws DoesNotExistException cluResult not found | |
| 1538 | * @throws InvalidParameterException invalid cluResultId | |
| 1539 | * @throws MissingParameterException missing cluResultId | |
| 1540 | * @throws DependentObjectsExistException delete would leave | |
| 1541 | * orphaned objects or violate integrity constraints | |
| 1542 | * @throws OperationFailedException unable to complete request | |
| 1543 | * @throws PermissionDeniedException authorization failure | |
| 1544 | */ | |
| 1545 | ||
| 1546 | public StatusInfo deleteCluResult(@WebParam(name = "cluResultId") String cluResultId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, DependentObjectsExistException, OperationFailedException, PermissionDeniedException; | |
| 1547 | ||
| 1548 | ||
| 1549 | /** | |
| 1550 | * Validates a cluLoRelation. Depending on the value of | |
| 1551 | * validationType, this validation could be limited to tests on | |
| 1552 | * just the current object and its directly contained sub-objects | |
| 1553 | * or expanded to perform all tests related to this object. If an | |
| 1554 | * identifier is present for the cluLoRelation (and/or one of its | |
| 1555 | * contained sub-objects) and a record is found for that | |
| 1556 | * identifier, the validation checks if the relationship can be | |
| 1557 | * shifted to the new values. If an identifier is not present or a | |
| 1558 | * record cannot be found for the identifier, it is assumed that | |
| 1559 | * the record does not exist and as such, the checks performed | |
| 1560 | * will be much shallower, typically mimicking those performed by | |
| 1561 | * setting the validationType to the current object. | |
| 1562 | * | |
| 1563 | * @param validationType identifier of the extent of validation | |
| 1564 | * @param cluLoRelationInfo cluLoRelation information to be tested. | |
| 1565 | * @param context Context information containing the principalId | |
| 1566 | * and locale information about the caller of service | |
| 1567 | * operation | |
| 1568 | * @return results from performing the validation | |
| 1569 | * @throws DoesNotExistException validationTypeKey not found | |
| 1570 | * @throws InvalidParameterException invalid validationTypeKey, | |
| 1571 | * cluLoRelationInfo | |
| 1572 | * @throws MissingParameterException missing validationTypeKey, | |
| 1573 | * cluLoRelationInfo | |
| 1574 | * @throws OperationFailedException unable to complete request | |
| 1575 | */ | |
| 1576 | ||
| 1577 | public List<ValidationResultInfo> validateCluLoRelation(@WebParam(name = "validationType") String validationType, @WebParam(name = "cluLoRelationInfo") CluLoRelationInfo cluLoRelationInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 1578 | ||
| 1579 | ||
| 1580 | /** | |
| 1581 | * Creates a relationship between a learning objective and a CLU. | |
| 1582 | * | |
| 1583 | * @param cluId CLU identifier | |
| 1584 | * @param loId learning objective identifier | |
| 1585 | * @param cluLoRelationType type of clu learning objective relationship | |
| 1586 | * @param cluLoRelationInfo clu learning objective relationship | |
| 1587 | * information | |
| 1588 | * @param context Context information containing the principalId | |
| 1589 | * and locale information about the caller of service | |
| 1590 | * operation | |
| 1591 | * @return the newly created clu learning objective relationship | |
| 1592 | * @throws AlreadyExistsException connection between clu and | |
| 1593 | * learning objective already exists | |
| 1594 | * @throws DoesNotExistException cluId, loId, cluLoRelationType | |
| 1595 | * not found | |
| 1596 | * @throws InvalidParameterException one or more parameters invalid | |
| 1597 | * @throws MissingParameterException one or more parameters not | |
| 1598 | * specified | |
| 1599 | * @throws OperationFailedException unable to complete request | |
| 1600 | * @throws PermissionDeniedException authorization failure | |
| 1601 | * @throws DataValidationErrorException data validation error | |
| 1602 | */ | |
| 1603 | public CluLoRelationInfo createCluLoRelation(@WebParam(name = "cluId") String cluId, @WebParam(name = "loId") String loId, @WebParam(name = "cluLoRelationType") String cluLoRelationType, @WebParam(name = "cluLoRelationInfo") CluLoRelationInfo cluLoRelationInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, DataValidationErrorException; | |
| 1604 | ||
| 1605 | ||
| 1606 | /** | |
| 1607 | * Updates a relationship between a clu and learning objective. | |
| 1608 | * | |
| 1609 | * @param cluLoRelationId identifier of the clu learning objective | |
| 1610 | * relationship to be updated | |
| 1611 | * @param cluLoRelationInfo information about the clu learning | |
| 1612 | * objective relationship to be updated | |
| 1613 | * @param context Context information containing the principalId | |
| 1614 | * and locale information about the caller of service | |
| 1615 | * operation | |
| 1616 | * @return the updated clu learning objective relationship information | |
| 1617 | * @throws DataValidationErrorException One or more values invalid | |
| 1618 | * for this operation | |
| 1619 | * @throws DoesNotExistException cluLoRelation not found | |
| 1620 | * @throws InvalidParameterException one or more parameters invalid | |
| 1621 | * @throws MissingParameterException one or more parameters missing | |
| 1622 | * @throws OperationFailedException unable to complete request | |
| 1623 | * @throws PermissionDeniedException authorization failure | |
| 1624 | * @throws VersionMismatchException The action was attempted on an | |
| 1625 | * out of date version. | |
| 1626 | */ | |
| 1627 | ||
| 1628 | public CluLoRelationInfo updateCluLoRelation(@WebParam(name = "cluLoRelationId") String cluLoRelationId, @WebParam(name = "cluLoRelationInfo") CluLoRelationInfo cluLoRelationInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException; | |
| 1629 | ||
| 1630 | ||
| 1631 | /** | |
| 1632 | * Removes a relationship between a learning objective and a Clu. | |
| 1633 | * | |
| 1634 | * @param cluLoRelationId CLU learning objective Relationship | |
| 1635 | * identifier | |
| 1636 | * @param context Context information containing the principalId | |
| 1637 | * and locale information about the caller of service | |
| 1638 | * operation | |
| 1639 | * @return Status | |
| 1640 | * @throws DoesNotExistException cluLoRelation not found | |
| 1641 | * @throws InvalidParameterException invalid cluLoRelationId | |
| 1642 | * @throws MissingParameterException cluLoRelationId not specified | |
| 1643 | * @throws OperationFailedException unable to complete request | |
| 1644 | * @throws PermissionDeniedException authorization failure | |
| 1645 | */ | |
| 1646 | ||
| 1647 | public StatusInfo deleteCluLoRelation(@WebParam(name = "cluLoRelationId") String cluLoRelationId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 1648 | ||
| 1649 | ||
| 1650 | /** | |
| 1651 | * Add a Resource requirement to a CLU. | |
| 1652 | * | |
| 1653 | * @param resourceTypeKey identifier of the resource requirement | |
| 1654 | * type to be added to the CLU | |
| 1655 | * @param cluId identifier of the CLU | |
| 1656 | * @param context Context information containing the principalId | |
| 1657 | * and locale information about the caller of service | |
| 1658 | * operation | |
| 1659 | * @return status of the operation (success or failure) | |
| 1660 | * @throws AlreadyExistsException resourceTypeKey is already | |
| 1661 | * associated with the cluIda | |
| 1662 | * @throws DoesNotExistException resourceTypeKey or cluId not found | |
| 1663 | * @throws InvalidParameterException resourceTypeKey or cluId invalid | |
| 1664 | * @throws MissingParameterException resourceTypeKey or cluId missing | |
| 1665 | * @throws OperationFailedException unable to complete request | |
| 1666 | * @throws PermissionDeniedException authorization failure | |
| 1667 | */ | |
| 1668 | ||
| 1669 | public StatusInfo addCluResourceRequirement(@WebParam(name = "resourceTypeKey") String resourceTypeKey, @WebParam(name = "cluId") String cluId, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 1670 | ||
| 1671 | ||
| 1672 | /** | |
| 1673 | * Remove a Resource requirement from a CLU. | |
| 1674 | * | |
| 1675 | * @param resourceTypeKey identifier of the resource type to be | |
| 1676 | * removed from the CLU | |
| 1677 | * @param cluId identifier of the CLU | |
| 1678 | * @param context Context information containing the principalId | |
| 1679 | * and locale information about the caller of service | |
| 1680 | * operation | |
| 1681 | * @return status of the operation (success or failure) | |
| 1682 | * @throws DoesNotExistException resourceTypeKey or cluId or | |
| 1683 | * relationship not found | |
| 1684 | * @throws InvalidParameterException resourceTypeKey or cluId invalid | |
| 1685 | * @throws MissingParameterException resourceTypeKey or cluId missing | |
| 1686 | * @throws OperationFailedException unable to complete request | |
| 1687 | * @throws PermissionDeniedException authorization failure | |
| 1688 | */ | |
| 1689 | ||
| 1690 | public StatusInfo removeCluResourceRequirement(@WebParam(name = "resourceTypeKey") String resourceTypeKey, @WebParam(name = "cluId") String cluId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 1691 | ||
| 1692 | ||
| 1693 | /** | |
| 1694 | * Validates information about a clu set. Depending on the value | |
| 1695 | * of validationType, this validation could be limited to tests on | |
| 1696 | * just the current object and its directly contained sub-objects | |
| 1697 | * or expanded to perform all tests related to this object. If an | |
| 1698 | * identifier is present for the clu set (and/or one of its | |
| 1699 | * contained sub-objects) and a record is found for that | |
| 1700 | * identifier, the validation checks if the clu set can be shifted | |
| 1701 | * to the new values. If an identifier is not present or a record | |
| 1702 | * cannot be found for the identifier, it is assumed that the | |
| 1703 | * record does not exist and as such, the checks performed will be | |
| 1704 | * much shallower, typically mimicking those performed by setting | |
| 1705 | * the validationType to the current object. | |
| 1706 | * | |
| 1707 | * @param validationType identifier of the extent of validation | |
| 1708 | * @param cluSetInfo CLU set information to be tested. | |
| 1709 | * @param context Context information containing the principalId | |
| 1710 | * and locale information about the caller of service | |
| 1711 | * operation | |
| 1712 | * @return results from performing the validation | |
| 1713 | * @throws DoesNotExistException validationTypeKey not found | |
| 1714 | * @throws InvalidParameterException invalid validationTypeKey, | |
| 1715 | * cluSetInfo | |
| 1716 | * @throws MissingParameterException missing validationTypeKey, | |
| 1717 | * cluSetInfo | |
| 1718 | * @throws OperationFailedException unable to complete request | |
| 1719 | */ | |
| 1720 | ||
| 1721 | public List<ValidationResultInfo> validateCluSet(@WebParam(name = "validationType") String validationType, @WebParam(name = "cluSetInfo") CluSetInfo cluSetInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; | |
| 1722 | ||
| 1723 | ||
| 1724 | /** | |
| 1725 | * Creates a CLU set. | |
| 1726 | * | |
| 1727 | * @param cluSetType type of the CLU set to be created | |
| 1728 | * @param cluSetInfo information required to create a CLU set | |
| 1729 | * @param context Context information containing the principalId | |
| 1730 | * and locale information about the caller of service | |
| 1731 | * operation | |
| 1732 | * @return the created CLU set information | |
| 1733 | * @throws AlreadyExistsException the cluSet already exists | |
| 1734 | * @throws DataValidationErrorException One or more values invalid | |
| 1735 | * for this operation | |
| 1736 | * @throws InvalidParameterException invalid cluSetName, cluSetInfo | |
| 1737 | * @throws MissingParameterException missing cluSetName, cluSetInfo | |
| 1738 | * @throws OperationFailedException unable to complete request | |
| 1739 | * @throws PermissionDeniedException authorization failure | |
| 1740 | * @throws UnsupportedActionException CLU set need to be static or | |
| 1741 | * dynamic but not both | |
| 1742 | */ | |
| 1743 | ||
| 1744 | public CluSetInfo createCluSet(@WebParam(name = "cluSetType") String cluSetType, @WebParam(name = "cluSetInfo") CluSetInfo cluSetInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException; | |
| 1745 | ||
| 1746 | ||
| 1747 | /** | |
| 1748 | * Update the information for a CLU set. | |
| 1749 | * | |
| 1750 | * @param cluSetId identifier of the CLU set to be updated | |
| 1751 | * @param cluSetInfo updated information about the CLU set | |
| 1752 | * @param context Context information containing the principalId | |
| 1753 | * and locale information about the caller of service | |
| 1754 | * operation | |
| 1755 | * @return the updated CLU set information | |
| 1756 | * @throws DataValidationErrorException One or more values invalid | |
| 1757 | * for this operation | |
| 1758 | * @throws DoesNotExistException cluSet not found | |
| 1759 | * @throws InvalidParameterException invalid cluSetId, cluSetInfo | |
| 1760 | * @throws MissingParameterException missing cluSetId, cluSetInfo | |
| 1761 | * @throws OperationFailedException unable to complete request | |
| 1762 | * @throws PermissionDeniedException authorization failure | |
| 1763 | * @throws VersionMismatchException The action was attempted on an | |
| 1764 | * out of date version. | |
| 1765 | * @throws UnsupportedActionException CLU set need to be static or | |
| 1766 | * dynamic but not both | |
| 1767 | * @throws CircularRelationshipException addedCluSetId cannot be | |
| 1768 | * added to the cluSetId | |
| 1769 | */ | |
| 1770 | ||
| 1771 | public CluSetInfo updateCluSet(@WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "cluSetInfo") CluSetInfo cluSetInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException, UnsupportedActionException, CircularRelationshipException; | |
| 1772 | ||
| 1773 | ||
| 1774 | /** | |
| 1775 | * Delete a CLU set. | |
| 1776 | * | |
| 1777 | * @param cluSetId identifier of the CLU set to be deleted | |
| 1778 | * @param context Context information containing the principalId | |
| 1779 | * and locale information about the caller of service | |
| 1780 | * operation | |
| 1781 | * @return status of the operation (success or failure) | |
| 1782 | * @throws DoesNotExistException cluSet not found | |
| 1783 | * @throws InvalidParameterException invalid cluSetId | |
| 1784 | * @throws MissingParameterException missing cluSetId | |
| 1785 | * @throws OperationFailedException unable to complete request | |
| 1786 | * @throws PermissionDeniedException authorization failure | |
| 1787 | */ | |
| 1788 | ||
| 1789 | public StatusInfo deleteCluSet(@WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; | |
| 1790 | ||
| 1791 | ||
| 1792 | /** | |
| 1793 | * Adds one CLU set to another. | |
| 1794 | * | |
| 1795 | * @param cluSetId identifier of the host CLU set | |
| 1796 | * @param addedCluSetId identifier of the CLU set to be added | |
| 1797 | * @param context Context information containing the principalId | |
| 1798 | * and locale information about the caller of service | |
| 1799 | * operation | |
| 1800 | * @return status of the operation (success or failure) | |
| 1801 | * @throws CircularRelationshipException addedCluSetId cannot be | |
| 1802 | * added to the cluSetId | |
| 1803 | * @throws DoesNotExistException cluSet, addedCluSet not found | |
| 1804 | * @throws InvalidParameterException invalid cluSetId, addedCluSetId | |
| 1805 | * @throws MissingParameterException missing cluSetId, addedCluSetId | |
| 1806 | * @throws OperationFailedException unable to complete request | |
| 1807 | * @throws PermissionDeniedException authorization failure | |
| 1808 | * @throws UnsupportedActionException CLU set is dynamically determined | |
| 1809 | */ | |
| 1810 | ||
| 1811 | public StatusInfo addCluSetToCluSet(@WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "addedCluSetId") String addedCluSetId, @WebParam(name = "context") ContextInfo context) throws CircularRelationshipException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException; | |
| 1812 | ||
| 1813 | ||
| 1814 | /** | |
| 1815 | * Adds a list of CLU sets to another CluSet. If any individual | |
| 1816 | * one would fail, then an error is returned and none are added. | |
| 1817 | * | |
| 1818 | * @param cluSetId identifier of the host CLU set | |
| 1819 | * @param addedCluSetIdList list of identifiers of the CLU sets to | |
| 1820 | * be added | |
| 1821 | * @param context Context information containing the principalId | |
| 1822 | * and locale information about the caller of service | |
| 1823 | * operation | |
| 1824 | * @return status of the operation (success or failure) | |
| 1825 | * @throws CircularRelationshipException addedCluSetId cannot be | |
| 1826 | * added to the cluSetId | |
| 1827 | * @throws DoesNotExistException cluSet, addedCluSet not found | |
| 1828 | * @throws InvalidParameterException invalid cluSetId, addedCluSetId | |
| 1829 | * @throws MissingParameterException missing cluSetId, addedCluSetId | |
| 1830 | * @throws OperationFailedException unable to complete request | |
| 1831 | * @throws PermissionDeniedException authorization failure | |
| 1832 | * @throws UnsupportedActionException CLU set is dynamically determined | |
| 1833 | */ | |
| 1834 | ||
| 1835 | public StatusInfo addCluSetsToCluSet(@WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "addedCluSetIdList") List<String> addedCluSetIdList, @WebParam(name = "context") ContextInfo context) throws CircularRelationshipException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException; | |
| 1836 | ||
| 1837 | ||
| 1838 | /** | |
| 1839 | * Removes one CLU set from another. | |
| 1840 | * | |
| 1841 | * @param cluSetId identifier of the host CLU set | |
| 1842 | * @param removedCluSetId identifier of the CLU set to be removed | |
| 1843 | * @param context Context information containing the principalId | |
| 1844 | * and locale information about the caller of service | |
| 1845 | * operation | |
| 1846 | * @return status of the operation (success or failure) | |
| 1847 | * @throws DoesNotExistException cluSet, removedCluSet not found | |
| 1848 | * @throws InvalidParameterException invalid cluSetId, removedCluSetId | |
| 1849 | * @throws MissingParameterException missing cluSetId, removedCluSetId | |
| 1850 | * @throws OperationFailedException unable to complete request | |
| 1851 | * @throws PermissionDeniedException authorization failure | |
| 1852 | * @throws UnsupportedActionException CLU set is dynamically determined | |
| 1853 | */ | |
| 1854 | ||
| 1855 | public StatusInfo removeCluSetFromCluSet(@WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "removedCluSetId") String removedCluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException; | |
| 1856 | ||
| 1857 | ||
| 1858 | /** | |
| 1859 | * Add a CLU to a CLU set. | |
| 1860 | * | |
| 1861 | * @param cluId identifier of CLU to add to the CLU set | |
| 1862 | * @param cluSetId identifier of the CLU set | |
| 1863 | * @param context Context information containing the principalId | |
| 1864 | * and locale information about the caller of service | |
| 1865 | * operation | |
| 1866 | * @return status of the operation (success or failure) | |
| 1867 | * @throws DoesNotExistException clu, cluSet not found | |
| 1868 | * @throws InvalidParameterException invalid cluId, cluSetId | |
| 1869 | * @throws MissingParameterException missing cluId, cluSetId | |
| 1870 | * @throws OperationFailedException unable to complete request | |
| 1871 | * @throws PermissionDeniedException authorization failure | |
| 1872 | * @throws UnsupportedActionException CLU set is dynamically determined | |
| 1873 | */ | |
| 1874 | ||
| 1875 | public StatusInfo addCluToCluSet(@WebParam(name = "cluId") String cluId, @WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException; | |
| 1876 | ||
| 1877 | ||
| 1878 | /** | |
| 1879 | * Adds a list of CLUs to a CLU set. If any individual one would | |
| 1880 | * fail, then an error is returned and none are added. | |
| 1881 | * | |
| 1882 | * @param cluSetIds list of identifiers of CLUs to add to the CLU set | |
| 1883 | * @param cluSetId identifier of the CLU set to be added | |
| 1884 | * @param context Context information containing the principalId | |
| 1885 | * and locale information about the caller of service | |
| 1886 | * operation | |
| 1887 | * @return status of the operation (success or failure) | |
| 1888 | * @throws DoesNotExistException clu, cluSet not found | |
| 1889 | * @throws InvalidParameterException invalid cluId, cluSetId | |
| 1890 | * @throws MissingParameterException missing cluId, cluSetId | |
| 1891 | * @throws OperationFailedException unable to complete request | |
| 1892 | * @throws PermissionDeniedException authorization failure | |
| 1893 | * @throws UnsupportedActionException CLU set is dynamically determined | |
| 1894 | */ | |
| 1895 | ||
| 1896 | public StatusInfo addClusToCluSet(@WebParam(name = "cluIdList") List<String> cluIdList, @WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException; | |
| 1897 | ||
| 1898 | ||
| 1899 | /** | |
| 1900 | * Remove a CLU from a CLU set. | |
| 1901 | * | |
| 1902 | * @param cluId identifier of CLU to remove from the CLU set | |
| 1903 | * @param cluSetId identifier of the CLU set | |
| 1904 | * @param context Context information containing the principalId | |
| 1905 | * and locale information about the caller of service | |
| 1906 | * operation | |
| 1907 | * @return status of the operation (success or failure) | |
| 1908 | * @throws DoesNotExistException clu, cluSet not found | |
| 1909 | * @throws InvalidParameterException invalid cluId, cluSetId | |
| 1910 | * @throws MissingParameterException missing cluId, cluSetId | |
| 1911 | * @throws OperationFailedException unable to complete request | |
| 1912 | * @throws PermissionDeniedException authorization failure | |
| 1913 | * @throws UnsupportedActionException CLU set is dynamically determined | |
| 1914 | */ | |
| 1915 | ||
| 1916 | public StatusInfo removeCluFromCluSet(@WebParam(name = "cluId") String cluId, @WebParam(name = "cluSetId") String cluSetId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException; | |
| 1917 | } |