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