Coverage Report - org.kuali.student.core.atp.service.AtpService
 
Classes in this File Line Coverage Branch Coverage Complexity
AtpService
N/A
N/A
1
 
 1  
 /**
 2  
  * Copyright 2010 The Kuali Foundation Licensed under the
 3  
  * Educational Community License, Version 2.0 (the "License"); you may
 4  
  * not use this file except in compliance with the License. You may
 5  
  * obtain a copy of the License at
 6  
  *
 7  
  * http://www.osedu.org/licenses/ECL-2.0
 8  
  *
 9  
  * Unless required by applicable law or agreed to in writing,
 10  
  * software distributed under the License is distributed on an "AS IS"
 11  
  * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 12  
  * or implied. See the License for the specific language governing
 13  
  * permissions and limitations under the License.
 14  
  */
 15  
 
 16  
 package org.kuali.student.core.atp.service;
 17  
 
 18  
 import java.util.Date;
 19  
 import java.util.List;
 20  
 
 21  
 import javax.jws.WebParam;
 22  
 import javax.jws.WebService;
 23  
 import javax.jws.soap.SOAPBinding;
 24  
 
 25  
 import org.kuali.student.common.exceptions.AlreadyExistsException;
 26  
 import org.kuali.student.common.exceptions.DataValidationErrorException;
 27  
 import org.kuali.student.common.exceptions.DoesNotExistException;
 28  
 import org.kuali.student.common.exceptions.InvalidParameterException;
 29  
 import org.kuali.student.common.exceptions.MissingParameterException;
 30  
 import org.kuali.student.common.exceptions.OperationFailedException;
 31  
 import org.kuali.student.common.exceptions.PermissionDeniedException;
 32  
 import org.kuali.student.common.exceptions.VersionMismatchException;
 33  
 
 34  
 import org.kuali.student.common.dto.ContextInfo;
 35  
 import org.kuali.student.common.dto.StatusInfo;
 36  
 import org.kuali.student.common.dto.ValidationResultInfo;
 37  
 import org.kuali.student.common.service.TypeService;
 38  
 import org.kuali.student.common.service.StateService;
 39  
 
 40  
 import org.kuali.student.core.atp.dto.AtpInfo;
 41  
 import org.kuali.student.core.atp.dto.MilestoneInfo;
 42  
 import org.kuali.student.core.atp.dto.AtpMilestoneRelationInfo;
 43  
 import org.kuali.student.datadictionary.service.DataDictionaryService;
 44  
 
 45  
 
 46  
 /**
 47  
  * Academic Time Period Service Description and Assumptions.
 48  
  *
 49  
  * This service supports the management of Academic Time Periods and
 50  
  * their associated Milestones. The intent is to provide a flexible
 51  
  * but structured way to define the various time frames that are used
 52  
  * throughout the definition, offering and scheduling of Learning
 53  
  * Units. This is a catalogue service with basic operations.
 54  
  *
 55  
  * Version: 1.0 (Dev)
 56  
  *
 57  
  * @Author tom
 58  
  * @Since Tue Apr 05 14:22:34 EDT 2011
 59  
  */
 60  
 
 61  
 @WebService(name = "AtpService", targetNamespace = "http://student.kuali.org/wsdl/atp")
 62  
 @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
 63  
 
 64  
 public interface AtpService extends DataDictionaryService, TypeService, StateService {
 65  
 
 66  
     /** 
 67  
      * Retrieves the details of a single Academic Time Period by atpKey.
 68  
      *
 69  
      * @param atpKey Unique key of the Academic Time Period to be retrieved
 70  
      * @param context Context information containing the principalId
 71  
      *                and locale information about the caller of service
 72  
      *                operation
 73  
      * @return Details of the Academic Time Period requested
 74  
      * @throws DoesNotExistException atpKey not found
 75  
      * @throws InvalidParameterException invalid atpKey
 76  
      * @throws MissingParameterException invalid atpKey
 77  
      * @throws OperationFailedException unable to complete request
 78  
      * @throws PermissionDeniedException authorization failure
 79  
      */
 80  
     public AtpInfo getAtp(@WebParam(name = "atpKey") String atpKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 81  
 
 82  
     /** 
 83  
      * Retrieves the list of Academic Time Periods that the supplied
 84  
      * date falls within.
 85  
      *
 86  
      * @param searchDate Timestamp to be matched
 87  
      * @param context Context information containing the principalId
 88  
      *                and locale information about the caller of service
 89  
      *                operation
 90  
      * @return List of Academic Time Periods that contain the supplied searchDate
 91  
      * @throws InvalidParameterException invalid searchDate
 92  
      * @throws MissingParameterException invalid searchDate
 93  
      * @throws OperationFailedException unable to complete request
 94  
      * @throws PermissionDeniedException authorization failure
 95  
      */
 96  
     public List<AtpInfo> getAtpsByDate(@WebParam(name = "searchDate") Date searchDate, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 97  
 
 98  
     /** 
 99  
      * Retrieves the list of Academic Time Periods that are totally
 100  
      * contained within the supplied dates. The entire Atp falls
 101  
      * within the supplied dates.
 102  
      *
 103  
      * @param startDate Earliest Timestamp
 104  
      * @param endDate Latest Timestamp
 105  
      * @param context Context information containing the principalId
 106  
      *                and locale information about the caller of service
 107  
      *                operation
 108  
      * @return List of Academic Time Periods that contain the supplied searchDate
 109  
      * @throws InvalidParameterException invalid searchDate
 110  
      * @throws MissingParameterException invalid searchDate
 111  
      * @throws OperationFailedException unable to complete request
 112  
      * @throws PermissionDeniedException authorization failure
 113  
      */
 114  
     public List<AtpInfo> getAtpsByDates(@WebParam(name = "startDate") Date startDate, @WebParam(name = "endDate") Date endDate, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 115  
 
 116  
     /** 
 117  
      * Retrieves a list of Academic Time Periods corresponding to the
 118  
      * given list of ATP keys.
 119  
      *
 120  
      * @param atpKeyList list of ATPs to be retrieved
 121  
      * @param context Context information containing the principalId
 122  
      *                and locale information about the caller of service
 123  
      *                operation
 124  
      * @return List of Academic Time Period keys of the given type
 125  
      * @throws DoesNotExistException an atpKey in list not found
 126  
      * @throws InvalidParameterException invalid atpKey
 127  
      * @throws MissingParameterException invalid atpKey
 128  
      * @throws OperationFailedException unable to complete request
 129  
      * @throws PermissionDeniedException authorization failure
 130  
      */
 131  
     public List<AtpInfo> getAtpsByKeyList(@WebParam(name = "atpKeyList") List<String> atpKeyList, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 132  
 
 133  
     /** 
 134  
      * Retrieves a list of Academic Time Periods of the specified type.
 135  
      *
 136  
      * @param atpTypeKey ATP type to be retrieved
 137  
      * @param context Context information containing the principalId
 138  
      *                and locale information about the caller of service
 139  
      *                operation
 140  
      * @return  a list of Academic Time Period keys 
 141  
      * @throws InvalidParameterException invalid atpTypeKey
 142  
      * @throws MissingParameterException invalid atpTypeKey
 143  
      * @throws OperationFailedException unable to complete request
 144  
      * @throws PermissionDeniedException authorization failure
 145  
      */
 146  
     public List<String> getAtpKeysByType(@WebParam(name = "atpTypeKey") String atpTypeKey, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 147  
 
 148  
     /** 
 149  
      * Retrieves the details of the specified milestone.
 150  
      *
 151  
      * @param milestoneKey Unique id of the milestone to be retrieved
 152  
      * @param context Context information containing the principalId
 153  
      *                and locale information about the caller of service
 154  
      *                operation
 155  
      * @return Details of requested milestone
 156  
      * @throws DoesNotExistException milestoneKey not found
 157  
      * @throws InvalidParameterException invalid milestoneKey
 158  
      * @throws MissingParameterException invalid milestoneKey
 159  
      * @throws OperationFailedException unable to complete request
 160  
      * @throws PermissionDeniedException authorization failure
 161  
      */
 162  
     public MilestoneInfo getMilestone(@WebParam(name = "milestoneKey") String milestoneKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 163  
 
 164  
     /** 
 165  
      * Retrieves a list of Milestones corresponding to the given list
 166  
      * of Milestone keys.
 167  
      *
 168  
      * @param milestoneKeyList list of Milestones to be retrieved
 169  
      * @param context Context information containing the principalId
 170  
      *                and locale information about the caller of service
 171  
      *                operation
 172  
      * @return the list of milestone keys 
 173  
      * @throws DoesNotExistException a milestoneKey in list not found
 174  
      * @throws InvalidParameterException invalid milestoneKey
 175  
      * @throws MissingParameterException invalid milestibeKey
 176  
      * @throws OperationFailedException unable to complete request
 177  
      * @throws PermissionDeniedException authorization failure
 178  
      */
 179  
     public List<AtpInfo> getMilestonesByKeyList(@WebParam(name = "milestoneKeyList") List<String> milestoneKeyList, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 180  
 
 181  
     /** 
 182  
      * Retrieves the list of milestones for a specified Academic Time
 183  
      * Period.
 184  
      *
 185  
      * @param atpKey Unique key of the Academic Time Period to be retieved
 186  
      * @param context Context information containing the principalId
 187  
      *                and locale information about the caller of service
 188  
      *                operation
 189  
      * @return List of milestones for this Academic Time Period
 190  
      * @throws InvalidParameterException invalid atpKey
 191  
      * @throws MissingParameterException invalid atpKey
 192  
      * @throws OperationFailedException unable to complete request
 193  
      * @throws PermissionDeniedException authorization failure
 194  
      */
 195  
     public List<MilestoneInfo> getMilestonesByAtp(@WebParam(name = "atpKey") String atpKey, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 196  
 
 197  
     /** 
 198  
      * Retrieves the list of milestones that fall within a specified
 199  
      * set of dates.
 200  
      *
 201  
      * @param startDate Start Date for date span
 202  
      * @param endDate End Date for date span
 203  
      * @param context Context information containing the principalId
 204  
      *                and locale information about the caller of service
 205  
      *                operation
 206  
      * @return List of milestones that fall within this set of dates
 207  
      * @throws InvalidParameterException One or more parameters invalid
 208  
      * @throws MissingParameterException One or more parameter(s) missing
 209  
      * @throws OperationFailedException unable to complete request
 210  
      * @throws PermissionDeniedException authorization failure
 211  
      */
 212  
     public List<MilestoneInfo> getMilestonesByDates(@WebParam(name = "startDate") Date startDate, @WebParam(name = "endDate") Date endDate, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 213  
 
 214  
     /** 
 215  
      * Retrieves a list of milestones of a specified type that fall
 216  
      * within a specified set of dates.
 217  
      *
 218  
      * @param milestoneTypeKey Milestone type to be retrieved
 219  
      * @param startDate Start Date for date range
 220  
      * @param endDate End Date for date range
 221  
      * @param context Context information containing the principalId
 222  
      *                and locale information about the caller of service
 223  
      *                operation
 224  
      * @return List of milestones of this milestone type within this set of dates
 225  
      * @throws InvalidParameterException One or more parameters invalid
 226  
      * @throws MissingParameterException One or more parameters missing
 227  
      * @throws OperationFailedException unable to complete request
 228  
      * @throws PermissionDeniedException authorization failure
 229  
      */
 230  
     public List<MilestoneInfo> getMilestonesByDatesAndType(@WebParam(name = "milestoneTypeKey") String milestoneTypeKey, @WebParam(name = "startDate") Date startDate, @WebParam(name = "endDate") Date endDate, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 231  
 
 232  
     /** 
 233  
      * Validates an academic time period. Depending on the value of
 234  
      * validationType, this validation could be limited to tests on
 235  
      * just the current object and its directly contained subobjects
 236  
      * or expanded to perform all tests related to this object. If an
 237  
      * identifier is present for the academic time period and a record
 238  
      * is found for that identifier, the validation checks if the
 239  
      * academic time period can be shifted to the new values. If a
 240  
      * record cannot be found for the identifier, it is assumed that
 241  
      * the record does not exist and as such, the checks performed
 242  
      * will be much shallower, typically mimicking those performed by
 243  
      * setting the validationType to the current object. This is a
 244  
      * slightly different pattern from the standard validation as the
 245  
      * caller provides the identifier in the create statement instead
 246  
      * of the server assigning an identifier.
 247  
      *
 248  
      * @param validationType Identifier of the extent of validation
 249  
      * @param atpInfo The academic time period information to be tested.
 250  
      * @param context Context information containing the principalId
 251  
      *                and locale information about the caller of service
 252  
      *                operation
 253  
      * @return Results from performing the validation
 254  
      * @throws DoesNotExistException validationTypeKey not found
 255  
      * @throws InvalidParameterException invalid validationTypeKey, atpInfo
 256  
      * @throws MissingParameterException missing validationTypeKey, atpInfo
 257  
      * @throws OperationFailedException unable to complete request
 258  
      */
 259  
     public List<ValidationResultInfo> validateAtp(@WebParam(name = "validationType") String validationType, @WebParam(name = "atpInfo") AtpInfo atpInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 260  
 
 261  
     /** 
 262  
      * Creates a new Academic Time Period.
 263  
      *
 264  
      * @param atpKey Key of ATP to be created
 265  
      * @param atpInfo Details of ATP to be created
 266  
      * @param context Context information containing the principalId
 267  
      *                and locale information about the caller of service
 268  
      *                operation
 269  
      * @return Details of ATP just created
 270  
      * @throws AlreadyExistsException ATP being created already exists
 271  
      * @throws DataValidationErrorException One or more values invalid for this operation
 272  
      * @throws InvalidParameterException One or more parameters invalid
 273  
      * @throws MissingParameterException One or more parameters missing
 274  
      * @throws OperationFailedException unable to complete request
 275  
      * @throws PermissionDeniedException authorization failure
 276  
      */
 277  
     public AtpInfo createAtp(@WebParam(name = "atpKey") String atpKey, @WebParam(name = "atpInfo") AtpInfo atpInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 278  
 
 279  
     /** 
 280  
      * Updates an existing Academic Time Period.
 281  
      *
 282  
      * @param atpKey Key of ATP to be updated
 283  
      * @param atpInfo Details of updates to ATP being updated
 284  
      * @param context Context information containing the principalId
 285  
      *                and locale information about the caller of service
 286  
      *                operation
 287  
      * @return Details of ATP just updated
 288  
      * @throws DataValidationErrorException One or more values invalid for this 
 289  
      *         operation
 290  
      * @throws DoesNotExistException ATP being updated does not exist
 291  
      * @throws InvalidParameterException One or more parameters invalid
 292  
      * @throws MissingParameterException One or more parameters missing
 293  
      * @throws OperationFailedException unable to complete request
 294  
      * @throws PermissionDeniedException authorization failure
 295  
      * @throws VersionMismatchException The action was attempted on an out of date 
 296  
      *         version.
 297  
      */
 298  
     public AtpInfo updateAtp(@WebParam(name = "atpKey") String atpKey, @WebParam(name = "atpInfo") AtpInfo atpInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException;
 299  
 
 300  
     /** 
 301  
      * Deletes an existing Academic Time Period.
 302  
      *
 303  
      * @param atpKey the key of the ATP to be deleted
 304  
      * @param context Context information containing the principalId
 305  
      *                and locale information about the caller of service
 306  
      *                operation
 307  
      * @return status of the operation (success, failed)
 308  
      * @throws DoesNotExistException ATP being deleted does not exist
 309  
      * @throws InvalidParameterException One or more parameters invalid
 310  
      * @throws MissingParameterException One or more parameters missing
 311  
      * @throws OperationFailedException unable to complete request
 312  
      * @throws PermissionDeniedException authorization failure
 313  
      */
 314  
     public StatusInfo deleteAtp(@WebParam(name = "atpKey") String atpKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 315  
 
 316  
     /** 
 317  
      * Validates a milestone. Depending on the value of
 318  
      * validationType, this validation could be limited to tests on
 319  
      * just the current object and its directly contained subobjects
 320  
      * or expanded to perform all tests related to this object. If an
 321  
      * identifier is present for the milestone and a record is found
 322  
      * for that identifier, the validation checks if the milestone can
 323  
      * be shifted to the new values. If a record cannot be found for
 324  
      * the identifier, it is assumed that the record does not exist
 325  
      * and as such, the checks performed will be much shallower,
 326  
      * typically mimicking those performed by setting the
 327  
      * validationType to the current object. This is a slightly
 328  
      * different pattern from the standard validation as the caller
 329  
      * provides the identifier in the create statement instead of the
 330  
      * server assigning an identifier.
 331  
      *
 332  
      * @param validationType Identifier of the extent of validation
 333  
      * @param milestoneInfo The milestone information to be tested.
 334  
      * @param context Context information containing the principalId
 335  
      *                and locale information about the caller of service
 336  
      *                operation
 337  
      * @return Results from performing the validation
 338  
      * @throws DoesNotExistException validationTypeKey not found
 339  
      * @throws InvalidParameterException invalid validationTypeKey, milestoneInfo
 340  
      * @throws MissingParameterException missing validationTypeKey, milestoneInfo
 341  
      * @throws OperationFailedException unable to complete request
 342  
      */
 343  
     public List<ValidationResultInfo> validateMilestone(@WebParam(name = "validationType") String validationType, @WebParam(name = "milestoneInfo") MilestoneInfo milestoneInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 344  
 
 345  
     /** 
 346  
      * Create a new milestone.
 347  
      *
 348  
      * @param milestoneKey the Id of milestone to be added
 349  
      * @param milestoneInfo Details of milestone to be added
 350  
      * @param context Context information containing the principalId
 351  
      *                and locale information about the caller of service
 352  
      *                operation
 353  
      * @return Details of the newly created milestone
 354  
      * @throws AlreadyExistsException Milestone already exists
 355  
      * @throws DataValidationErrorException One or more values invalid for this 
 356  
      *         operation
 357  
      * @throws InvalidParameterException One or more parameters invalid
 358  
      * @throws MissingParameterException One or more parameters missing
 359  
      * @throws OperationFailedException unable to complete request
 360  
      * @throws PermissionDeniedException authorization failure
 361  
      */
 362  
     public MilestoneInfo createMilestone(@WebParam(name = "milestoneKey") String milestoneKey, @WebParam(name = "milestoneInfo") MilestoneInfo milestoneInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 363  
 
 364  
     /** 
 365  
      * Updates an existing milestone.
 366  
      *
 367  
      * @param milestoneKey the Id of milestone to be updated
 368  
      * @param milestoneInfo Details of milestone to be updated
 369  
      * @param context Context information containing the principalId
 370  
      *                and locale information about the caller of service
 371  
      *                operation
 372  
      * @return Details of the updated milestone
 373  
      * @throws DataValidationErrorException One or more values invalid for this 
 374  
      *         operation
 375  
      * @throws DoesNotExistException Milestone being updated does not exist
 376  
      * @throws InvalidParameterException One or more parameters invalid
 377  
      * @throws MissingParameterException One or more parameters missing
 378  
      * @throws OperationFailedException unable to complete request
 379  
      * @throws PermissionDeniedException authorization failure
 380  
      * @throws VersionMismatchException The action was attempted on an out of 
 381  
      *         date version.date
 382  
      */
 383  
     public MilestoneInfo updateMilestone(@WebParam(name = "milestoneKey") String milestoneKey, @WebParam(name = "milestoneInfo") MilestoneInfo milestoneInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException;
 384  
 
 385  
     /** 
 386  
      * Deletes an existing milestone from all ATPs.
 387  
      *
 388  
      * @param milestoneKey the Id of milestone to be removed
 389  
      * @param context Context information containing the principalId
 390  
      *                and locale information about the caller of service
 391  
      *                operation
 392  
      * @return status of the operation (success, failed)
 393  
      * @throws DoesNotExistException Milestone being removed does not exist
 394  
      * @throws InvalidParameterException One or more parameters invalid
 395  
      * @throws MissingParameterException One or more parameters missing
 396  
      * @throws OperationFailedException unable to complete request
 397  
      * @throws PermissionDeniedException authorization failure
 398  
      */
 399  
     public StatusInfo deleteMilestone(@WebParam(name = "milestoneKey") String milestoneKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 400  
 
 401  
     /** 
 402  
      * Retrieves an ATP Milestone Relationship.
 403  
      *
 404  
      * @param atpMilestoneRelationId Unique id of the atp milestone relation 
 405  
      *        to be retrieved
 406  
      * @param context Context information containing the principalId
 407  
      *                and locale information about the caller of service
 408  
      *                operation
 409  
      * @return Details of requested Atp milestone relation
 410  
      * @throws DoesNotExistException atpMilestoneRelationId not found
 411  
      * @throws InvalidParameterException invalid atpMilestonerelationId
 412  
      * @throws MissingParameterException invalid atpMilestoneRelationId
 413  
      * @throws OperationFailedException unable to complete request
 414  
      * @throws PermissionDeniedException authorization failure
 415  
      */
 416  
     public AtpMilestoneRelationInfo getAtpMilestoneRelation(@WebParam(name = "atpMilestoneRelationId") String atpMilestoneRelationId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 417  
 
 418  
     /** 
 419  
      * Retrieves all ATP Milestone Relationships by ATP.
 420  
      *
 421  
      * @param atpKey Unique key of an ATP
 422  
      * @param context Context information containing the principalId
 423  
      *                and locale information about the caller of service
 424  
      *                operation
 425  
      * @return a list of Atp milestone relationships
 426  
      * @throws DoesNotExistException atpKey not found
 427  
      * @throws InvalidParameterException invalid atpKey
 428  
      * @throws MissingParameterException invalid atpKey
 429  
      * @throws OperationFailedException unable to complete request
 430  
      * @throws PermissionDeniedException authorization failure
 431  
      */
 432  
     public List<AtpMilestoneRelationInfo> getAtpMilestoneRelationsByAtp(@WebParam(name = "atpKey") String atpKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 433  
 
 434  
     /** 
 435  
      * Retrieves all ATP Milestone Relationships by Milestone.
 436  
      *
 437  
      * @param milestoneKey Unique key of a Milestone
 438  
      * @param context Context information containing the principalId
 439  
      *                and locale information about the caller of service
 440  
      *                operation
 441  
      * @return a list of Atp milestone relationships
 442  
      * @throws DoesNotExistException atpKey not found
 443  
      * @throws InvalidParameterException invalid milestoneKey
 444  
      * @throws MissingParameterException invalid milestoneKey
 445  
      * @throws OperationFailedException unable to complete request
 446  
      * @throws PermissionDeniedException authorization failure
 447  
      */
 448  
     public List<AtpMilestoneRelationInfo> getAtpMilestoneRelationsByMilestone(@WebParam(name = "milestoneKey") String milestoneKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 449  
 
 450  
     /** 
 451  
      * Validates an ATP/Milestone relationship. Depending on the value
 452  
      * of validationType, this validation could be limited to tests on
 453  
      * just the current object and its directly contained subobjects
 454  
      * or expanded to perform all tests related to this object. If an
 455  
      * identifier is present for the relationship and a record is
 456  
      * found for that identifier, the validation checks if the
 457  
      * relationship can be shifted to the new values. If a
 458  
      * record cannot be found for the identifier, it is assumed that
 459  
      * the record does not exist and as such, the checks performed
 460  
      * will be much shallower, typically mimicking those performed by
 461  
      * setting the validationType to the current object. This is a
 462  
      * slightly different pattern from the standard validation as the
 463  
      * caller provides the identifier in the create statement instead
 464  
      * of the server assigning an identifier.
 465  
      *
 466  
      * @param validationType Identifier of the extent of validation
 467  
      * @param atpMilestoneRelationshipInfo The ATP Milestone Relationship
 468  
      *        to be tested.
 469  
      * @param context Context information containing the principalId
 470  
      *                and locale information about the caller of service
 471  
      *                operation
 472  
      * @return Results from performing the validation
 473  
      * @throws DoesNotExistException validationTypeKey not found
 474  
      * @throws InvalidParameterException invalid validationTypeKey, atpInfo
 475  
      * @throws MissingParameterException missing validationTypeKey, atpInfo
 476  
      * @throws OperationFailedException unable to complete request
 477  
      */
 478  
     public List<ValidationResultInfo> validateAtpMilestoneRelation(@WebParam(name = "validationType") String validationType, @WebParam(name = "atpMilestoneRelationInfo") AtpMilestoneRelationInfo atpMilestoneRelationInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 479  
 
 480  
     /** 
 481  
      * Adds a Milestone to an ATP by creating a relationship.
 482  
      *
 483  
      * @param atpMilestoneRleationship the relationship
 484  
      * @param context Context information containing the principalId
 485  
      *                and locale information about the caller of service
 486  
      *                operation
 487  
      * @return status
 488  
      * @throws AlreadyExistsException Milestone being added already exists
 489  
      * @throws InvalidParameterException One or more parameters invalid
 490  
      * @throws MissingParameterException One or more parameters missing
 491  
      * @throws OperationFailedException unable to complete request
 492  
      * @throws PermissionDeniedException authorization failure
 493  
      */
 494  
     public AtpMilestoneRelationInfo createAtpMilestoneRelation(@WebParam(name = "atpMilestoneRelationInfo") AtpMilestoneRelationInfo atpMilestoneRelationInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 495  
 
 496  
     /** 
 497  
      * Updates an ATP Mielstone Relationship.
 498  
      *
 499  
      * @param atpMilestoneRelationId the Id of the ATP Milestone Relation to be 
 500  
      *        updated
 501  
      * @param atpMilestoneRelationInfo the ATP Milstone relation to be updated
 502  
      * @param context Context information containing the principalId
 503  
      *                and locale information about the caller of service
 504  
      *                operation
 505  
      * @return status
 506  
      * @throws DataValidationErrorException One or more values invalid for this 
 507  
      *         operation
 508  
      * @throws DoesNotExistException Milestone does not exist
 509  
      * @throws InvalidParameterException One or more parameters invalid
 510  
      * @throws MissingParameterException One or more parameters missing
 511  
      * @throws OperationFailedException unable to complete request
 512  
      * @throws PermissionDeniedException authorization failure
 513  
      * @throws VersionMismatchException The action was attempted on an out of 
 514  
      *         date version.date
 515  
      */
 516  
     public AtpMilestoneRelationInfo updateAtpMilestoneRelation(@WebParam(name = "atpMilestonRelationId") String atpMilestoneRelationId, @WebParam(name = "atpMilestoneRelationInfo") AtpMilestoneRelationInfo atpMilestoneRelationInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException;
 517  
 
 518  
     /** 
 519  
      * Removes an existing milestone from an ATP by deleting the relationship.
 520  
      *
 521  
      * @param atpMilestoneRelationshipId the Id of ATP Milestone Relatiosnhip
 522  
      * @param context Context information containing the principalId
 523  
      *                and locale information about the caller of service
 524  
      *                operation
 525  
      * @return status of the operation (success, failed)
 526  
      * @throws DoesNotExistException Milestone being removed does not exist
 527  
      * @throws InvalidParameterException One or more parameters invalid
 528  
      * @throws MissingParameterException One or more parameters missing
 529  
      * @throws OperationFailedException unable to complete request
 530  
      * @throws PermissionDeniedException authorization failure
 531  
      */
 532  
     public StatusInfo deleteAtpMilestoneRelation(@WebParam(name = "atpMilestonRelationId") String atpMilestoneRelationId, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 533  
 }