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