Coverage Report - org.kuali.student.enrollment.classII.acal.service.AcademicCalendarService
 
Classes in this File Line Coverage Branch Coverage Complexity
AcademicCalendarService
N/A
N/A
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.enrollment.classII.acal.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.enrollment.classII.acal.dto.AcademicCalendarInfo;
 26   
 import org.kuali.student.enrollment.classII.acal.dto.CampusCalendarInfo;
 27   
 import org.kuali.student.enrollment.classII.acal.dto.HolidayInfo;
 28   
 import org.kuali.student.enrollment.classII.acal.dto.KeyDateInfo;
 29   
 import org.kuali.student.enrollment.classII.acal.dto.RegistrationDateGroupInfo;
 30   
 import org.kuali.student.enrollment.classII.acal.dto.TermInfo;
 31   
 import org.kuali.student.r2.common.datadictionary.service.DataDictionaryService;
 32   
 import org.kuali.student.r2.common.dto.ContextInfo;
 33   
 import org.kuali.student.r2.common.dto.StateInfo;
 34   
 import org.kuali.student.r2.common.dto.StatusInfo;
 35   
 import org.kuali.student.r2.common.dto.TypeInfo;
 36   
 import org.kuali.student.r2.common.dto.ValidationResultInfo;
 37   
 import org.kuali.student.r2.common.exceptions.AlreadyExistsException;
 38   
 import org.kuali.student.r2.common.exceptions.DataValidationErrorException;
 39   
 import org.kuali.student.r2.common.exceptions.DoesNotExistException;
 40   
 import org.kuali.student.r2.common.exceptions.InvalidParameterException;
 41   
 import org.kuali.student.r2.common.exceptions.MissingParameterException;
 42   
 import org.kuali.student.r2.common.exceptions.OperationFailedException;
 43   
 import org.kuali.student.r2.common.exceptions.PermissionDeniedException;
 44   
 import org.kuali.student.r2.common.exceptions.VersionMismatchException;
 45   
 import org.kuali.student.r2.common.util.constants.AcademicCalendarServiceConstants;
 46   
 
 47   
 /**
 48   
  * Academic Calendar Service Description and Assumptions.
 49   
  *
 50   
  * This service manages Academic Calendars. An Academic Calendar is
 51   
  * related to a credential program type and contains Terms.
 52   
  *
 53   
  * Key Dates are mapped to Terms but are managed through the service
 54   
  * independent of the Term. This is to allow a reference to a Term
 55   
  * that does not retrieve all the key date information that may relate
 56   
  * to the Term.
 57   
  *
 58   
  * Terms may be nested at this level. A Term may contain another Term
 59   
  * and each of these included Terms may have their own key
 60   
  * dates. Convenience service methods exist to query all the key dates
 61   
  * for an Academic Calendar or Term.
 62   
  *
 63   
  * An Academic Calendar also has a Campus Calendar. The Campus
 64   
  * Calendar has a campus location, and include the key dates and
 65   
  * holidays that are specific to a campus. The same Campus Calendar
 66   
  * can be used for multiple Academic Calendars.
 67   
  *
 68   
  * Version: 1.0 (Dev)
 69   
  *
 70   
  * @Author tom
 71   
  * @Since Sun Apr 10 14:22:34 EDT 2011
 72   
  */
 73   
 
 74   
 @WebService(name = "AcademicCalendarService", targetNamespace = AcademicCalendarServiceConstants.NAMESPACE)
 75   
 @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
 76   
 public interface AcademicCalendarService extends DataDictionaryService {
 77   
 
 78   
     /**
 79   
      * This method returns the TypeInfo for a given academic calendar
 80   
      * type key.
 81   
      *
 82   
      * @param academicCalendarTypeKey Key of the type
 83   
      * @param context Context information containing the principalId
 84   
      *        and locale information about the caller of service
 85   
      *        operation
 86   
      * @return Information about the Type
 87   
      * @throws DoesNotExistException academicCalendarTypeKey not found
 88   
      * @throws InvalidParameterException invalid academicCalendarTypeKey
 89   
      * @throws MissingParameterException missing academicCalendarTypeKey
 90   
      * @throws OperationFailedException unable to complete request
 91   
      */
 92   
     public TypeInfo getAcademicCalendarType(@WebParam(name = "academicCalendarTypeKey") String academicCalendarTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 93   
 
 94   
     /**
 95   
      * This method returns the valid academic calendar types.
 96   
      *
 97   
      * @param context Context information containing the principalId and
 98   
      *        locale information about the caller of service operation
 99   
      * @return a list of valid academic calendar Types
 100   
      * @throws InvalidParameterException invalid context
 101   
      * @throws MissingParameterException missing context
 102   
      * @throws OperationFailedException unable to complete request
 103   
      */
 104   
     public List<TypeInfo> getAcademicCalendarTypes(@WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException;
 105   
 
 106   
     /**
 107   
      * This method returns the details on an academic calendar state.
 108   
      *
 109   
      * @param academicCalendarStateKey a key for an academic calendar state
 110   
      * @param context Context information containing the principalId and
 111   
      *        locale information about the caller of service operation
 112   
      * @return details on the academic calendar state
 113   
      * @throws DoesNotExistException academicCalendarStateKey not found
 114   
      * @throws InvalidParameterException invalid context
 115   
      * @throws MissingParameterException missing context
 116   
      * @throws OperationFailedException unable to complete request
 117   
      */
 118   
     public StateInfo getAcademicCalendarState(@WebParam(name = "academicCalendarStateKey") String academicCalendarStateKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 119   
 
 120   
     /**
 121   
      * This method returns the possible academic calendar states.
 122   
      *
 123   
      * @param context Context information containing the principalId and
 124   
      *        locale information about the caller of service operation
 125   
      * @return a list of valid academic calendar states
 126   
      * @throws InvalidParameterException invalid context
 127   
      * @throws MissingParameterException missing context
 128   
      * @throws OperationFailedException unable to complete request
 129   
      */
 130   
     public List<StateInfo> getAcademicCalendarStates(@WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, DoesNotExistException;
 131   
 
 132   
     /**
 133   
      * Retrieves the details of a single Academic Calendar by an
 134   
      * academic calendar key.
 135   
      *
 136   
      * @param academicCalendarKey Unique key of the Academic Calendar to be retrieved
 137   
      * @param context Context information containing the principalId
 138   
      *                and locale information about the caller of service
 139   
      *                operation
 140   
      * @return the details of the Academic Calendar requested
 141   
      * @throws DoesNotExistException academicCalendarKey not found
 142   
      * @throws InvalidParameterException invalid academicCalendarKey
 143   
      * @throws MissingParameterException missing academicCalendarKey
 144   
      * @throws OperationFailedException unable to complete request
 145   
      * @throws PermissionDeniedException authorization failure
 146   
      */
 147   
     public AcademicCalendarInfo getAcademicCalendar(@WebParam(name = "academicCalendarKey") String academicCalendarKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 148   
 
 149   
     /**
 150   
      * Retrieves a list Academic Calendars corresponding to a list of
 151   
      * academic calendar keys.
 152   
      *
 153   
      * @param academicCalendarKeyList list of unique keys of the
 154   
      *        Academic Calendar to be retrieved
 155   
      * @param context Context information containing the principalId
 156   
      *                and locale information about the caller of service
 157   
      *                operation
 158   
      * @return a list of Academic Calendars
 159   
      * @throws DoesNotExistException an  academicCalendarKey in list not found
 160   
      * @throws InvalidParameterException invalid academicCalendarKey in list
 161   
      * @throws MissingParameterException missing academicCalendarKeyList
 162   
      * @throws OperationFailedException unable to complete request
 163   
      * @throws PermissionDeniedException authorization failure
 164   
      */
 165   
     public List<AcademicCalendarInfo> getAcademicCalendarsByKeyList(@WebParam(name = "academicCalendarKeyList") List<String> academicCalendarKeyList, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 166   
 
 167   
     /**
 168   
      * Retrieves a list of Academic Calendar Keys by Type.
 169   
      *
 170   
      * @param academicCalendarTypeKey a Type of Academic Calendar to be retrieved
 171   
      * @param context Context information containing the principalId
 172   
      *                and locale information about the caller of service
 173   
      *                operation
 174   
      * @return a list of Academic Calendars of the given Type
 175   
      * @throws InvalidParameterException invalid academicCalendarTypeKey
 176   
      * @throws MissingParameterException missing academicCalendarTypeKey
 177   
      * @throws OperationFailedException unable to complete request
 178   
      * @throws PermissionDeniedException authorization failure
 179   
      */
 180   
     public List<String> getAcademicCalendarKeysByType(@WebParam(name = "academicCalendarTypeKey") String academicCalendarTypeKey, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 181   
 
 182   
     /**
 183   
      * Retrieves a list of Academic Calendars that pertain to the
 184   
      * given year.
 185   
      *
 186   
      * @param year
 187   
      * @param context Context information containing the principalId
 188   
      *                and locale information about the caller of service
 189   
      *                operation
 190   
      * @return a list of Academic Calendars
 191   
      * @throws InvalidParameterException invalid year
 192   
      * @throws MissingParameterException missing year
 193   
      * @throws OperationFailedException unable to complete request
 194   
      * @throws PermissionDeniedException authorization failure
 195   
      */
 196   
     public List<AcademicCalendarInfo> getAcademicCalendarsByYear(@WebParam(name = "year") Integer year, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 197   
 
 198   
     /**
 199   
      * Retrieves a list of Academic Calendars mapped to a credential
 200   
      * program type.
 201   
      *
 202   
      * @param credentialProgramTypeKey a Type of a credential program
 203   
      * @param context Context information containing the principalId
 204   
      *                and locale information about the caller of service
 205   
      *                operation
 206   
      * @return a list of Academic Calendars
 207   
      * @throws InvalidParameterException invalid credentialProgramTypeKey
 208   
      * @throws MissingParameterException missing credentialProgramTypeKey
 209   
      * @throws OperationFailedException unable to complete request
 210   
      * @throws PermissionDeniedException authorization failure
 211   
      */
 212   
     public List<AcademicCalendarInfo> getAcademicCalendarsByCredentialProgramType(@WebParam(name = "credentialProgramTypeKey") String credentialProgramTypeKey, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 213   
 
 214   
     /**
 215   
      * Retrieves a list of Academic Calendars mapped to a credential
 216   
      * program type and pertains to the given year.
 217   
      *
 218   
      * @param credentialProgramTypeKey a Type of a credential program
 219   
      * @param year
 220   
      * @param context Context information containing the principalId
 221   
      *                and locale information about the caller of service
 222   
      *                operation
 223   
      * @return a list of Academic Calendars
 224   
      * @throws InvalidParameterException invalid credentialProgramType or year
 225   
      * @throws MissingParameterException missing credentialProgramTypeKey or year
 226   
      * @throws OperationFailedException unable to complete request
 227   
      * @throws PermissionDeniedException authorization failure
 228   
      */
 229   
     public List<AcademicCalendarInfo> getAcademicCalendarsByCredentialProgramTypeForYear(@WebParam(name = "credentialProgramTypeKey") String credentialProgramTypeKey, @WebParam(name = "year") Integer year, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 230   
 
 231   
     /**
 232   
      * Validates an academic calendar. Depending on the value of
 233   
      * validationType, this validation could be limited to tests on
 234   
      * just the current object and its directly contained subobjects
 235   
      * or expanded to perform all tests related to this object. If an
 236   
      * identifier is present for the academic calendar and a record
 237   
      * is found for that identifier, the validation checks if the
 238   
      * academic calendar can be shifted to the new values. If a
 239   
      * record cannot be found for the identifier, it is assumed that
 240   
      * the record does not exist and as such, the checks performed
 241   
      * will be much shallower, typically mimicking those performed by
 242   
      * setting the validationType to the current object. This is a
 243   
      * slightly different pattern from the standard validation as the
 244   
      * caller provides the identifier in the create statement instead
 245   
      * of the server assigning an identifier.
 246   
      *
 247   
      * @param validationType Identifier of the extent of validation
 248   
      * @param academicCalendarInfo the academic calendar information to be tested.
 249   
      * @param context Context information containing the principalId
 250   
      *                and locale information about the caller of service
 251   
      *                operation
 252   
      * @return the results from performing the validation
 253   
      * @throws DoesNotExistException validationTypeKey not found
 254   
      * @throws InvalidParameterException invalid validationTypeKey, academicCalendarInfo
 255   
      * @throws MissingParameterException missing validationTypeKey, academicCalendarInfo
 256   
      * @throws OperationFailedException unable to complete request
 257   
      */
 258   
     public List<ValidationResultInfo> validateAcademicCalendar(@WebParam(name = "validationType") String validationType, @WebParam(name = "academicCalendarInfo") AcademicCalendarInfo academicCalendarInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 259   
 
 260   
     /**
 261   
      * Creates a new Academic Calendar.
 262   
      *
 263   
      * @param academicCalendarKey the key of the Academic Calendar to be created
 264   
      * @param academicCalendarInfo Details of the Academic Calendar to be created
 265   
      * @param context Context information containing the principalId
 266   
      *                and locale information about the caller of service
 267   
      *                operation
 268   
      * @return the details of the Academic Calendar just created
 269   
      * @throws AlreadyExistsException the Academic Calendar being created already exists
 270   
      * @throws DataValidationErrorException One or more values invalid for this operation
 271   
      * @throws InvalidParameterException One or more parameters invalid
 272   
      * @throws MissingParameterException One or more parameters missing
 273   
      * @throws OperationFailedException unable to complete request
 274   
      * @throws PermissionDeniedException authorization failure
 275   
      */
 276   
     public AcademicCalendarInfo createAcademicCalendar(@WebParam(name = "academicCalendarKey") String academicCalendarKey, @WebParam(name = "academicCalendarInfo") AcademicCalendarInfo academicCalendarInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 277   
 
 278   
     /**
 279   
      * Updates an existing Academic Calendar.
 280   
      *
 281   
      * @param academicCalendarKey Key of Academic Calendar to be updated
 282   
      * @param academicCalendarInfo Details of updates to the Academic
 283   
      *        Calendar being updated
 284   
      * @param context Context information containing the principalId
 285   
      *                and locale information about the caller of service
 286   
      *                operation
 287   
      * @return the details of Academic Calendar just updated
 288   
      * @throws DataValidationErrorException One or more values invalid for this
 289   
      *         operation
 290   
      * @throws DoesNotExistException the Academic Calendar 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 AcademicCalendarInfo updateAcademicCalendar(@WebParam(name = "academicCalendarKey") String academicCalendarKey, @WebParam(name = "academicCalendarInfo") AcademicCalendarInfo academicCalendarInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException;
 299   
 
 300   
     /**
 301   
      * Deletes an existing Academic Calendar.
 302   
      *
 303   
      * @param academicCalendarKey the key of the Academic Calendar to
 304   
      *        be deleted
 305   
      * @param context Context information containing the principalId
 306   
      *                and locale information about the caller of service
 307   
      *                operation
 308   
      * @return status of the operation (success, failed)
 309   
      * @throws DoesNotExistException the Academic Calendar does not exist
 310   
      * @throws InvalidParameterException One or more parameters invalid
 311   
      * @throws MissingParameterException One or more parameters missing
 312   
      * @throws OperationFailedException unable to complete request
 313   
      * @throws PermissionDeniedException authorization failure
 314   
      */
 315   
     public StatusInfo deleteAcademicCalendar(@WebParam(name = "academicCalendarKey") String academicCalendarKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 316   
 
 317   
     /**
 318   
      * Copy an Academic Calendar. The associated Terms and key dates
 319   
      * are also copied and related to this new calendar. This copy
 320   
      * operation allows for a calendar template to be created from an
 321   
      * existing calendar in which the dates of the Terms and
 322   
      * Key Dates will be updated.
 323   
      *
 324   
      * Currently, this method does not perform any date
 325   
      * transformations on the Terms and key dates (Labor Day has a
 326   
      * new date). A rollover process needs to make a copy of a
 327   
      * calendar and set the new dates for the new year.
 328   
      *
 329   
      * @param academicCalendarKey the key of the Academic Calendar to
 330   
      *        be copied
 331   
      * @param newAcademicCalendarKey the key of the new copy of the
 332   
      *        Academic Calendar
 333   
      * @param context Context information containing the principalId
 334   
      *                and locale information about the caller of service
 335   
      *                operation
 336   
      * @return status of the operation (success, failed)
 337   
      * @throws AlreadyExistsException newAcademicCalendarKey already exists
 338   
      * @throws DoesNotExistException the Academic Calendar does not exist
 339   
      * @throws InvalidParameterException One or more parameters invalid
 340   
      * @throws MissingParameterException One or more parameters missing
 341   
      * @throws OperationFailedException unable to complete request
 342   
      * @throws PermissionDeniedException authorization failure
 343   
      */
 344   
     public AcademicCalendarInfo copyAcademicCalendar(@WebParam(name = "academicCalendarKey") String academicCalendarKey, @WebParam(name = "newAcademicCalendarKey") String newAcademicCalendarKey, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 345   
 
 346   
     /**
 347   
      * Generates calendaring data for the Terms and key dates in an
 348   
      * Academic Calendar. The format of the data is specified by the
 349   
      * calendarDataFormatType. An example of such a type is VCALENDAR.
 350   
      *
 351   
      * @param academicCalendarKey the key of the Academic Calendar to
 352   
      *        be retrieved
 353   
      * @param calendarDataFormatTypeKey the type of format
 354   
      * @param context Context information containing the principalId
 355   
      *                and locale information about the caller of service
 356   
      *                operation
 357   
      * @return status of the operation (success, failed)
 358   
      * @throws DoesNotExistException the Academic Calendar or format
 359   
      *         type does not exist
 360   
      * @throws InvalidParameterException One or more parameters invalid
 361   
      * @throws MissingParameterException One or more parameters missing
 362   
      * @throws OperationFailedException unable to complete request
 363   
      * @throws PermissionDeniedException authorization failure
 364   
      */
 365   
     public String getAcademicCalendarData(@WebParam(name = "academicCalendarKey") String academicCalendarKey, @WebParam(name = "calendarDataFormatTypeKey") String calendarDataFormatTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 366   
 
 367   
     /**
 368   
      * This method returns the TypeInfo for a campus calendar type
 369   
      * key.
 370   
      *
 371   
      * @param campusCalendarTypeKey Key of the type
 372   
      * @param context Context information containing the principalId
 373   
      *        and locale information about the caller of service
 374   
      *        operation
 375   
      * @return Information about the Type
 376   
      * @throws DoesNotExistException  campusCalendarTypeKey not found
 377   
      * @throws InvalidParameterException invalid campusCalendarTypeKey
 378   
      * @throws MissingParameterException missing campusCalendarTypeKey
 379   
      * @throws OperationFailedException unable to complete request
 380   
      */
 381   
     public TypeInfo getCampusCalendarType(@WebParam(name = "campusCalendarTypeKey") String campusCalendarTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 382   
 
 383   
     /**
 384   
      * This method returns the valid campus calendar types.
 385   
      *
 386   
      * @param context Context information containing the principalId
 387   
      *        and locale information about the caller of service
 388   
      *        operation
 389   
      * @return a list of valid campus calendar Types
 390   
      * @throws InvalidParameterException invalid context
 391   
      * @throws MissingParameterException missing context
 392   
      * @throws OperationFailedException unable to complete request
 393   
      */
 394   
     public List<TypeInfo> getCampusCalendarTypes(@WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException;
 395   
 
 396   
     /**
 397   
      * This method returns the details on a campus calendar state.
 398   
      *
 399   
      * @param campusCalendarStateKey a key for a campus calendar state
 400   
      * @param context Context information containing the principalId and
 401   
      *        locale information about the caller of service operation
 402   
      * @return details on the campus calendar state
 403   
      * @throws DoesNotExistException campusCalendarStateKey not found
 404   
      * @throws InvalidParameterException invalid context
 405   
      * @throws MissingParameterException missing context
 406   
      * @throws OperationFailedException unable to complete request
 407   
      */
 408   
     public StateInfo getCampusCalendarState(@WebParam(name = "campusCalendarStateKey") String campusCalendarStateKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 409   
 
 410   
     /**
 411   
      * This method returns the possible campus calendar states.
 412   
      *
 413   
      * @param context Context information containing the principalId and
 414   
      *        locale information about the caller of service operation
 415   
      * @return a list of valid campus calendar states
 416   
      * @throws InvalidParameterException invalid context
 417   
      * @throws MissingParameterException missing context
 418   
      * @throws OperationFailedException unable to complete request
 419   
      * @throws DoesNotExistException
 420   
      */
 421   
     public List<StateInfo> getCampusCalendarStates(@WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, DoesNotExistException;
 422   
 
 423   
     /**
 424   
      * Retrieves the details of a single Campus Calendar by an
 425   
      * campus calendar key.
 426   
      *
 427   
      * @param campusCalendarKey Unique key of the Campus Calendar to be retrieved
 428   
      * @param context Context information containing the principalId
 429   
      *                and locale information about the caller of service
 430   
      *                operation
 431   
      * @return the details of the Campus Calendar requested
 432   
      * @throws DoesNotExistException campusCalendarKey not found
 433   
      * @throws InvalidParameterException invalid campusCalendarKey
 434   
      * @throws MissingParameterException missing campusCalendarKey
 435   
      * @throws OperationFailedException unable to complete request
 436   
      * @throws PermissionDeniedException authorization failure
 437   
      */
 438   
     public CampusCalendarInfo getCampusCalendar(@WebParam(name = "campusCalendarKey") String campusCalendarKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 439   
 
 440   
     /**
 441   
      * Retrieves a list Campus Calendars corresponding to a list of
 442   
      * campus calendar keys.
 443   
      *
 444   
      * @param campusCalendarKeyList list of unique keys of the
 445   
      *        Campus Calendar to be retrieved
 446   
      * @param context Context information containing the principalId
 447   
      *                and locale information about the caller of service
 448   
      *                operation
 449   
      * @return a list of Campus Calendars
 450   
      * @throws DoesNotExistException a campusCalendarKey in list not found
 451   
      * @throws InvalidParameterException invalid campusCalendarKey in list
 452   
      * @throws MissingParameterException missing campusCalendarKeyList
 453   
      * @throws OperationFailedException unable to complete request
 454   
      * @throws PermissionDeniedException authorization failure
 455   
      */
 456   
     public List<CampusCalendarInfo> getCampusCalendarsByKeyList(@WebParam(name = "campusCalendarKeyList") List<String> campusCalendarKeyList, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 457   
 
 458   
     /**
 459   
      * Retrieves a list of Campus Calendars by Type.
 460   
      *
 461   
      * @param campusCalendarTypeKey a Type of Campus Calendar to be retrieved
 462   
      * @param context Context information containing the principalId
 463   
      *                and locale information about the caller of service
 464   
      *                operation
 465   
      * @return a list of Campus Calendars of the given Type
 466   
      * @throws InvalidParameterException invalid campusCalendarTypeKey
 467   
      * @throws MissingParameterException missing campusCalendarTypeKey
 468   
      * @throws OperationFailedException unable to complete request
 469   
      * @throws PermissionDeniedException authorization failure
 470   
      */
 471   
     public List<String> getCampusCalendarKeysByType(@WebParam(name = "campusCalendarTypeKey") String campusCalendarTypeKey, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 472   
 
 473   
     /**
 474   
      * Retrieves a list of Campus Calendars that pertain to the
 475   
      * given year.
 476   
      *
 477   
      * @param year
 478   
      * @param context Context information containing the principalId
 479   
      *                and locale information about the caller of service
 480   
      *                operation
 481   
      * @return a list of Campus Calendars
 482   
      * @throws InvalidParameterException invalid year
 483   
      * @throws MissingParameterException missing year
 484   
      * @throws OperationFailedException unable to complete request
 485   
      * @throws PermissionDeniedException authorization failure
 486   
      */
 487   
     public List<CampusCalendarInfo> getCampusCalendarsByYear(@WebParam(name = "year") Integer year, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 488   
 
 489   
     /**
 490   
      * Validates a campus calendar. Depending on the value of
 491   
      * validationType, this validation could be limited to tests on
 492   
      * just the current object and its directly contained subobjects
 493   
      * or expanded to perform all tests related to this object. If an
 494   
      * identifier is present for the campus calendar and a record
 495   
      * is found for that identifier, the validation checks if the
 496   
      * campus calendar can be shifted to the new values. If a
 497   
      * record cannot be found for the identifier, it is assumed that
 498   
      * the record does not exist and as such, the checks performed
 499   
      * will be much shallower, typically mimicking those performed by
 500   
      * setting the validationType to the current object. This is a
 501   
      * slightly different pattern from the standard validation as the
 502   
      * caller provides the identifier in the create statement instead
 503   
      * of the server assigning an identifier.
 504   
      *
 505   
      * @param validationType Identifier of the extent of validation
 506   
      * @param campusCalendarInfo the campus calendar information to be tested.
 507   
      * @param context Context information containing the principalId
 508   
      *                and locale information about the caller of service
 509   
      *                operation
 510   
      * @return the results from performing the validation
 511   
      * @throws DoesNotExistException validationTypeKey not found
 512   
      * @throws InvalidParameterException invalid validationTypeKey, campusCalendarInfo
 513   
      * @throws MissingParameterException missing validationTypeKey, campusCalendarInfo
 514   
      * @throws OperationFailedException unable to complete request
 515   
      */
 516   
     public List<ValidationResultInfo> validateCampusCalendar(@WebParam(name = "validationType") String validationType, @WebParam(name = "campusCalendarInfo") CampusCalendarInfo campusCalendarInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 517   
 
 518   
     /**
 519   
      * Creates a new Campus Calendar.
 520   
      *
 521   
      * @param campusCalendarKey the key of the Campus Calendar to be created
 522   
      * @param campusCalendarInfo Details of the Campus Calendar to be created
 523   
      * @param context Context information containing the principalId
 524   
      *                and locale information about the caller of service
 525   
      *                operation
 526   
      * @return the details of the Campus Calendar just created
 527   
      * @throws AlreadyExistsException the Campus Calendar being created already exists
 528   
      * @throws DataValidationErrorException One or more values invalid for this operation
 529   
      * @throws InvalidParameterException One or more parameters invalid
 530   
      * @throws MissingParameterException One or more parameters missing
 531   
      * @throws OperationFailedException unable to complete request
 532   
      * @throws PermissionDeniedException authorization failure
 533   
      */
 534   
     public CampusCalendarInfo createCampusCalendar(@WebParam(name = "campusCalendarKey") String campusCalendarKey, @WebParam(name = "campusCalendarInfo") CampusCalendarInfo campusCalendarInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 535   
 
 536   
     /**
 537   
      * Updates an existing Campus Calendar.
 538   
      *
 539   
      * @param campusCalendarKey Key of Campus Calendar to be updated
 540   
      * @param campusCalendarInfo Details of updates to the Campus
 541   
      *        Calendar being updated
 542   
      * @param context Context information containing the principalId
 543   
      *                and locale information about the caller of service
 544   
      *                operation
 545   
      * @return the details of Campus Calendar just updated
 546   
      * @throws DataValidationErrorException One or more values invalid for this
 547   
      *         operation
 548   
      * @throws DoesNotExistException the Campus Calendar does not exist
 549   
      * @throws InvalidParameterException One or more parameters invalid
 550   
      * @throws MissingParameterException One or more parameters missing
 551   
      * @throws OperationFailedException unable to complete request
 552   
      * @throws PermissionDeniedException authorization failure
 553   
      * @throws VersionMismatchException The action was attempted on an out of date
 554   
      *         version.
 555   
      */
 556   
     public CampusCalendarInfo updateCampusCalendar(@WebParam(name = "campusCalendarKey") String campusCalendarKey, @WebParam(name = "campusCalendarInfo") CampusCalendarInfo campusCalendarInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException;
 557   
 
 558   
     /**
 559   
      * Deletes an existing Campus Calendar.
 560   
      *
 561   
      * @param campusCalendarKey the key of the Campus Calendar to
 562   
      *        be deleted
 563   
      * @param context Context information containing the principalId
 564   
      *                and locale information about the caller of service
 565   
      *                operation
 566   
      * @return status of the operation (success, failed)
 567   
      * @throws DoesNotExistException the Campus Calendar does not exist
 568   
      * @throws InvalidParameterException One or more parameters invalid
 569   
      * @throws MissingParameterException One or more parameters missing
 570   
      * @throws OperationFailedException unable to complete request
 571   
      * @throws PermissionDeniedException authorization failure
 572   
      */
 573   
     public StatusInfo deleteCampusCalendar(@WebParam(name = "campusCalendarKey") String campusCalendarKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 574   
 
 575   
     /**
 576   
      * This method returns the TypeInfo for a given Term type key.
 577   
      *
 578   
      * @param termTypeKey Key of the type
 579   
      * @param context Context information containing the principalId
 580   
      *        and locale information about the caller of service
 581   
      *        operation
 582   
      * @return Information about the Type
 583   
      * @throws DoesNotExistException  termTypeKey not found
 584   
      * @throws InvalidParameterException invalid termTypeKey
 585   
      * @throws MissingParameterException missing termTypeKey
 586   
      * @throws OperationFailedException unable to complete request
 587   
      */
 588   
     public TypeInfo getTermType(@WebParam(name = "termTypeKey") String termTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 589   
 
 590   
     /**
 591   
      * This method returns all the valid Term types.
 592   
      *
 593   
      * @param context Context information containing the principalId
 594   
      *        and locale information about the caller of service
 595   
      *        operation
 596   
      * @return a list of valid term Types
 597   
      * @throws InvalidParameterException invalid context
 598   
      * @throws MissingParameterException missing context
 599   
      * @throws OperationFailedException unable to complete request
 600   
      */
 601   
     public List<TypeInfo> getTermTypes(@WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException;
 602   
 
 603   
     /**
 604   
      * This method returns the valid Term types for an
 605   
      * Academic Calendar Type. Only Terms of allowed Types
 606   
      * can be mapped to an Academic Calendar.
 607   
      *
 608   
      * @param academicCalendarTypeKey a key of an academic calendar type
 609   
      * @param context Context information containing the principalId
 610   
      *        and locale information about the caller of service
 611   
      *        operation
 612   
      * @return a list of valid term Types
 613   
      * @throws DoesNotExistException  academicCalendarTypeKey not found
 614   
      * @throws InvalidParameterException invalid parameter
 615   
      * @throws MissingParameterException missing parameter
 616   
      * @throws OperationFailedException unable to complete request
 617   
      */
 618   
     public List<TypeInfo> getTermTypesForAcademicCalendarType(@WebParam(name="academicCalendarTypeKey") String academicCalendarTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 619   
 
 620   
     /**
 621   
      * This method returns the valid Term types for a Term Type. Only
 622   
      * Terms of allowed Types can be included inside another Term.
 623   
      *
 624   
      * @param termTypeKey a key of a term type
 625   
      * @param context Context information containing the principalId
 626   
      *        and locale information about the caller of service
 627   
      *        operation
 628   
      * @return a list of valid term Types
 629   
      * @throws DoesNotExistException  termTypeKey not found
 630   
      * @throws InvalidParameterException invalid parameter
 631   
      * @throws MissingParameterException missing parameter
 632   
      * @throws OperationFailedException unable to complete request
 633   
      */
 634   
     public List<TypeInfo> getTermTypesForTermType(@WebParam(name="termTypeKey") String termTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 635   
 
 636   
     /**
 637   
      * This method returns the details on a term state.
 638   
      *
 639   
      * @param termStateKey a key for a term state
 640   
      * @param context Context information containing the principalId and
 641   
      *        locale information about the caller of service operation
 642   
      * @return state info
 643   
      * @throws DoesNotExistException  termTypeKey not found
 644   
      * @throws InvalidParameterException invalid context
 645   
      * @throws MissingParameterException missing context
 646   
      * @throws OperationFailedException unable to complete request
 647   
      */
 648   
     public StateInfo getTermState(@WebParam(name = "termStateKey") String termStateKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 649   
 
 650   
     /**
 651   
      * This method returns the possible term states.
 652   
      *
 653   
      * @param context Context information containing the principalId and
 654   
      *        locale information about the caller of service operation
 655   
      * @return a list of valid term states
 656   
      * @throws InvalidParameterException invalid context
 657   
      * @throws MissingParameterException missing context
 658   
      * @throws OperationFailedException unable to complete request
 659   
      * @throws DoesNotExistException
 660   
      */
 661   
     public List<StateInfo> getTermStates(@WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, DoesNotExistException;
 662   
 
 663   
     /**
 664   
      * Retrieves the details of a single Term by a term key.
 665   
      *
 666   
      * @param termKey Unique key of the Term to be retrieved
 667   
      * @param context Context information containing the principalId
 668   
      *                and locale information about the caller of service
 669   
      *                operation
 670   
      * @return the details of the Term requested
 671   
      * @throws DoesNotExistException termKey not found
 672   
      * @throws InvalidParameterException invalid termKey
 673   
      * @throws MissingParameterException missing termKey
 674   
      * @throws OperationFailedException unable to complete request
 675   
      * @throws PermissionDeniedException authorization failure
 676   
      */
 677   
     public TermInfo getTerm(@WebParam(name = "termKey") String termKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 678   
 
 679   
     /**
 680   
      * Retrieves a list Terms corresponding to a list of
 681   
      * terms keys.
 682   
      *
 683   
      * @param termKeyList list of unique keys of the
 684   
      *        Term to be retrieved
 685   
      * @param context Context information containing the principalId
 686   
      *                and locale information about the caller of service
 687   
      *                operation
 688   
      * @return a list of Terms
 689   
      * @throws DoesNotExistException a termKey in list not found
 690   
      * @throws InvalidParameterException invalid termKey in list
 691   
      * @throws MissingParameterException missing termKeyList
 692   
      * @throws OperationFailedException unable to complete request
 693   
      * @throws PermissionDeniedException authorization failure
 694   
      */
 695   
     public List<TermInfo> getTermsByKeyList(@WebParam(name = "termKeyList") List<String> termKeyList, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 696   
 
 697   
     /**
 698   
      * Retrieves a list of Terms by Type.
 699   
      *
 700   
      * @param termTypeKey a Type of Term to be retrieved
 701   
      * @param context Context information containing the principalId
 702   
      *                and locale information about the caller of service
 703   
      *                operation
 704   
      * @return a list of Terms of the given Type
 705   
      * @throws InvalidParameterException invalid termTypeKey
 706   
      * @throws MissingParameterException missing termTypeKey
 707   
      * @throws OperationFailedException unable to complete request
 708   
      * @throws PermissionDeniedException authorization failure
 709   
      */
 710   
     public List<String> getTermKeysByType(@WebParam(name = "termTypeKey") String termTypeKey, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 711   
 
 712   
     /**
 713   
      * Retrieves a list Terms mapped to the given Academic Calendar
 714   
      * sorted by Term start date.
 715   
      *
 716   
      * Mappings are managed through Type configuration and inferred by
 717   
      * the dates of the calendar and term so operations to manage the
 718   
      * mappings are not currently defined.
 719   
      *
 720   
      * @param academicCalendarKey a key for an academic calendar
 721   
      * @param context Context information containing the principalId
 722   
      *                and locale information about the caller of service
 723   
      *                operation
 724   
      * @return a list of Terms
 725   
      * @throws DoesNotExistException the academic calendar not found
 726   
      * @throws InvalidParameterException invalid acadenmicCalendarKey
 727   
      * @throws MissingParameterException missing academicCalendarKey
 728   
      * @throws OperationFailedException unable to complete request
 729   
      * @throws PermissionDeniedException authorization failure
 730   
      */
 731   
     public List<TermInfo> getTermsForAcademicCalendar(@WebParam(name = "academicCalendarKey") String academicCalendarKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 732   
 
 733   
     /**
 734   
      * Retrieves a list Terms included inside the given Term sorted
 735   
      * by Term start date,
 736   
      *
 737   
      * Mappings are managed through Type configuration and inferred by
 738   
      * the dates of the terms so operations to manage the mappings are
 739   
      * not currently defined.
 740   
      *
 741   
      * @param termKey a key for a Term
 742   
      * @param context Context information containing the principalId
 743   
      *                and locale information about the caller of service
 744   
      *                operation
 745   
      * @return a list of Terms
 746   
      * @throws DoesNotExistException the term is not found
 747   
      * @throws InvalidParameterException invalid termKey
 748   
      * @throws MissingParameterException missing termKey
 749   
      * @throws OperationFailedException unable to complete request
 750   
      * @throws PermissionDeniedException authorization failure
 751   
      */
 752   
     public List<TermInfo> getIncludedTermsInTerm(@WebParam(name = "termKey") String termKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 753   
 
 754   
     /**
 755   
      * Gets the containing terms of a given term. A term may be
 756   
      * "included" inside other terms using addTermToTerm(). This
 757   
      * method returns the list of terms that the given term has been
 758   
      * placed inside.
 759   
      *
 760   
      * @param termKey a key for a Term
 761   
      * @param context Context information containing the principalId
 762   
      *                and locale information about the caller of service
 763   
      *                operation
 764   
      * @return the parent term or null if it is a root
 765   
      * @throws DoesNotExistException the term is not found
 766   
      * @throws InvalidParameterException invalid termKey
 767   
      * @throws MissingParameterException missing termKey
 768   
      * @throws OperationFailedException unable to complete request
 769   
      * @throws PermissionDeniedException authorization failure
 770   
      */
 771   
     public List<TermInfo> getContainingTerms(@WebParam(name = "termKey") String termKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 772   
 
 773   
     /**
 774   
      * Validates a term. Depending on the value of validationType,
 775   
      * this validation could be limited to tests on just the current
 776   
      * object and its directly contained subobjects or expanded to
 777   
      * perform all tests related to this object. If an identifier is
 778   
      * present for the term and a record is found for that identifier,
 779   
      * the validation checks if the term can be shifted to the new
 780   
      * values. If a record cannot be found for the identifier, it is
 781   
      * assumed that the record does not exist and as such, the checks
 782   
      * performed will be much shallower, typically mimicking those
 783   
      * performed by setting the validationType to the current
 784   
      * object. This is a slightly different pattern from the standard
 785   
      * validation as the caller provides the identifier in the create
 786   
      * statement instead of the server assigning an identifier.
 787   
      *
 788   
      * @param validationType Identifier of the extent of validation
 789   
      * @param termInfo the term information to be tested.
 790   
      * @param context Context information containing the principalId
 791   
      *                and locale information about the caller of service
 792   
      *                operation
 793   
      * @return the results from performing the validation
 794   
      * @throws DoesNotExistException validationTypeKey not found
 795   
      * @throws InvalidParameterException invalid validationTypeKey, termInfo
 796   
      * @throws MissingParameterException missing validationTypeKey, termInfo
 797   
      * @throws OperationFailedException unable to complete request
 798   
      */
 799   
     public List<ValidationResultInfo> validateTerm(@WebParam(name = "validationType") String validationType, @WebParam(name = "termInfo") TermInfo termInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 800   
 
 801   
     /**
 802   
      * Creates a new Tern.
 803   
      *
 804   
      * @param termKey the key of the term to be created
 805   
      * @param termInfo Details of the term to be created
 806   
      * @param context Context information containing the principalId
 807   
      *                and locale information about the caller of service
 808   
      *                operation
 809   
      * @return the details of the Term just created
 810   
      * @throws AlreadyExistsException the Term being created already exists
 811   
      * @throws DataValidationErrorException One or more values invalid for this operation
 812   
      * @throws InvalidParameterException One or more parameters invalid
 813   
      * @throws MissingParameterException One or more parameters missing
 814   
      * @throws OperationFailedException unable to complete request
 815   
      * @throws PermissionDeniedException authorization failure
 816   
      */
 817   
     public TermInfo createTerm(@WebParam(name = "termKey") String termKey, @WebParam(name = "termInfo") TermInfo termInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 818   
 
 819   
     /**
 820   
      * Updates an existing Term.
 821   
      *
 822   
      * @param termKey Key of Term to be updated
 823   
      * @param termInfo Details of updates to the Term being updated
 824   
      * @param context Context information containing the principalId
 825   
      *                and locale information about the caller of service
 826   
      *                operation
 827   
      * @return the details of Term just updated
 828   
      * @throws DataValidationErrorException One or more values invalid for this
 829   
      *         operation
 830   
      * @throws DoesNotExistException the Term does not exist
 831   
      * @throws InvalidParameterException One or more parameters invalid
 832   
      * @throws MissingParameterException One or more parameters missing
 833   
      * @throws OperationFailedException unable to complete request
 834   
      * @throws PermissionDeniedException authorization failure
 835   
      * @throws VersionMismatchException The action was attempted on an out of date
 836   
      *         version.
 837   
      */
 838   
     public TermInfo updateTerm(@WebParam(name = "termKey") String termKey, @WebParam(name = "termInfo") TermInfo termInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException;
 839   
 
 840   
     /**
 841   
      * Deletes an existing Term.
 842   
      *
 843   
      * @param termKey the key of the Term to be deleted
 844   
      * @param context Context information containing the principalId
 845   
      *                and locale information about the caller of service
 846   
      *                operation
 847   
      * @return status of the operation (success, failed)
 848   
      * @throws DoesNotExistException the Term does not exist
 849   
      * @throws InvalidParameterException One or more parameters invalid
 850   
      * @throws MissingParameterException One or more parameters missing
 851   
      * @throws OperationFailedException unable to complete request
 852   
      * @throws PermissionDeniedException authorization failure
 853   
      */
 854   
     public StatusInfo deleteTerm(@WebParam(name = "termKey") String termKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 855   
 
 856   
     /**
 857   
      * Adds a Term to an AcademicCalendar.
 858   
      *
 859   
      * @param academicCalendarKey the key of an Academic Calendar
 860   
      * @param termKey the key of Term to be added
 861   
      * @param context Context information containing the principalId
 862   
      *                and locale information about the caller of service
 863   
      *                operation
 864   
      * @return the status
 865   
      * @throws AlreadyExistsException term already related to academic calendar
 866   
      * @throws DoesNotExistException the Term or Academic Calendar does not exist
 867   
      * @throws InvalidParameterException One or more parameters invalid
 868   
      * @throws MissingParameterException One or more parameters missing
 869   
      * @throws OperationFailedException unable to complete request
 870   
      * @throws PermissionDeniedException authorization failure
 871   
      */
 872   
     public StatusInfo addTermToAcademicCalendar(@WebParam(name = "academicCalendarKey") String academicCalendarKey, @WebParam(name = "termKey") String termKey, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 873   
 
 874   
     /**
 875   
      * Removes a Term from an AcademicCalendar.
 876   
      *
 877   
      * @param academicCalendarKey the key of an Academic Calendar
 878   
      * @param termKey the key of Term to be removed
 879   
      * @param context Context information containing the principalId
 880   
      *                and locale information about the caller of service
 881   
      *                operation
 882   
      * @return the status
 883   
      * @throws DoesNotExistException the Term not part of Academic Calendar
 884   
      * @throws InvalidParameterException One or more parameters invalid
 885   
      * @throws MissingParameterException One or more parameters missing
 886   
      * @throws OperationFailedException unable to complete request
 887   
      * @throws PermissionDeniedException authorization failure
 888   
      */
 889   
     public StatusInfo removeTermFromAcademicCalendar(@WebParam(name = "academicCalendarKey") String academicCalendarKey, @WebParam(name = "termKey") String termKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 890   
 
 891   
     /**
 892   
      * Adds a Term as an included term within another Term.
 893   
      *
 894   
      * @param termKey the key of a Term
 895   
      * @param includedTermKey the key of Term to be included
 896   
      * @param context Context information containing the principalId
 897   
      *                and locale information about the caller of service
 898   
      *                operation
 899   
      * @return the status
 900   
      * @throws AlreadyExistsException term relation already exists
 901   
      * @throws DoesNotExistException a Term does not exist
 902   
      * @throws InvalidParameterException One or more parameters invalid
 903   
      * @throws MissingParameterException One or more parameters missing
 904   
      * @throws OperationFailedException unable to complete request
 905   
      * @throws PermissionDeniedException authorization failure
 906   
      */
 907   
     public StatusInfo addTermToTerm(@WebParam(name = "termKey") String termKey, @WebParam(name = "includedTermKey") String includedTermKey, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 908   
 
 909   
     /**
 910   
      * Removes an included Term from a Term.
 911   
      *
 912   
      * @param termKey the key of a Term
 913   
      * @param includedTermKey the key of Term to be removed
 914   
      * @param context Context information containing the principalId
 915   
      *                and locale information about the caller of service
 916   
      *                operation
 917   
      * @return the status
 918   
      * @throws DoesNotExistException includedTerm is not included in the Term
 919   
      * @throws InvalidParameterException One or more parameters invalid
 920   
      * @throws MissingParameterException One or more parameters missing
 921   
      * @throws OperationFailedException unable to complete request
 922   
      * @throws PermissionDeniedException authorization failure
 923   
      */
 924   
     public StatusInfo removeTermFromTerm(@WebParam(name = "termKey") String termKey, @WebParam(name = "includedTermKey") String includedTermKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 925   
 
 926   
     /**
 927   
      * This method returns the TypeInfo for a given KeyDate type key.
 928   
      *
 929   
      * @param typeKey Key of the type
 930   
      * @param context Context information containing the principalId
 931   
      *        and locale information about the caller of service
 932   
      *        operation
 933   
      * @return Information about the Type
 934   
      * @throws DoesNotExistException  keyDateTypeKey not found
 935   
      * @throws InvalidParameterException invalid keyDateTypeKey
 936   
      * @throws MissingParameterException missing keyDateTypeKey
 937   
      * @throws OperationFailedException unable to complete request
 938   
      */
 939   
     public TypeInfo getKeyDateType(@WebParam(name = "keyDateTypeKey") String keyDateTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 940   
 
 941   
     /**
 942   
      * This method returns the valid key date types for the given
 943   
      * term type.
 944   
      *
 945   
      * @param context Context information containing the principalId
 946   
      *        and locale information about the caller of service
 947   
      *        operation
 948   
      * @param campusCalendatTypeKey
 949   
      * @return a list of valid key date Types
 950   
      * @throws DoesNotExistException termTypeKey not found
 951   
      * @throws InvalidParameterException invalid key or context
 952   
      * @throws MissingParameterException missing key or context
 953   
      * @throws OperationFailedException unable to complete request
 954   
      */
 955   
     public List<TypeInfo> getKeyDateTypesForTermType(@WebParam(name = "termTypeKey") String termTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 956   
 
 957   
     /**
 958   
      * Retrieves the details of a single key date by a key date key.
 959   
      *
 960   
      * @param keyDateKey Unique key of the key date to be retrieved
 961   
      * @param context Context information containing the principalId
 962   
      *                and locale information about the caller of service
 963   
      *                operation
 964   
      * @return the details of the key date requested
 965   
      * @throws DoesNotExistException keyDateKey not found
 966   
      * @throws InvalidParameterException invalid keyDateKey
 967   
      * @throws MissingParameterException missing keyDateKey
 968   
      * @throws OperationFailedException unable to complete request
 969   
      * @throws PermissionDeniedException authorization failure
 970   
      */
 971   
     public KeyDateInfo getKeyDate(@WebParam(name = "keyDateKey") String keyDateKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 972   
 
 973   
     /**
 974   
      * Retrieves a list of key dates corresponding to a list of
 975   
      * key date keys.
 976   
      *
 977   
      * @param keyDateKeyList list of unique keys of the
 978   
      *        key date to be retrieved
 979   
      * @param context Context information containing the principalId
 980   
      *                and locale information about the caller of service
 981   
      *                operation
 982   
      * @return a list of key dates
 983   
      * @throws DoesNotExistException an  keyDateKey in list not found
 984   
      * @throws InvalidParameterException invalid keyDateKey in list
 985   
      * @throws MissingParameterException missing keyDateKeyList
 986   
      * @throws OperationFailedException unable to complete request
 987   
      * @throws PermissionDeniedException authorization failure
 988   
      */
 989   
     public List<KeyDateInfo> getKeyDatesByKeyList(@WebParam(name = "keyDateKeyList") List<String> keyDateKeyList, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 990   
 
 991   
     /**
 992   
      * Retrieves a list of key dates by Type.
 993   
      *
 994   
      * @param keyDateTypeKey a Type of key date to be retrieved
 995   
      * @param context Context information containing the principalId
 996   
      *                and locale information about the caller of service
 997   
      *                operation
 998   
      * @return a list of key dates of the given Type
 999   
      * @throws InvalidParameterException invalid key dateTypeKey
 1000   
      * @throws MissingParameterException missing keyDateTypeKey
 1001   
      * @throws OperationFailedException unable to complete request
 1002   
      * @throws PermissionDeniedException authorization failure
 1003   
      */
 1004   
     public List<String> getKeyDateKeysByType(@WebParam(name = "keyDateTypeKey") String keyDateTypeKey, @WebParam(name = "context") ContextInfo context) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1005   
 
 1006   
     /**
 1007   
      * Retrieves a list of key dates for an academic calendar sorted
 1008   
      * by the date. The dates include all key dates mapped to any
 1009   
      * terms and sub terms.
 1010   
      *
 1011   
      * @param academicCalendarKey
 1012   
      * @param context Context information containing the principalId
 1013   
      *                and locale information about the caller of service
 1014   
      *                operation
 1015   
      * @return a list of key dates
 1016   
      * @throws DoesNotExistException an academicCalendarKey not found
 1017   
      * @throws InvalidParameterException invalid academicCalendarKey
 1018   
      * @throws MissingParameterException missing academicCalendarKey
 1019   
      * @throws OperationFailedException unable to complete request
 1020   
      * @throws PermissionDeniedException authorization failure
 1021   
      */
 1022   
     public List<KeyDateInfo> getKeyDatesForAcademicCalendar(@WebParam(name = "academicCalendarKey") String academicCalendarKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1023   
 
 1024   
     /**
 1025   
      * Retrieves a list of key dates for an academic calendar that
 1026   
      * fall within the given date range inclusive. The dates include
 1027   
      * all key dates mapped to any terms and sub terms and are sorted
 1028   
      * by date.
 1029   
      *
 1030   
      * @param academicCalendarKey
 1031   
      * @param startDate the start of the date range
 1032   
      * @param endDate the end of the date range
 1033   
      * @param context Context information containing the principalId
 1034   
      *                and locale information about the caller of service
 1035   
      *                operation
 1036   
      * @return a list of key dates
 1037   
      * @throws DoesNotExistException an academicCalendarKey not found
 1038   
      * @throws InvalidParameterException invalid academicCalendarKey
 1039   
      * @throws MissingParameterException missing parameter
 1040   
      * @throws OperationFailedException unable to complete request
 1041   
      * @throws PermissionDeniedException authorization failure
 1042   
      */
 1043   
     public List<KeyDateInfo> getKeyDatesForAcademicCalendarByDate(@WebParam(name = "academicCalendarKey") String academicCalendarKey, @WebParam(name = "startDate") Date startDate, @WebParam(name = "endDate") Date endDate, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1044   
 
 1045   
     /**
 1046   
      * Retrieves a list of key dates immediately mapped to a Term
 1047   
      * sorted by date.
 1048   
      *
 1049   
      * @param termKey
 1050   
      * @param context Context information containing the principalId
 1051   
      *                and locale information about the caller of service
 1052   
      *                operation
 1053   
      * @return a list of key dates
 1054   
      * @throws DoesNotExistException a termKey not found
 1055   
      * @throws InvalidParameterException invalid termKey
 1056   
      * @throws MissingParameterException missing termKey
 1057   
      * @throws OperationFailedException unable to complete request
 1058   
      * @throws PermissionDeniedException authorization failure
 1059   
      */
 1060   
     public List<KeyDateInfo> getKeyDatesForTerm(@WebParam(name = "termKey") String termKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1061   
 
 1062   
     /**
 1063   
      * Retrieves a list of key dates for a given Term that fall within
 1064   
      * the given date range inclusive sorted by date. The dates
 1065   
      * include only those dates immediate mapped to the Term.
 1066   
      *
 1067   
      * @param termKey unique key for a Term
 1068   
      * @param startDate start of date range
 1069   
      * @param endDate end of date range
 1070   
      * @param context Context information containing the principalId
 1071   
      *                and locale information about the caller of service
 1072   
      *                operation
 1073   
      * @return a list of key dates
 1074   
      * @throws DoesNotExistException a termKey not found
 1075   
      * @throws InvalidParameterException invalid termKey
 1076   
      * @throws MissingParameterException missing parameter
 1077   
      * @throws OperationFailedException unable to complete request
 1078   
      * @throws PermissionDeniedException authorization failure
 1079   
      */
 1080   
     public List<KeyDateInfo> getKeyDatesForTermByDate(@WebParam(name = "termKey") String termKey, @WebParam(name = "startDate") Date startDate, @WebParam(name = "endDate") Date endDate, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1081   
 
 1082   
     /**
 1083   
      * Retrieves a list of key dates for a Term sorted by date. The
 1084   
      * dates include all key dates mapped to any included terms.
 1085   
      *
 1086   
      * @param termKey unique key for a Term
 1087   
      * @param context Context information containing the principalId
 1088   
      *                and locale information about the caller of service
 1089   
      *                operation
 1090   
      * @return a list of key dates
 1091   
      * @throws DoesNotExistException a termKey not found
 1092   
      * @throws InvalidParameterException invalid termKey
 1093   
      * @throws MissingParameterException missing termKey
 1094   
      * @throws OperationFailedException unable to complete request
 1095   
      * @throws PermissionDeniedException authorization failure
 1096   
      */
 1097   
     public List<KeyDateInfo> getAllKeyDatesForTerm(@WebParam(name = "termKey") String termKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1098   
 
 1099   
     /**
 1100   
      * Retrieves a list of key dates for a given Term that fall within
 1101   
      * the given date range inclusive. The dates include all key dates
 1102   
      * mapped to any included terms and are sorted by date.
 1103   
      *
 1104   
      * @param termKey unique key for a Term
 1105   
      * @param startDate start of date range
 1106   
      * @param endDate end of date range
 1107   
      * @param context Context information containing the principalId
 1108   
      *                and locale information about the caller of service
 1109   
      *                operation
 1110   
      * @return a list of key dates
 1111   
      * @throws DoesNotExistException a termKey not found
 1112   
      * @throws InvalidParameterException invalid termKey
 1113   
      * @throws MissingParameterException missing parameter
 1114   
      * @throws OperationFailedException unable to complete request
 1115   
      * @throws PermissionDeniedException authorization failure
 1116   
      */
 1117   
     public List<KeyDateInfo> getKeyDatesForAllTermsByDate(@WebParam(name = "termKey") String termKey, @WebParam(name = "startDate") Date startDate, @WebParam(name = "endDate") Date endDate, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1118   
 
 1119   
     /**
 1120   
      * Validates a key date. Depending on the value of validationType,
 1121   
      * this validation could be limited to tests on just the current
 1122   
      * object and its directly contained subobjects or expanded to
 1123   
      * perform all tests related to this object. If an identifier is
 1124   
      * present for the key date and a record is found for that identifier,
 1125   
      * the validation checks if the key date can be shifted to the new
 1126   
      * values. If a record cannot be found for the identifier, it is
 1127   
      * assumed that the record does not exist and as such, the checks
 1128   
      * performed will be much shallower, typically mimicking those
 1129   
      * performed by setting the validationType to the current
 1130   
      * object. This is a slightly different pattern from the standard
 1131   
      * validation as the caller provides the identifier in the create
 1132   
      * statement instead of the server assigning an identifier.
 1133   
      *
 1134   
      * @param validationType Identifier of the extent of validation
 1135   
      * @param keyDateInfo the key date information to be tested.
 1136   
      * @param context Context information containing the principalId
 1137   
      *                and locale information about the caller of service
 1138   
      *                operation
 1139   
      * @return the results from performing the validation
 1140   
      * @throws DoesNotExistException validationTypeKey not found
 1141   
      * @throws InvalidParameterException invalid validationTypeKey, keyDateInfo
 1142   
      * @throws MissingParameterException missing validationTypeKey, keyDateInfo
 1143   
      * @throws OperationFailedException unable to complete request
 1144   
      */
 1145   
     public List<ValidationResultInfo> validateKeyDate(@WebParam(name = "validationType") String validationType, @WebParam(name = "keyDateInfo") KeyDateInfo keyDateInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 1146   
 
 1147   
     /**
 1148   
      * Creates a new Key Date for a Term.
 1149   
      *
 1150   
      * @param termKey a key for a Term to which this date is mapped
 1151   
      * @param keyDateKey the key of the Key Date to be created
 1152   
      * @param keyDateInfo Details of the Key Date to be created
 1153   
      * @param context Context information containing the principalId
 1154   
      *                and locale information about the caller of service
 1155   
      *                operation
 1156   
      * @return the details of the Key Date just created
 1157   
      * @throws AlreadyExistsException the Key Date being created already exists
 1158   
      * @throws DataValidationErrorException One or more values invalid for this operation
 1159   
      * @throws InvalidParameterException One or more parameters invalid
 1160   
      * @throws MissingParameterException One or more parameters missing
 1161   
      * @throws OperationFailedException unable to complete request
 1162   
      * @throws PermissionDeniedException authorization failure
 1163   
      */
 1164   
     public KeyDateInfo createKeyDateForTerm(@WebParam(name = "termKey") String termKey, @WebParam(name = "keyDateKey") String keyDateKey, @WebParam(name = "keyDateInfo") KeyDateInfo keyDateInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1165   
 
 1166   
     /**
 1167   
      * Updates an existing Key Date.
 1168   
      *
 1169   
      * @param keyDateKey Key of Key Date to be updated
 1170   
      * @param keyDateInfo Details of updates to the key date
 1171   
      *        being updated
 1172   
      * @param context Context information containing the principalId
 1173   
      *                and locale information about the caller of service
 1174   
      *                operation
 1175   
      * @return the details of key date just updated
 1176   
      * @throws DataValidationErrorException One or more values invalid for this
 1177   
      *         operation
 1178   
      * @throws DoesNotExistException the key date does not exist
 1179   
      * @throws InvalidParameterException One or more parameters invalid
 1180   
      * @throws MissingParameterException One or more parameters missing
 1181   
      * @throws OperationFailedException unable to complete request
 1182   
      * @throws PermissionDeniedException authorization failure
 1183   
      * @throws VersionMismatchException The action was attempted on an out of date
 1184   
      *         version.
 1185   
      */
 1186   
     public KeyDateInfo updateKeyDate(@WebParam(name = "keyDateKey") String keyDateKey, @WebParam(name = "keyDateInfo") KeyDateInfo keyDateInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException;
 1187   
 
 1188   
     /**
 1189   
      * Deletes an existing KeyDate.
 1190   
      *
 1191   
      * @param keyDateKey the key of the Key Date to
 1192   
      *        be deleted
 1193   
      * @param context Context information containing the principalId
 1194   
      *                and locale information about the caller of service
 1195   
      *                operation
 1196   
      * @return status of the operation (success, failed)
 1197   
      * @throws DoesNotExistException the KeyDate does not exist
 1198   
      * @throws InvalidParameterException One or more parameters invalid
 1199   
      * @throws MissingParameterException One or more parameters missing
 1200   
      * @throws OperationFailedException unable to complete request
 1201   
      * @throws PermissionDeniedException authorization failure
 1202   
      */
 1203   
     public StatusInfo deleteKeyDate(@WebParam(name = "keyDateKey") String keyDateKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1204   
 
 1205   
     /**
 1206   
      * This method returns the TypeInfo for a given holiday type key.
 1207   
      *
 1208   
      * @param holidayTypeKey Key of the type
 1209   
      * @param context Context information containing the principalId
 1210   
      *        and locale information about the caller of service
 1211   
      *        operation
 1212   
      * @return Information about the Type
 1213   
      * @throws DoesNotExistException holidayTypeKey not found
 1214   
      * @throws InvalidParameterException invalid holidayTypeKey
 1215   
      * @throws MissingParameterException missing holidayTypeKey
 1216   
      * @throws OperationFailedException unable to complete request
 1217   
      */
 1218   
     public TypeInfo getHolidayType(@WebParam(name = "holidayTypeKey") String holidayTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 1219   
 
 1220   
     /**
 1221   
      * This method returns the valid holiday types for the given
 1222   
      * campus calendar type.
 1223   
      *
 1224   
      * @param context Context information containing the principalId
 1225   
      *        and locale information about the caller of service
 1226   
      *        operation
 1227   
      * @param campusCalendatTypeKey
 1228   
      * @return a list of valid holiday Types
 1229   
      * @throws DoesNotExistException campusCalendarTypeKey not found
 1230   
      * @throws InvalidParameterException invalid key or context
 1231   
      * @throws MissingParameterException missing key or context
 1232   
      * @throws OperationFailedException unable to complete request
 1233   
      */
 1234   
     public List<TypeInfo> getHolidayTypesForCampusCalendarType(@WebParam(name = "campusCalendarTypeKey") String campusCalendarTypeKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 1235   
 
 1236   
     /**
 1237   
      * Retrieves a list of holidays for an academic calendar sorted by
 1238   
      * date.
 1239   
      *
 1240   
      * @param academicCalendarKey
 1241   
      * @param context Context information containing the principalId
 1242   
      *                and locale information about the caller of service
 1243   
      *                operation
 1244   
      * @return a list of holidays
 1245   
      * @throws DoesNotExistException an academicCalendarKey not found
 1246   
      * @throws InvalidParameterException invalid academicCalendarKey
 1247   
      * @throws MissingParameterException missing academicCalendarKey
 1248   
      * @throws OperationFailedException unable to complete request
 1249   
      * @throws PermissionDeniedException authorization failure
 1250   
      */
 1251   
     public List<HolidayInfo> getHolidaysForAcademicCalendar(@WebParam(name = "academicCalendarKey") String academicCalendarKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1252   
 
 1253   
     /**
 1254   
      * Validates a holiday. Depending on the value of validationType,
 1255   
      * this validation could be limited to tests on just the current
 1256   
      * object and its directly contained subobjects or expanded to
 1257   
      * perform all tests related to this object. If an identifier is
 1258   
      * present for the holiday and a record is found for that identifier,
 1259   
      * the validation checks if the holiday can be shifted to the new
 1260   
      * values. If a record cannot be found for the identifier, it is
 1261   
      * assumed that the record does not exist and as such, the checks
 1262   
      * performed will be much shallower, typically mimicking those
 1263   
      * performed by setting the validationType to the current
 1264   
      * object. This is a slightly different pattern from the standard
 1265   
      * validation as the caller provides the identifier in the create
 1266   
      * statement instead of the server assigning an identifier.
 1267   
      *
 1268   
      * @param validationType Identifier of the extent of validation
 1269   
      * @param holidayInfo the holiday information to be tested.
 1270   
      * @param context Context information containing the principalId
 1271   
      *                and locale information about the caller of service
 1272   
      *                operation
 1273   
      * @return the results from performing the validation
 1274   
      * @throws DoesNotExistException validationTypeKey not found
 1275   
      * @throws InvalidParameterException invalid validationTypeKey, holidayInfo
 1276   
      * @throws MissingParameterException missing validationTypeKey, holidayInfo
 1277   
      * @throws OperationFailedException unable to complete request
 1278   
      */
 1279   
     public List<ValidationResultInfo> validateHoliday(@WebParam(name = "validationType") String validationType, @WebParam(name = "holidayInfo") HolidayInfo holidayInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 1280   
 
 1281   
     /**
 1282   
      * Creates a new Holiday for a Campus Calendar.
 1283   
      *
 1284   
      * @param campusCalendarKey a key for a Term to which this holiday is mapped
 1285   
      * @param holidayKey the key of the Holiday to be created
 1286   
      * @param holidayInfo Details of the Holiday to be created
 1287   
      * @param context Context information containing the principalId
 1288   
      *                and locale information about the caller of service
 1289   
      *                operation
 1290   
      * @return the details of the Holiday just created
 1291   
      * @throws AlreadyExistsException the Holiday being created already exists
 1292   
      * @throws DataValidationErrorException One or more values invalid for this operation
 1293   
      * @throws InvalidParameterException One or more parameters invalid
 1294   
      * @throws MissingParameterException One or more parameters missing
 1295   
      * @throws OperationFailedException unable to complete request
 1296   
      * @throws PermissionDeniedException authorization failure
 1297   
      */
 1298   
     public HolidayInfo createHolidayForCampusCalendar(@WebParam(name = "campusCalendarKey") String campusCalendarKey, @WebParam(name = "holidayKey") String holidayKey, @WebParam(name = "holidayInfo") HolidayInfo holidayInfo, @WebParam(name = "context") ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1299   
 
 1300   
     /**
 1301   
      * Updates an existing Holiday.
 1302   
      *
 1303   
      * @param holidayKey Key of Holiday to be updated
 1304   
      * @param holidayInfo Details of updates to the holiday
 1305   
      *        being updated
 1306   
      * @param context Context information containing the principalId
 1307   
      *                and locale information about the caller of service
 1308   
      *                operation
 1309   
      * @return the details of holiday just updated
 1310   
      * @throws DataValidationErrorException One or more values invalid for this
 1311   
      *         operation
 1312   
      * @throws DoesNotExistException the holiday does not exist
 1313   
      * @throws InvalidParameterException One or more parameters invalid
 1314   
      * @throws MissingParameterException One or more parameters missing
 1315   
      * @throws OperationFailedException unable to complete request
 1316   
      * @throws PermissionDeniedException authorization failure
 1317   
      * @throws VersionMismatchException The action was attempted on an out of date
 1318   
      *         version.
 1319   
      */
 1320   
     public HolidayInfo updateHoliday(@WebParam(name = "holidayKey") String holidayKey, @WebParam(name = "holidayInfo") HolidayInfo holidayInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException;
 1321   
 
 1322   
     /**
 1323   
      * Deletes an existing Holiday.
 1324   
      *
 1325   
      * @param holidayKey the key of the Holiday to
 1326   
      *        be deleted
 1327   
      * @param context Context information containing the principalId
 1328   
      *                and locale information about the caller of service
 1329   
      *                operation
 1330   
      * @return status of the operation (success, failed)
 1331   
      * @throws DoesNotExistException the Holiday does not exist
 1332   
      * @throws InvalidParameterException One or more parameters invalid
 1333   
      * @throws MissingParameterException One or more parameters missing
 1334   
      * @throws OperationFailedException unable to complete request
 1335   
      * @throws PermissionDeniedException authorization failure
 1336   
      */
 1337   
     public StatusInfo deleteHoliday(@WebParam(name = "holidayKey") String holidayKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1338   
 
 1339   
     /**
 1340   
      * Gets the registration key date group for a term.
 1341   
      *
 1342   
      * @param termKey unique key of a term
 1343   
      * @param context Context information containing the principalId
 1344   
      *                and locale information about the caller of service
 1345   
      *                operation
 1346   
      * @return the registration date group
 1347   
      * @throws DoesNotExistException termKey not found
 1348   
      * @throws InvalidParameterException invalid termKey
 1349   
      * @throws MissingParameterException missing termKey
 1350   
      * @throws OperationFailedException unable to complete request
 1351   
      * @throws PermissionDeniedException authorization failure
 1352   
      */
 1353   
     public RegistrationDateGroupInfo getRegistrationDateGroup(@WebParam(name = "termKey") String termKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1354   
 
 1355   
     /**
 1356   
      * Validates an registration date grpup. Depending on the value of
 1357   
      * validationType, this validation could be limited to tests on
 1358   
      * just the current object and its directly contained subobjects
 1359   
      * or expanded to perform all tests related to this object. If an
 1360   
      * identifier is present for the registration date group and a
 1361   
      * record is found for that identifier, the validation checks if
 1362   
      * the registration date group can be shifted to the new values. If
 1363   
      * a record cannot be found for the identifier, it is assumed that
 1364   
      * the record does not exist and as such, the checks performed
 1365   
      * will be much shallower, typically mimicking those performed by
 1366   
      * setting the validationType to the current object. This is a
 1367   
      * slightly different pattern from the standard validation as the
 1368   
      * caller provides the identifier in the create statement instead
 1369   
      * of the server assigning an identifier.
 1370   
      *
 1371   
      * @param validationType Identifier of the extent of validation
 1372   
      * @param registrationDateGroupInfo the registration date group to be tested.
 1373   
      * @param context Context information containing the principalId
 1374   
      *                and locale information about the caller of service
 1375   
      *                operation
 1376   
      * @return the results from performing the validation
 1377   
      * @throws DoesNotExistException validationTypeKey not found
 1378   
      * @throws InvalidParameterException invalid validationTypeKey, academicCalendarInfo
 1379   
      * @throws MissingParameterException missing validationTypeKey, academicCalendarInfo
 1380   
      * @throws OperationFailedException unable to complete request
 1381   
      */
 1382   
     public List<ValidationResultInfo> validateRegistrationDateGroup(@WebParam(name = "validationType") String validationType, @WebParam(name = "registrationDateGroupInfo") RegistrationDateGroupInfo registrationDateGroupInfo, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 1383   
 
 1384   
     /**
 1385   
      * Updates a the registration key date group for a term. The
 1386   
      * date group is a set of hardened well-known dates.
 1387   
      *
 1388   
      * Updating an registration date group is a short cut to creating or
 1389   
      * updating the corresponding key dates and relating them to the
 1390   
      * given term. An RegistrationDateGroupInfo is available for all
 1391   
      * Terms by default and does not explicitly need to be created.
 1392   
      *
 1393   
      * If the KeyDates have not been created for the dates in
 1394   
      * the group, an RegistrationDateGroup is still returned from
 1395   
      * getRegistrationDateGroup() but with empty or default dates.
 1396   
      *
 1397   
      * Setting date values in an RegistrationDateGroup through this
 1398   
      * update method either creates the KeyDates with the appropriate
 1399   
      * Types that map to the fields in the date group for the given
 1400   
      * Term or updates them if they already exist.
 1401   
      *
 1402   
      * @param termKey key of Term
 1403   
      * @param registrationDateGroup the registration date group
 1404   
      * @param context Context information containing the principalId
 1405   
      *                and locale information about the caller of service
 1406   
      *                operation
 1407   
      * @return the details of enrollmemnt date group just updated
 1408   
      * @throws DataValidationErrorException One or more values invalid for this
 1409   
      *         operation
 1410   
      * @throws DoesNotExistException the term does not exist
 1411   
      * @throws InvalidParameterException One or more parameters invalid
 1412   
      * @throws MissingParameterException One or more parameters missing
 1413   
      * @throws OperationFailedException unable to complete request
 1414   
      * @throws PermissionDeniedException authorization failure
 1415   
      * @throws VersionMismatchException The action was attempted on an out of date
 1416   
      *         version.
 1417   
      */
 1418   
     public RegistrationDateGroupInfo updateRegistrationDateGroup(@WebParam(name = "termKey") String termKey, @WebParam(name = "registrationDateGroupInfo") RegistrationDateGroupInfo registrationDateGroupInfo, @WebParam(name = "context") ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException;
 1419   
 
 1420   
     /**
 1421   
      * Calculates the number of instructional days for a Term. The
 1422   
      * number of instructional days is the number of class days in a
 1423   
      * Term minus the non-instructional holidays on the related campus
 1424   
      * calendar.
 1425   
      *
 1426   
      * @param termKey unique key of a term
 1427   
      * @param context Context information containing the principalId
 1428   
      *                and locale information about the caller of service
 1429   
      *                operation
 1430   
      * @return the number of instructional days
 1431   
      * @throws DoesNotExistException termKey not found
 1432   
      * @throws InvalidParameterException invalid termKey
 1433   
      * @throws MissingParameterException missing termKey
 1434   
      * @throws OperationFailedException unable to complete request
 1435   
      * @throws PermissionDeniedException authorization failure
 1436   
      */
 1437   
     public Integer getInstructionalDaysForTerm(@WebParam(name = "termKey") String termKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 1438   
 }
Report generated by Cobertura 1.9.4.1 on 5/11/11 1:50 PM.