AcademicCalendarServiceImpl (Kuali Student 2.0.0-CM20 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.kuali.student.enrollment.class2.acal.service.impl
Class AcademicCalendarServiceImpl

java.lang.Object
  org.kuali.student.enrollment.class2.acal.service.impl.AcademicCalendarServiceImpl

All Implemented Interfaces:: AcademicCalendarService

@Transactional(readOnly=true, noRollbackFor=DoesNotExistException.class, rollbackFor=java.lang.Throwable.class) public class AcademicCalendarServiceImpl
extends Object
implements AcademicCalendarService
extends Object
implements AcademicCalendarService

Constructor Summary
`AcademicCalendarServiceImpl()`

Method Summary
`StatusInfo`	`addTermToAcademicCalendar(String academicCalendarId, String termId, ContextInfo context)` Adds a Term to an AcademicCalendar.
`StatusInfo`	`addTermToTerm(String termId, String includedTermId, ContextInfo context)` Adds a Term as an included term within another Term.
`AcalEventInfo`	`calculateAcalEvent(String acalEventId, ContextInfo contextInfo)` Calculates the dates in the AcalEvent based on a rule attached to the AcalEvent Type.
`HolidayInfo`	`calculateHoliday(String holidayId, ContextInfo contextInfo)` Calculates the dates in the Holiday based on a rule attached to the Holiday Type.
`KeyDateInfo`	`calculateKeyDate(String keyDateId, ContextInfo contextInfo)` Calculates the dates in the KeyDate based on a rule attached to the KeyDate Type.
`AcademicCalendarInfo`	`copyAcademicCalendar(String academicCalendarId, Date startDate, Date endDate, ContextInfo contextInfo)` Copy an AcademicCalendar.
`HolidayCalendarInfo`	`copyHolidayCalendar(String holidayCalendarId, Date startDate, Date endDate, ContextInfo contextInfo)` Copy an HolidayCalendar.
`AcademicCalendarInfo`	`createAcademicCalendar(String academicCalendarTypeKey, AcademicCalendarInfo academicCalendarInfo, ContextInfo context)` Creates a new AcademicCalendar.
`AcalEventInfo`	`createAcalEvent(String academicCalendarId, String acalEventTypeKey, AcalEventInfo acalEventInfo, ContextInfo contextInfo)` Creates a new AcalEvent.
`HolidayInfo`	`createHoliday(String holidayCalendarId, String holidayTypeKey, HolidayInfo holidayInfo, ContextInfo contextInfo)` Creates a new Holiday.
`HolidayCalendarInfo`	`createHolidayCalendar(String holidayCalendarTypeKey, HolidayCalendarInfo holidayCalendarInfo, ContextInfo context)` Creates a new HolidayCalendar.
`KeyDateInfo`	`createKeyDate(String termId, String keyDateTypeKey, KeyDateInfo keyDateInfo, ContextInfo contextInfo)` Creates a new KeyDate.
`TermInfo`	`createTerm(String termTypeKey, TermInfo termInfo, ContextInfo context)` Creates a new Term.
`StatusInfo`	`deleteAcademicCalendar(String academicCalendarKey, ContextInfo context)` Deletes an existing AcademicCalendar.
`StatusInfo`	`deleteAcalEvent(String acalEventId, ContextInfo contextInfo)` Deletes an existing AcalEvent.
`StatusInfo`	`deleteHoliday(String holidayId, ContextInfo context)` Deletes an existing Holiday.
`StatusInfo`	`deleteHolidayCalendar(String holidayCalendarId, ContextInfo context)` Deletes an existing HolidayCalendar.
`StatusInfo`	`deleteKeyDate(String keyDateId, ContextInfo context)` Deletes an existing KeyDate.
`StatusInfo`	`deleteTerm(String termId, ContextInfo context)` Deletes an existing Term.
`AcademicCalendarInfo`	`getAcademicCalendar(String academicCalendarKey, ContextInfo context)` Retrieves a single AcademicCalendar by an AcademicCalendar Id.
`String`	`getAcademicCalendarData(String academicCalendarId, String calendarDataFormatTypeKey, ContextInfo contextInfo)` Generates calendaring data for the Terms and key dates in an Academic Calendar.
`List<String>`	`getAcademicCalendarIdsByType(String academicCalendarTypeKey, ContextInfo context)` Retrieves a list of AcademicCalendar Ids by Type.
`List<AcademicCalendarInfo>`	`getAcademicCalendarsByIds(List<String> academicCalendarKeyList, ContextInfo context)` Retrieves a list AcademicCalendars from a list of AcademicCalendar Ids.
`List<AcademicCalendarInfo>`	`getAcademicCalendarsByStartYear(Integer year, ContextInfo context)` Retrieves a list of AcademicCalendars that start in the given year.
`List<AcademicCalendarInfo>`	`getAcademicCalendarsForTerm(String termId, ContextInfo contextInfo)` Gets the list of academic calendars that use this term.
`StateInfo`	`getAcademicCalendarState(String academicCalendarStateKey, ContextInfo context)` Gets an AcademicCalendar State by key.
`List<StateInfo>`	`getAcademicCalendarStates(ContextInfo context)` Gets the valid AcademicCalendar States.
`TypeInfo`	`getAcademicCalendarType(String academicCalendarTypeKey, ContextInfo context)` Retrieves an AcademicCalendar Type by Type key.
`List<TypeInfo>`	`getAcademicCalendarTypes(ContextInfo context)` Gets the valid AcademicCalendar types.
`AcademicCalendarAssembler`	`getAcalAssembler()`
`AcalEventInfo`	`getAcalEvent(String acalEventId, ContextInfo contextInfo)` Retrieves a single AcalEvent by an AcalEvent Id.
`AcalEventAssembler`	`getAcalEventAssembler()`
`List<String>`	`getAcalEventIdsByType(String acalEventTypeKey, ContextInfo contextInfo)` Retrieves a list of AcalEvent Ids by Type.
`List<AcalEventInfo>`	`getAcalEventsByIds(List<String> acalEventIds, ContextInfo contextInfo)` Retrieves a list AcalEvents from a list of AcalEvent Ids.
`List<AcalEventInfo>`	`getAcalEventsForAcademicCalendar(String academicCalendarId, ContextInfo contextInfo)` Retrieves a list of AcalEvents immediately mapped to an AcademicCalendar ordered by date.
`List<AcalEventInfo>`	`getAcalEventsForAcademicCalendarByDate(String academicCalendarId, Date startDate, Date endDate, ContextInfo contextInfo)` Retrieves a list of AcalEvents immediately mapped to an AcademicCalendar that fall within the given date range inclusive ordered by date.
`StateInfo`	`getAcalEventState(String acalEventStateKey, ContextInfo contextInfo)` Gets a AcalEvent State by key.
`List<StateInfo>`	`getAcalEventStates(ContextInfo contextInfo)` Gets the valid AcalEvent States.
`TypeInfo`	`getAcalEventType(String acalEventTypeKey, ContextInfo contextInfo)` Rerieves a AcalEvent Type by Type key.
`List<TypeInfo>`	`getAcalEventTypes(ContextInfo contextInfo)` Gets the valid AcalEvent types.
`List<TypeInfo>`	`getAcalEventTypesForAcademicCalendarType(String academicCalendarTypeKey, ContextInfo contextInfo)` This method returns the valid AcalEvent Types for the given AcademicCalendar Type.
`AtpService`	`getAtpService()`
`List<TermInfo>`	`getContainingTerms(String termId, ContextInfo context)` Gets the containing terms of a given term.
`List<TermInfo>`	`getCurrentTerms(String processKey, ContextInfo context)` Convenience method added for core-slice development to get a current term.
`DataDictionaryService`	`getDataDictionaryService()`
`HolidayInfo`	`getHoliday(String holidayId, ContextInfo contextInfo)` Retrieves a single Holiday by a Holiday Id.
`HolidayAssembler`	`getHolidayAssembler()`
`HolidayCalendarInfo`	`getHolidayCalendar(String holidayCalendarId, ContextInfo contextInfo)` Retrieves a single HolidayCalendar by a HolidayCalendar Id.
`HolidayCalendarAssembler`	`getHolidayCalendarAssembler()`
`List<String>`	`getHolidayCalendarIdsByType(String holidayCalendarTypeKey, ContextInfo contextInfo)` Retrieves a list of HolidayCalendar Ids by Type.
`List<HolidayCalendarInfo>`	`getHolidayCalendarsByIds(List<String> holidayCalendarIds, ContextInfo context)` Retrieves a list HolidayCalendars from a list of HolidayCalendar Ids.
`List<HolidayCalendarInfo>`	`getHolidayCalendarsByStartYear(Integer year, ContextInfo contextInfo)` Retrieves a list of HolidayCalendars that start in the given year.
`StateInfo`	`getHolidayCalendarState(String holidayCalendarStateKey, ContextInfo contextInfo)` Gets a HolidayCalendar State by key.
`List<StateInfo>`	`getHolidayCalendarStates(ContextInfo contextInfo)` Gets the valid HolidayCalendar States.
`TypeInfo`	`getHolidayCalendarType(String holidayCalendarTypeKey, ContextInfo contextInfo)` Rerieves a HolidayCalendar Type by Type key.
`List<TypeInfo>`	`getHolidayCalendarTypes(ContextInfo contextInfo)` Gets the valid HolidayCalendar types.
`List<String>`	`getHolidayIdsByType(String holidayTypeKey, ContextInfo contextInfo)` Retrieves a list of Holiday Ids by Type.
`List<HolidayInfo>`	`getHolidaysByDateForAcademicCalendar(String academicCalendarId, Date startDate, Date endDate, ContextInfo contextInfo)` Gets a list of holidays for a particular Academic Calendar further qualified by the dates.
`List<HolidayInfo>`	`getHolidaysByIds(List<String> holidayIds, ContextInfo contextInfo)` Retrieves a list Holidays from a list of Holiday Ids.
`List<HolidayInfo>`	`getHolidaysForHolidayCalendar(String holidayCalendarId, ContextInfo contextInfo)` Retrieves a list of Holidays immediately mapped to a HolidayCalendar ordered by date.
`List<HolidayInfo>`	`getHolidaysForHolidayCalendarByDate(String holidayCalendarId, Date startDate, Date endDate, ContextInfo contextInfo)` Retrieves a list of Holidays immediately mapped to a HolidayCalendar that fall within the given date range inclusive ordered by date.
`StateInfo`	`getHolidayState(String holidayStateKey, ContextInfo contextInfo)` Gets a Holiday State by key.
`List<StateInfo>`	`getHolidayStates(ContextInfo contextInfo)` Gets the valid Holiday States.
`TypeInfo`	`getHolidayType(String holidayTypeKey, ContextInfo context)` Rerieves a Holiday Type by Type key.
`List<TypeInfo>`	`getHolidayTypes(ContextInfo contextInfo)` Gets the valid Holiday types.
`List<TypeInfo>`	`getHolidayTypesForHolidayCalendarType(String holidayCalendarTypeKey, ContextInfo contextInfo)` This method returns the valid Holiday Types for the given HolidayCalendar Type.
`List<AcalEventInfo>`	`getImpactedAcalEvents(String acalEventId, ContextInfo contextInfo)` Gets a list of AcalEvents impacted by a change to a given AcalEvent.
`List<HolidayInfo>`	`getImpactedHolidays(String holidayId, ContextInfo contextInfo)` Gets a list of Holidays impacted by a change to a given Holiday.
`List<KeyDateInfo>`	`getImpactedKeyDates(String keyDateId, ContextInfo contextInfo)` Gets a list of KeyDates impacted by a change to a given KeyDate.
`List<TermInfo>`	`getIncludedTermsInTerm(String termId, ContextInfo context)` Retrieves a list Terms included immediately inside the given Term ordered by Term start date.
`Integer`	`getInstructionalDaysForTerm(String termId, ContextInfo contextInfo)` Calculates the number of instructional days for a Term.
`KeyDateInfo`	`getKeyDate(String keyDateId, ContextInfo context)` Retrieves a single KeyDate by a KeyDate Id.
`KeyDateAssembler`	`getKeyDateAssembler()`
`List<String>`	`getKeyDateIdsByType(String keyDateTypeKey, ContextInfo contextInfo)` Retrieves a list of KeyDate Ids by Type.
`List<String>`	`getKeyDateIdsByTypeForTerm(String keyDateTypeKey, String termId, ContextInfo contextInfo)` Retrieves a list of KeyDate Ids by Type and for a specific Term
`List<KeyDateInfo>`	`getKeyDatesByIds(List<String> keyDateIds, ContextInfo context)` Retrieves a list KeyDates from a list of KeyDate Ids.
`List<KeyDateInfo>`	`getKeyDatesForTerm(String termId, ContextInfo context)` Retrieves a list of KeyDates immediately mapped to a Term ordered by date.
`List<KeyDateInfo>`	`getKeyDatesForTermByDate(String termId, Date startDate, Date endDate, ContextInfo context)` Retrieves a list of KeyDates immediately mapped to a Term that fall within the given date range inclusive ordered by date.
`StateInfo`	`getKeyDateState(String keyDateStateKey, ContextInfo contextInfo)` Gets a KeyDate State by key.
`List<StateInfo>`	`getKeyDateStates(ContextInfo contextInfo)` Gets the valid KeyDate States.
`TypeInfo`	`getKeyDateType(String keyDateTypeKey, ContextInfo context)` Rerieves a KeyDate Type by Type key.
`List<TypeInfo>`	`getKeyDateTypes(ContextInfo contextInfo)` Gets the valid KeyDate types.
`List<TypeInfo>`	`getKeyDateTypesForTermType(String termTypeKey, ContextInfo context)` This method returns the valid KeyDate Types for the given Term Type.
`StateService`	`getStateService()`
`TermInfo`	`getTerm(String termId, ContextInfo context)` Retrieves a single Term by a Term Id.
`TermAssembler`	`getTermAssembler()`
`List<String>`	`getTermIdsByType(String termTypeKey, ContextInfo contextInfo)` Retrieves a list of Term Ids by Type.
`List<TermInfo>`	`getTermsByCode(String code, ContextInfo contextInfo)` Gets a list of Terms by Code.
`List<TermInfo>`	`getTermsByIds(List<String> termIds, ContextInfo context)` Retrieves a list Terms from a list of Term Ids.
`List<TermInfo>`	`getTermsForAcademicCalendar(String academicCalendarId, ContextInfo context)` Retrieves a list of the top level Terms mapped to the given AcademicCalendar ordered by Term start date.
`StateInfo`	`getTermState(String termStateKey, ContextInfo context)` Gets a Term State by key.
`List<StateInfo>`	`getTermStates(ContextInfo context)` Gets the valid Term States.
`TypeInfo`	`getTermType(String termTypeKey, ContextInfo context)` Retrieves a Term Type by Type key.
`List<TypeInfo>`	`getTermTypes(ContextInfo context)` Gets the valid Term types.
`List<TypeInfo>`	`getTermTypesForAcademicCalendarType(String academicCalendarTypeKey, ContextInfo context)` This method returns the valid Term types for an AcademicCalendar Type.
`List<TypeInfo>`	`getTermTypesForTermType(String termTypeKey, ContextInfo context)` This method returns the valid Term types for a Term Type.
`TypeService`	`getTypeService()`
`StatusInfo`	`removeTermFromAcademicCalendar(String academicCalendarKey, String termId, ContextInfo context)` Removes a Term from an AcademicCalendar.
`StatusInfo`	`removeTermFromTerm(String termId, String includedTermId, ContextInfo context)` Removes an included Term from a Term.
`List<String>`	`searchForAcademicCalendarIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for AcademicCalendars that meet the given search criteria.
`List<AcademicCalendarInfo>`	`searchForAcademicCalendars(QueryByCriteria criteria, ContextInfo context)` Searches for AcademicCalendars that meet the given search criteria.
`List<String>`	`searchForAcalEventIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for AcalEvents that meet the given search criteria.
`List<AcalEventInfo>`	`searchForAcalEvents(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for AcalEvents that meet the given search criteria.
`List<String>`	`searchForHolidayCalendarIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for HolidayCalendars that meet the given search criteria.
`List<HolidayCalendarInfo>`	`searchForHolidayCalendars(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for HolidayCalendars that meet the given search criteria.
`List<String>`	`searchForHolidayIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for Holidays that meet the given search criteria.
`List<HolidayInfo>`	`searchForHolidays(QueryByCriteria criteria, ContextInfo context)` Searches for Holidays that meet the given search criteria.
`List<String>`	`searchForKeyDateIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for KeyDates that meet the given search criteria.
`List<KeyDateInfo>`	`searchForKeyDates(QueryByCriteria criteria, ContextInfo context)` Searches for KeyDates that meet the given search criteria.
`List<String>`	`searchForTermIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for Terms that meet the given search criteria.
`List<TermInfo>`	`searchForTerms(QueryByCriteria criteria, ContextInfo context)` Searches for Terms that meet the given search criteria.
`void`	`setAcalAssembler(AcademicCalendarAssembler acalAssembler)`
`void`	`setAcalEventAssembler(AcalEventAssembler acalEventAssembler)`
`void`	`setAtpService(AtpService atpService)`
`void`	`setDataDictionaryService(DataDictionaryService dataDictionaryService)`
`void`	`setHolidayAssembler(HolidayAssembler holidayAssembler)`
`void`	`setHolidayCalendarAssembler(HolidayCalendarAssembler holidayCalendarAssembler)`
`void`	`setKeyDateAssembler(KeyDateAssembler keyDateAssembler)`
`void`	`setStateService(StateService stateService)`
`void`	`setTermAssembler(TermAssembler termAssembler)`
`void`	`setTypeService(TypeService typeService)`
`AcademicCalendarInfo`	`updateAcademicCalendar(String academicCalendarId, AcademicCalendarInfo academicCalendarInfo, ContextInfo context)` Updates an existing AcademicCalendar.
`AcalEventInfo`	`updateAcalEvent(String acalEventId, AcalEventInfo acalEventInfo, ContextInfo contextInfo)` Updates an existing AcalEvent.
`HolidayInfo`	`updateHoliday(String holidayId, HolidayInfo holidayInfo, ContextInfo context)` Updates an existing Holiday.
`HolidayCalendarInfo`	`updateHolidayCalendar(String holidayCalendarId, HolidayCalendarInfo holidayCalendarInfo, ContextInfo contextInfo)` Updates an existing Holiday Calendar.
`KeyDateInfo`	`updateKeyDate(String keyDateId, KeyDateInfo keyDateInfo, ContextInfo context)` Updates an existing KeyDate.
`TermInfo`	`updateTerm(String termId, TermInfo termInfo, ContextInfo context)` Updates an existing Term.
`List<ValidationResultInfo>`	`validateAcademicCalendar(String validationTypeKey, String academicCalendarTypeKey, AcademicCalendarInfo academicCalendarInfo, ContextInfo contextInfo)` Validates an AcademicCalendar.
`List<ValidationResultInfo>`	`validateAcalEvent(String validationTypeKey, String termId, String acalEventTypeKey, AcalEventInfo acalEventInfo, ContextInfo contextInfo)` Validates an AcalEvent.
`List<ValidationResultInfo>`	`validateHoliday(String validationTypeKey, String holidayCalendarId, String holidayTypeKey, HolidayInfo holidayInfo, ContextInfo contextInfo)` Validates a Holiday.
`List<ValidationResultInfo>`	`validateHolidayCalendar(String validationTypeKey, String holidayCalendarTypeKey, HolidayCalendarInfo holidayCalendarInfo, ContextInfo contextInfo)` Validates a HolidayCalendar.
`List<ValidationResultInfo>`	`validateKeyDate(String validationTypeKey, String termId, String keyDateTypeKey, KeyDateInfo keyDateInfo, ContextInfo contextInfo)` Validates a KeyDate.
`List<ValidationResultInfo>`	`validateTerm(String validationTypeKey, String termTypeKey, TermInfo termInfo, ContextInfo context)` Validates a Term.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

AcademicCalendarServiceImpl

public AcademicCalendarServiceImpl()

Method Detail

getAcalEventAssembler

public AcalEventAssembler getAcalEventAssembler()

setAcalEventAssembler

public void setAcalEventAssembler(AcalEventAssembler acalEventAssembler)

getKeyDateAssembler

public KeyDateAssembler getKeyDateAssembler()

setKeyDateAssembler

public void setKeyDateAssembler(KeyDateAssembler keyDateAssembler)

getHolidayAssembler

public HolidayAssembler getHolidayAssembler()

setHolidayAssembler

public void setHolidayAssembler(HolidayAssembler holidayAssembler)

getHolidayCalendarAssembler

public HolidayCalendarAssembler getHolidayCalendarAssembler()

setHolidayCalendarAssembler

public void setHolidayCalendarAssembler(HolidayCalendarAssembler holidayCalendarAssembler)

getDataDictionaryService

public DataDictionaryService getDataDictionaryService()

setDataDictionaryService

public void setDataDictionaryService(DataDictionaryService dataDictionaryService)

getTypeService

public TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getStateService

public StateService getStateService()

setStateService

public void setStateService(StateService stateService)

getAcademicCalendarType

public TypeInfo getAcademicCalendarType(String academicCalendarTypeKey,
                                        ContextInfo context)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException

Description copied from interface: AcademicCalendarService

Retrieves an AcademicCalendar Type by Type key.

Specified by:: getAcademicCalendarType in interface AcademicCalendarService

Parameters:: academicCalendarTypeKey - the key of an AcademicCalendar Type; context - information containing the principalId and locale information about the caller of service operation
Returns:: the type requested
Throws:: DoesNotExistException - academicCalendarTypeKey is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - academicCalendarTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request

getAcademicCalendarTypes

public List<TypeInfo> getAcademicCalendarTypes(ContextInfo context)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException

Description copied from interface: AcademicCalendarService

Gets the valid AcademicCalendar types.

Specified by:: getAcademicCalendarTypes in interface AcademicCalendarService

Parameters:: context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid AcademicCalendar Types
Throws:: InvalidParameterException - contextInfo is not value; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request

getAcademicCalendarState

public StateInfo getAcademicCalendarState(String academicCalendarStateKey,
                                          ContextInfo context)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException

Description copied from interface: AcademicCalendarService

Gets an AcademicCalendar State by key.

Specified by:: getAcademicCalendarState in interface AcademicCalendarService

Parameters:: academicCalendarStateKey - a key for an AcademicCalendar State; context - information containing the principalId and locale information about the caller of service operation
Returns:: the AcademicCalendar State requested
Throws:: DoesNotExistException - academicCalendarStateKey is not found; InvalidParameterException - contextInfo is invalid; MissingParameterException - academicCalendarStateKey or contextInfo is missing or null; OperationFailedException - unable to complete request

getAcademicCalendarStates

public List<StateInfo> getAcademicCalendarStates(ContextInfo context)
                                          throws InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets the valid AcademicCalendar States.

Specified by:: getAcademicCalendarStates in interface AcademicCalendarService

Parameters:: context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid AcademicCalendar States
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getAcademicCalendar

public AcademicCalendarInfo getAcademicCalendar(String academicCalendarKey,
                                                ContextInfo context)
                                         throws DoesNotExistException,
                                                InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException,
                                                PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a single AcademicCalendar by an AcademicCalendar Id.

Specified by:: getAcademicCalendar in interface AcademicCalendarService

Parameters:: academicCalendarKey - the identifier for the AcademicCalendar to be retrieved; context - information containing the principalId and locale information about the caller of service operation
Returns:: the AcademicCalendar requested
Throws:: DoesNotExistException - academicCalendarIs is not found; InvalidParameterException - contextInfo isnot valid; MissingParameterException - academicCalendarId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getAcademicCalendarsByIds

public List<AcademicCalendarInfo> getAcademicCalendarsByIds(List<String> academicCalendarKeyList,
                                                            ContextInfo context)
                                                     throws DoesNotExistException,
                                                            InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list AcademicCalendars from a list of AcademicCalendar Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Specified by:: getAcademicCalendarsByIds in interface AcademicCalendarService

Parameters:: academicCalendarKeyList - list of AcademicCalendar Ids; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of AcademicCalendars
Throws:: DoesNotExistException - an academicCalendarId in list was not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - academicCalendarIds, an Id in academicCalendarIds, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getAcademicCalendarIdsByType

public List<String> getAcademicCalendarIdsByType(String academicCalendarTypeKey,
                                                 ContextInfo context)
                                          throws InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of AcademicCalendar Ids by Type.

Specified by:: getAcademicCalendarIdsByType in interface AcademicCalendarService

Parameters:: academicCalendarTypeKey - an identifier for an AcademicCalendar Type; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of AcademicCalendars matching academicCalendarTypeKey or an empty list if none found
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - academicCalendarTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getAcademicCalendarsByStartYear

public List<AcademicCalendarInfo> getAcademicCalendarsByStartYear(Integer year,
                                                                  ContextInfo context)
                                                           throws InvalidParameterException,
                                                                  MissingParameterException,
                                                                  OperationFailedException,
                                                                  PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of AcademicCalendars that start in the given year.

Specified by:: getAcademicCalendarsByStartYear in interface AcademicCalendarService

Parameters:: year - calendar year during which the academic calendar starts; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of AcademicCalendars starting in the given year
Throws:: InvalidParameterException - contextInfo i snot valid; MissingParameterException - year or context is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

createAcademicCalendar

@Transactional(readOnly=false)
public AcademicCalendarInfo createAcademicCalendar(String academicCalendarTypeKey,
                                                                         AcademicCalendarInfo academicCalendarInfo,
                                                                         ContextInfo context)
                                            throws DataValidationErrorException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Description copied from interface: AcademicCalendarService

Creates a new AcademicCalendar. The AcademicCalendar Id, Type, and Meta information may not be set in the supplied data object.

Specified by:: createAcademicCalendar in interface AcademicCalendarService

Parameters:: academicCalendarTypeKey - the identifier for the Type of AcademicCalendar to be created; academicCalendarInfo - the data with which to create the AcademicCalendar; context - information containing the principalId and locale information about the caller of service operation
Returns:: the new AcademicCalendar
Throws:: DataValidationErrorException - supplied data is invalid; InvalidParameterException - academicCalendarInfo or contextInfo is not valid; MissingParameterException - academicCalendarTypeKey, academicCalendarInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

updateAcademicCalendar

@Transactional(readOnly=false)
public AcademicCalendarInfo updateAcademicCalendar(String academicCalendarId,
                                                                         AcademicCalendarInfo academicCalendarInfo,
                                                                         ContextInfo context)
                                            throws DataValidationErrorException,
                                                   DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException,
                                                   VersionMismatchException

Description copied from interface: AcademicCalendarService

Updates an existing AcademicCalendar. The AcademicCalendar Id, Type, and Meta information may not be changed.

Specified by:: updateAcademicCalendar in interface AcademicCalendarService

Parameters:: academicCalendarId - the identifier for the AcademicCalendar to be updated; academicCalendarInfo - the new data for the AcademicCalendar; context - information containing the principalId and locale information about the caller of service operation
Returns:: the updated AcademicCalendar
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - AcademicCalendarId is not found; InvalidParameterException - academicCalendarInfo or contextInfo is not valid; MissingParameterException - academicCalendarId, academicCalendarInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteAcademicCalendar

@Transactional(readOnly=false)
public StatusInfo deleteAcademicCalendar(String academicCalendarKey,
                                                               ContextInfo context)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException

Description copied from interface: AcademicCalendarService

Deletes an existing AcademicCalendar.

Specified by:: deleteAcademicCalendar in interface AcademicCalendarService

Parameters:: academicCalendarKey - the identifier for the AcademicCalendar to be deleted; context - information containing the principalId and locale information about the caller of service operation
Returns:: the status of the operation. This must always be true.
Throws:: DoesNotExistException - AcademicCalendarId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - academicCalendarId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

copyAcademicCalendar

public AcademicCalendarInfo copyAcademicCalendar(String academicCalendarId,
                                                 Date startDate,
                                                 Date endDate,
                                                 ContextInfo contextInfo)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Description copied from interface: AcademicCalendarService

Copy an AcademicCalendar. The associated Terms and key dates are also copied and related to this new calendar. This copy operation allows for a AcademicCalendar to be created from an existing AcademicCalendar in which the dates of the Terms and Key Dates will be updated.

This method may perform date transformations on the Terms and key dates to make them applicable under the new academic calendar.

Specified by:: copyAcademicCalendar in interface AcademicCalendarService

Parameters:: academicCalendarId - the identifier for the Academic Calendar to be copied; startDate - the start of the new calendar; endDate - the end of the new calendar; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: new AcademicCalendarInfo created from the copy
Throws:: DoesNotExistException - academicCalendarId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - academicCalendarId, startYear, endYear, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getHolidayCalendar

@Transactional(readOnly=true)
public HolidayCalendarInfo getHolidayCalendar(String holidayCalendarId,
                                                                    ContextInfo contextInfo)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a single HolidayCalendar by a HolidayCalendar Id.

Specified by:: getHolidayCalendar in interface AcademicCalendarService

Parameters:: holidayCalendarId - the identifier for the HolidayCalendar to be retrieved; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the HolidayCalendar requested
Throws:: DoesNotExistException - holidayCalendarIs is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayCalendarId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getHolidayCalendarsByIds

public List<HolidayCalendarInfo> getHolidayCalendarsByIds(List<String> holidayCalendarIds,
                                                          ContextInfo context)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list HolidayCalendars from a list of HolidayCalendar Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Specified by:: getHolidayCalendarsByIds in interface AcademicCalendarService

Parameters:: holidayCalendarIds - list of HolidayCalendar Ids; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of HolidayCalendars
Throws:: DoesNotExistException - a holidayCalendarId in list was not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayCalendarIds, an Id in holidayCalendarIds, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

createHolidayCalendar

@Transactional(readOnly=false)
public HolidayCalendarInfo createHolidayCalendar(String holidayCalendarTypeKey,
                                                                       HolidayCalendarInfo holidayCalendarInfo,
                                                                       ContextInfo context)
                                          throws DataValidationErrorException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Description copied from interface: AcademicCalendarService

Creates a new HolidayCalendar. The HolidayCalendar Id, Type, and Meta information may not be set in the supplied data object.

Specified by:: createHolidayCalendar in interface AcademicCalendarService

Parameters:: holidayCalendarTypeKey - the identifier for the Type of HolidayCalendar to be created; holidayCalendarInfo - the data with which to create the HolidayCalendar; context - information containing the principalId and locale information about the caller of service operation
Returns:: the new HolidayCalendar
Throws:: DataValidationErrorException - supplied data is invalid; InvalidParameterException - holidayCalendarInfo or contextInfo is not valid; MissingParameterException - holidayCalendarTypeKey, holidayCalendarInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

copyHolidayCalendar

@Transactional(readOnly=false)
public HolidayCalendarInfo copyHolidayCalendar(String holidayCalendarId,
                                                                     Date startDate,
                                                                     Date endDate,
                                                                     ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Description copied from interface: AcademicCalendarService

Copy an HolidayCalendar. This copy operation allows for a HolidayCalendar to be created from an existing HolidayCalendar .

Specified by:: copyHolidayCalendar in interface AcademicCalendarService

Parameters:: holidayCalendarId - the identifier for the Holiday Calendar to be copied; startDate - the start of the new calendar; endDate - the end of the new calendar; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: new HolidayCalendarInfo created from the copy
Throws:: DoesNotExistException - academicCalendarId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - academicCalendarId, startYear, endYear, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

updateHolidayCalendar

@Transactional(readOnly=false)
public HolidayCalendarInfo updateHolidayCalendar(String holidayCalendarId,
                                                                       HolidayCalendarInfo holidayCalendarInfo,
                                                                       ContextInfo contextInfo)
                                          throws DataValidationErrorException,
                                                 DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException,
                                                 ReadOnlyException,
                                                 VersionMismatchException

Description copied from interface: AcademicCalendarService

Updates an existing Holiday Calendar. The HolidayCalendar Id, Type, and Meta information may not be changed.

Specified by:: updateHolidayCalendar in interface AcademicCalendarService

Parameters:: holidayCalendarId - the identifier for the HolidayCalendar to be updated; holidayCalendarInfo - the new data for the HolidayCalendar; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the updated HolidayCalendar
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - HolidayCalendarId is not found; InvalidParameterException - holidayCalendarInfo or contextInfo is not valid; MissingParameterException - holidayCalendarId, holidayCalendarInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; ReadOnlyException - an attempt at changing information designated as read only; VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteHolidayCalendar

@Transactional(readOnly=false)
public StatusInfo deleteHolidayCalendar(String holidayCalendarId,
                                                              ContextInfo context)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: AcademicCalendarService

Deletes an existing HolidayCalendar.

Specified by:: deleteHolidayCalendar in interface AcademicCalendarService

Parameters:: holidayCalendarId - the identifier for the HolidayCalendar to be deleted; context - information containing the principalId and locale information about the caller of service operation
Returns:: the status of the operation. This must always be true.
Throws:: DoesNotExistException - HolidayCalendarId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayCalendarId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getTermType

public TypeInfo getTermType(String termTypeKey,
                            ContextInfo context)
                     throws DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException,
                            PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a Term Type by Type key.

Specified by:: getTermType in interface AcademicCalendarService

Parameters:: termTypeKey - the key of a Term Type; context - information containing the principalId and locale information about the caller of service operation
Returns:: the type requested
Throws:: DoesNotExistException - termTypeKey is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - termTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getTermTypes

public List<TypeInfo> getTermTypes(ContextInfo context)
                            throws InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets the valid Term types.

Specified by:: getTermTypes in interface AcademicCalendarService

Parameters:: context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid Term Types
Throws:: InvalidParameterException - contextInfo is not value; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getTermTypesForAcademicCalendarType

public List<TypeInfo> getTermTypesForAcademicCalendarType(String academicCalendarTypeKey,
                                                          ContextInfo context)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Description copied from interface: AcademicCalendarService

This method returns the valid Term types for an AcademicCalendar Type. Only Terms of allowed Types can be mapped to an AcademicCalendar.

Specified by:: getTermTypesForAcademicCalendarType in interface AcademicCalendarService

Parameters:: academicCalendarTypeKey - an identifier for an AcademicCalendar Type; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid Term Types for the AcademicCalendar Type
Throws:: DoesNotExistException - academicCalendarTypeKey is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - academicCalendarTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getTermTypesForTermType

public List<TypeInfo> getTermTypesForTermType(String termTypeKey,
                                              ContextInfo context)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Description copied from interface: AcademicCalendarService

This method returns the valid Term types for a Term Type. Only Terms of allowed Types can be included inside another Term.

Specified by:: getTermTypesForTermType in interface AcademicCalendarService

Parameters:: termTypeKey - a identifier for a Term Type; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid Term Types
Throws:: DoesNotExistException - termTypeKey is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - termTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getTermState

public StateInfo getTermState(String termStateKey,
                              ContextInfo context)
                       throws DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets a Term State by key.

Specified by:: getTermState in interface AcademicCalendarService

Parameters:: termStateKey - a key for a Term State; context - information containing the principalId and locale information about the caller of service operation
Returns:: the Term State requested
Throws:: DoesNotExistException - termStateKey is not found; InvalidParameterException - contextInfo is invalid; MissingParameterException - termStateKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getTermStates

public List<StateInfo> getTermStates(ContextInfo context)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets the valid Term States.

Specified by:: getTermStates in interface AcademicCalendarService

Parameters:: context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid Term States
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException

getTerm

public TermInfo getTerm(String termId,
                        ContextInfo context)
                 throws DoesNotExistException,
                        InvalidParameterException,
                        MissingParameterException,
                        OperationFailedException,
                        PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a single Term by a Term Id.

Specified by:: getTerm in interface AcademicCalendarService

Parameters:: termId - the identifier for the Term to be retrieved; context - information containing the principalId and locale information about the caller of service operation
Returns:: the Term requested
Throws:: DoesNotExistException - termIs is not found; InvalidParameterException - contextInfo isnot valid; MissingParameterException - termId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getTermsByIds

public List<TermInfo> getTermsByIds(List<String> termIds,
                                    ContextInfo context)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list Terms from a list of Term Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Specified by:: getTermsByIds in interface AcademicCalendarService

Parameters:: termIds - list of Term Ids; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Terms
Throws:: DoesNotExistException - a termId in list was not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - termIds, an Id in termIds, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getTermsForAcademicCalendar

public List<TermInfo> getTermsForAcademicCalendar(String academicCalendarId,
                                                  ContextInfo context)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of the top level Terms mapped to the given AcademicCalendar ordered by Term start date.

Specified by:: getTermsForAcademicCalendar in interface AcademicCalendarService

Parameters:: academicCalendarId - an identifier for an AcademicCalendar; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Terms mapped to the given AcademicCalendar
Throws:: DoesNotExistException - academicCalendarId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - academicCalendarId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCurrentTerms

public List<TermInfo> getCurrentTerms(String processKey,
                                      ContextInfo context)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Description copied from interface: AcademicCalendarService

Convenience method added for core-slice development to get a current term. The method will be redesigned later to be more generic so that it finds the unique term based on process key and academic calendar - "current" is a misnomer.

Specified by:: getCurrentTerms in interface AcademicCalendarService

Parameters:: processKey - we don't know what this means; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of "current" Terms
Throws:: DoesNotExistException - usageKey is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - usageKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getIncludedTermsInTerm

public List<TermInfo> getIncludedTermsInTerm(String termId,
                                             ContextInfo context)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list Terms included immediately inside the given Term ordered by Term start date. This method should be called recursively to get sub-terms of the returned Terms.

Specified by:: getIncludedTermsInTerm in interface AcademicCalendarService

Parameters:: termId - an identifier for a Term; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Terms or an empty list if there are no included Terms
Throws:: DoesNotExistException - termId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - termId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getContainingTerms

public List<TermInfo> getContainingTerms(String termId,
                                         ContextInfo context)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets the containing terms of a given term. A term may be "included" inside other terms using addTermToTerm(). This method returns the list of Terms that the given Term has been placed inside. Typically, a term is placed inside a single parent term.

Specified by:: getContainingTerms in interface AcademicCalendarService

Parameters:: termId - an identifier for a Term; context - information containing the principalId and locale information about the caller of service operation
Returns:: the parent terms or an empty list if it is a root
Throws:: DoesNotExistException - termId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - termId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateTerm

public List<ValidationResultInfo> validateTerm(String validationTypeKey,
                                               String termTypeKey,
                                               TermInfo termInfo,
                                               ContextInfo context)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException

Description copied from interface: AcademicCalendarService

Validates a Term. Depending on the value of validationType, this validation could be limited to tests on just the current Term and its directly contained subobjects or expanded to perform all tests related to this Term. If an identifier is present for the Term (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the Term can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the Term with the given data can be created.

Specified by:: validateTerm in interface AcademicCalendarService

Parameters:: validationTypeKey - the identifier for the validation Type; termTypeKey - the identifier for the Term Type to be validated; termInfo - the Term to be validated; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of validation results or an empty list if validation succeeded
Throws:: DoesNotExistException - validationTypeKey or termTypeKey is not found; InvalidParameterException - termInfo or contextInfo is not valid; MissingParameterException - validationTypeKey, termTypeKey, termInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request

createTerm

@Transactional(readOnly=false)
public TermInfo createTerm(String termTypeKey,
                                                 TermInfo termInfo,
                                                 ContextInfo context)
                    throws DataValidationErrorException,
                           InvalidParameterException,
                           MissingParameterException,
                           OperationFailedException,
                           PermissionDeniedException

Description copied from interface: AcademicCalendarService

Creates a new Term. The Term Type and Meta information may not be set in the supplied data object.

Specified by:: createTerm in interface AcademicCalendarService

Parameters:: termTypeKey - the identifier for the Type of Term to be created; termInfo - the data with which to create the Term; context - information containing the principalId and locale information about the caller of service operation
Returns:: the new Term
Throws:: DataValidationErrorException - supplied data is invalid; InvalidParameterException - termInfo or contextInfo is not valid; MissingParameterException - termTypeKey, termInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

updateTerm

@Transactional(readOnly=false)
public TermInfo updateTerm(String termId,
                                                 TermInfo termInfo,
                                                 ContextInfo context)
                    throws DataValidationErrorException,
                           DoesNotExistException,
                           InvalidParameterException,
                           MissingParameterException,
                           OperationFailedException,
                           PermissionDeniedException,
                           VersionMismatchException

Description copied from interface: AcademicCalendarService

Updates an existing Term. The Term Id, Type, and Meta information may not be changed.

Specified by:: updateTerm in interface AcademicCalendarService

Parameters:: termId - the identifier for the Term to be updated; termInfo - the new data for the Term; context - information containing the principalId and locale information about the caller of service operation
Returns:: the updated Term
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - TermId is not found; InvalidParameterException - termInfo or contextInfo is not valid; MissingParameterException - termId, termInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteTerm

@Transactional(readOnly=false)
public StatusInfo deleteTerm(String termId,
                                                   ContextInfo context)
                      throws DoesNotExistException,
                             InvalidParameterException,
                             MissingParameterException,
                             OperationFailedException,
                             PermissionDeniedException

Description copied from interface: AcademicCalendarService

Deletes an existing Term.

Specified by:: deleteTerm in interface AcademicCalendarService

Parameters:: termId - the identifier for the Term to be deleted; context - information containing the principalId and locale information about the caller of service operation
Returns:: the status of the operation. This must always be true.
Throws:: DoesNotExistException - TermId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - termId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

addTermToAcademicCalendar

@Transactional(readOnly=false)
public StatusInfo addTermToAcademicCalendar(String academicCalendarId,
                                                                  String termId,
                                                                  ContextInfo context)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException,
                                            AlreadyExistsException

Description copied from interface: AcademicCalendarService

Adds a Term to an AcademicCalendar.

Specified by:: addTermToAcademicCalendar in interface AcademicCalendarService

Parameters:: academicCalendarId - an identifier for an AcademicCalendar; termId - the Id of Term to be added; context - information containing the principalId and locale information about the caller of service operation
Returns:: the status of the operation. This must always be true.
Throws:: DoesNotExistException - academicCalendarId or termId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - academicCalendarId, termId, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; AlreadyExistsException - The Term is already mapped to the AcademicCalendar

removeTermFromAcademicCalendar

@Transactional(readOnly=false)
public StatusInfo removeTermFromAcademicCalendar(String academicCalendarKey,
                                                                       String termId,
                                                                       ContextInfo context)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Description copied from interface: AcademicCalendarService

Removes a Term from an AcademicCalendar.

Specified by:: removeTermFromAcademicCalendar in interface AcademicCalendarService

Parameters:: academicCalendarKey - an identifier for an AcademicCalendar; termId - the Id of Term to be unmapped; context - information containing the principalId and locale information about the caller of service operation
Returns:: the status of the operation. This must always be true.
Throws:: DoesNotExistException - termId or academicCalendarId is not found or termId is not mapped to academicCalendarId; InvalidParameterException - contextInfo is not valid; MissingParameterException - academicCalendarId, termId, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

addTermToTerm

@Transactional(readOnly=false)
public StatusInfo addTermToTerm(String termId,
                                                      String includedTermId,
                                                      ContextInfo context)
                         throws AlreadyExistsException,
                                DoesNotExistException,
                                InvalidParameterException,
                                MissingParameterException,
                                OperationFailedException,
                                PermissionDeniedException

Description copied from interface: AcademicCalendarService

Adds a Term as an included term within another Term.

Specified by:: addTermToTerm in interface AcademicCalendarService

Parameters:: termId - an identifier for a Term; includedTermId - the identifier for the Term to be included; context - information containing the principalId and locale information about the caller of service operation
Returns:: the status of the operation. This must always be true.
Throws:: AlreadyExistsException - includedTermId is already mapped to termId; DoesNotExistException - temId or includedTermId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - temId, includedTermId, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

removeTermFromTerm

@Transactional(readOnly=false)
public StatusInfo removeTermFromTerm(String termId,
                                                           String includedTermId,
                                                           ContextInfo context)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Description copied from interface: AcademicCalendarService

Removes an included Term from a Term.

Specified by:: removeTermFromTerm in interface AcademicCalendarService

Parameters:: termId - an identifier for a Term; includedTermId - the identifier for the Term to be removed; context - information containing the principalId and locale information about the caller of service operation
Returns:: the status of the operation. This must always be true.
Throws:: DoesNotExistException - termId or includedTermId is not found or includedTermId is not mapped to termId; InvalidParameterException - contextInfo is not valid; MissingParameterException - termId, includedTermId, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getKeyDateType

public TypeInfo getKeyDateType(String keyDateTypeKey,
                               ContextInfo context)
                        throws DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException

Description copied from interface: AcademicCalendarService

Rerieves a KeyDate Type by Type key.

Specified by:: getKeyDateType in interface AcademicCalendarService

Parameters:: keyDateTypeKey - the key of a keyDate Type; context - information containing the principalId and locale information about the caller of service operation
Returns:: the type requested
Throws:: DoesNotExistException - keyDateTypeKey is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - keyDateTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request

getKeyDateTypesForTermType

public List<TypeInfo> getKeyDateTypesForTermType(String termTypeKey,
                                                 ContextInfo context)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException

Description copied from interface: AcademicCalendarService

This method returns the valid KeyDate Types for the given Term Type.

Specified by:: getKeyDateTypesForTermType in interface AcademicCalendarService

Parameters:: termTypeKey - identifier for a Term Type; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid KeyDate Types
Throws:: DoesNotExistException - termTypeKey not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - termTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request

getKeyDate

public KeyDateInfo getKeyDate(String keyDateId,
                              ContextInfo context)
                       throws DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a single KeyDate by a KeyDate Id.

Specified by:: getKeyDate in interface AcademicCalendarService

Parameters:: keyDateId - the identifier for the KeyDate to be retrieved; context - information containing the principalId and locale information about the caller of service operation
Returns:: the KeyDate requested
Throws:: DoesNotExistException - keyDateIs is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - keyDateId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getKeyDatesByIds

public List<KeyDateInfo> getKeyDatesByIds(List<String> keyDateIds,
                                          ContextInfo context)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list KeyDates from a list of KeyDate Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Specified by:: getKeyDatesByIds in interface AcademicCalendarService

Parameters:: keyDateIds - list of KeyDate Ids; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of KeyDates
Throws:: DoesNotExistException - a keyDateId in list was not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - keyDateIds, an Id in keyDateIds, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getKeyDatesForTerm

public List<KeyDateInfo> getKeyDatesForTerm(String termId,
                                            ContextInfo context)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of KeyDates immediately mapped to a Term ordered by date.

Specified by:: getKeyDatesForTerm in interface AcademicCalendarService

Parameters:: termId - an identifier for a term; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of KeyDates mapped to the given Term
Throws:: DoesNotExistException - termId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - termId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getKeyDatesForTermByDate

public List<KeyDateInfo> getKeyDatesForTermByDate(String termId,
                                                  Date startDate,
                                                  Date endDate,
                                                  ContextInfo context)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of KeyDates immediately mapped to a Term that fall within the given date range inclusive ordered by date. The dates include only those dates immediate mapped to the Term.

Specified by:: getKeyDatesForTermByDate in interface AcademicCalendarService

Parameters:: termId - an identifier for a Term; startDate - the start of date range; endDate - the end of date range; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of KeyDates for the given Term in the given dates
Throws:: DoesNotExistException - termId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - termId, startDate, endDate, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getImpactedKeyDates

public List<KeyDateInfo> getImpactedKeyDates(String keyDateId,
                                             ContextInfo contextInfo)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets a list of KeyDates impacted by a change to a given KeyDate. Rules may exist to calculate key dates based on a KeyDate Type. Management of these calculation rules are not at this time exposed in this service.

Specified by:: getImpactedKeyDates in interface AcademicCalendarService

Parameters:: keyDateId - an identifier for a KeyDate; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of KeyDates impacted by the given KeyDate
Throws:: DoesNotExistException - keyDateId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - keyDateId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

updateKeyDate

@Transactional(readOnly=false)
public KeyDateInfo updateKeyDate(String keyDateId,
                                                       KeyDateInfo keyDateInfo,
                                                       ContextInfo context)
                          throws DataValidationErrorException,
                                 DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException,
                                 VersionMismatchException

Description copied from interface: AcademicCalendarService

Updates an existing KeyDate. The KeyDate Id, Type, and Meta information may not be changed.

Specified by:: updateKeyDate in interface AcademicCalendarService

Parameters:: keyDateId - the identifier for the KeyDate to be updated; keyDateInfo - the new data for the Key`Date; context - information containing the principalId and locale information about the caller of service operation
Returns:: the updated KeyDate
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - KeyDateId is not found; InvalidParameterException - keyDateInfo or contextInfo is not valid; MissingParameterException - keyDateId, keyDateInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteKeyDate

@Transactional(readOnly=false)
public StatusInfo deleteKeyDate(String keyDateId,
                                                      ContextInfo context)
                         throws DoesNotExistException,
                                InvalidParameterException,
                                MissingParameterException,
                                OperationFailedException,
                                PermissionDeniedException

Description copied from interface: AcademicCalendarService

Deletes an existing KeyDate.

Specified by:: deleteKeyDate in interface AcademicCalendarService

Parameters:: keyDateId - the identifier for the KeyDate to be deleted; context - information containing the principalId and locale information about the caller of service operation
Returns:: the status of the operation. This must always be true.
Throws:: DoesNotExistException - KeyDateId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - keyDateId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

calculateKeyDate

@Transactional(readOnly=false)
public KeyDateInfo calculateKeyDate(String keyDateId,
                                                          ContextInfo contextInfo)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Description copied from interface: AcademicCalendarService

Calculates the dates in the KeyDate based on a rule attached to the KeyDate Type. If there is no rule available for the Type of the given KeyDate, then no changes to the KeyDate occur.

Specified by:: calculateKeyDate in interface AcademicCalendarService

Parameters:: keyDateId - an identifier for a KeyDate; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the KeyDate with the calculated dates
Throws:: DoesNotExistException - keyDateId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - keyDateId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getHolidayType

public TypeInfo getHolidayType(String holidayTypeKey,
                               ContextInfo context)
                        throws DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException

Description copied from interface: AcademicCalendarService

Rerieves a Holiday Type by Type key.

Specified by:: getHolidayType in interface AcademicCalendarService

Parameters:: holidayTypeKey - the key of a holiday Type; context - information containing the principalId and locale information about the caller of service operation
Returns:: the type requested
Throws:: DoesNotExistException - holidayTypeKey is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

updateHoliday

@Transactional(readOnly=false)
public HolidayInfo updateHoliday(String holidayId,
                                                       HolidayInfo holidayInfo,
                                                       ContextInfo context)
                          throws DataValidationErrorException,
                                 DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException,
                                 VersionMismatchException

Description copied from interface: AcademicCalendarService

Updates an existing Holiday. The Holiday Id, Type, and Meta information may not be changed.

Specified by:: updateHoliday in interface AcademicCalendarService

Parameters:: holidayId - the identifier for the Holiday to be updated; holidayInfo - the new data for the Holiday; context - information containing the principalId and locale information about the caller of service operation
Returns:: the updated Holiday
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - HolidayId is not found; InvalidParameterException - holidayInfo or contextInfo is not valid; MissingParameterException - holidayId, holidayInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteHoliday

@Transactional(readOnly=false)
public StatusInfo deleteHoliday(String holidayId,
                                                      ContextInfo context)
                         throws DoesNotExistException,
                                InvalidParameterException,
                                MissingParameterException,
                                OperationFailedException,
                                PermissionDeniedException

Description copied from interface: AcademicCalendarService

Deletes an existing Holiday.

Specified by:: deleteHoliday in interface AcademicCalendarService

Parameters:: holidayId - the identifier for the Holiday to be deleted; context - information containing the principalId and locale information about the caller of service operation
Returns:: the status of the operation. This must always be true.
Throws:: DoesNotExistException - HolidayId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

calculateHoliday

@Transactional(readOnly=false)
public HolidayInfo calculateHoliday(String holidayId,
                                                          ContextInfo contextInfo)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Description copied from interface: AcademicCalendarService

Calculates the dates in the Holiday based on a rule attached to the Holiday Type. If there is no rule available for the Type of the given Holiday, then no changes to the Holiday occur.

Specified by:: calculateHoliday in interface AcademicCalendarService

Parameters:: holidayId - an identifier for a Holiday; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the Holiday with the calculated dates
Throws:: DoesNotExistException - holidayId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getAtpService

public AtpService getAtpService()

setAtpService

public void setAtpService(AtpService atpService)

getAcalAssembler

public AcademicCalendarAssembler getAcalAssembler()

setAcalAssembler

public void setAcalAssembler(AcademicCalendarAssembler acalAssembler)

getTermAssembler

public TermAssembler getTermAssembler()

setTermAssembler

public void setTermAssembler(TermAssembler termAssembler)

searchForAcademicCalendars

public List<AcademicCalendarInfo> searchForAcademicCalendars(QueryByCriteria criteria,
                                                             ContextInfo context)
                                                      throws InvalidParameterException,
                                                             MissingParameterException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Description copied from interface: AcademicCalendarService

Searches for AcademicCalendars that meet the given search criteria.

Specified by:: searchForAcademicCalendars in interface AcademicCalendarService

Parameters:: criteria - the search criteria; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of AcademicCalendars matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForTerms

public List<TermInfo> searchForTerms(QueryByCriteria criteria,
                                     ContextInfo context)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Description copied from interface: AcademicCalendarService

Searches for Terms that meet the given search criteria.

Specified by:: searchForTerms in interface AcademicCalendarService

Parameters:: criteria - the search criteria; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Terms matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForKeyDates

public List<KeyDateInfo> searchForKeyDates(QueryByCriteria criteria,
                                           ContextInfo context)
                                    throws InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

Description copied from interface: AcademicCalendarService

Searches for KeyDates that meet the given search criteria.

Specified by:: searchForKeyDates in interface AcademicCalendarService

Parameters:: criteria - the search criteria; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of KeyDates matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForHolidays

public List<HolidayInfo> searchForHolidays(QueryByCriteria criteria,
                                           ContextInfo context)
                                    throws InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

Description copied from interface: AcademicCalendarService

Searches for Holidays that meet the given search criteria.

Specified by:: searchForHolidays in interface AcademicCalendarService

Parameters:: criteria - the search criteria; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Holidays matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForAcademicCalendarIds

public List<String> searchForAcademicCalendarIds(QueryByCriteria criteria,
                                                 ContextInfo contextInfo)
                                          throws InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Description copied from interface: AcademicCalendarService

Searches for AcademicCalendars that meet the given search criteria.

Specified by:: searchForAcademicCalendarIds in interface AcademicCalendarService

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of AcademicCalendar identifiers matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

validateAcademicCalendar

public List<ValidationResultInfo> validateAcademicCalendar(String validationTypeKey,
                                                           String academicCalendarTypeKey,
                                                           AcademicCalendarInfo academicCalendarInfo,
                                                           ContextInfo contextInfo)
                                                    throws DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Description copied from interface: AcademicCalendarService

Validates an AcademicCalendar. Depending on the value of validationType, this validation could be limited to tests on just the current AcademicCalendar and its directly contained subobjects or expanded to perform all tests related to this AcademicCalendar. If an identifier is present for the AcademicCalendar (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the AcademicCalendar can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the AcademicCalendar with the given data can be created.

Specified by:: validateAcademicCalendar in interface AcademicCalendarService

Parameters:: validationTypeKey - the identifier for the validation Type; academicCalendarTypeKey - the identifier for the AcademicCalendar Type to be validated; academicCalendarInfo - the AcademicCalendar to be validated; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of validation results or an empty list if validation succeeded
Throws:: DoesNotExistException - validationTypeKey or academicCalendarTypeKey is not found; InvalidParameterException - academicCalendarInfo or contextInfo is not valid; MissingParameterException - validationTypeKey, academicCalendarTypeKey, academicCalendarInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getHolidayCalendarType

public TypeInfo getHolidayCalendarType(String holidayCalendarTypeKey,
                                       ContextInfo contextInfo)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException

Description copied from interface: AcademicCalendarService

Rerieves a HolidayCalendar Type by Type key.

Specified by:: getHolidayCalendarType in interface AcademicCalendarService

Parameters:: holidayCalendarTypeKey - the key of a HolidayCalendar Type; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the type requested
Throws:: DoesNotExistException - holidayCalendarTypeKey is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayCalendarTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request

getHolidayCalendarTypes

public List<TypeInfo> getHolidayCalendarTypes(ContextInfo contextInfo)
                                       throws InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException

Description copied from interface: AcademicCalendarService

Gets the valid HolidayCalendar types.

Specified by:: getHolidayCalendarTypes in interface AcademicCalendarService

Parameters:: contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid HolidayCalendar Types
Throws:: InvalidParameterException - contextInfo is not value; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request

getHolidayCalendarState

public StateInfo getHolidayCalendarState(String holidayCalendarStateKey,
                                         ContextInfo contextInfo)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         PermissionDeniedException,
                                         OperationFailedException

Description copied from interface: AcademicCalendarService

Gets a HolidayCalendar State by key.

Specified by:: getHolidayCalendarState in interface AcademicCalendarService

Parameters:: holidayCalendarStateKey - a key for a HolidayCalendar State; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the HolidayCalendar State requested
Throws:: DoesNotExistException - holidayCalendarStateKey is not found; InvalidParameterException - contextInfo is invalid; MissingParameterException - holidayCalendarStateKey or contextInfo is missing or null; PermissionDeniedException - an authorization failure occurred; OperationFailedException - unable to complete request

getHolidayCalendarStates

public List<StateInfo> getHolidayCalendarStates(ContextInfo contextInfo)
                                         throws InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException,
                                                PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets the valid HolidayCalendar States.

Specified by:: getHolidayCalendarStates in interface AcademicCalendarService

Parameters:: contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid HolidayCalendar States
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getHolidayCalendarIdsByType

public List<String> getHolidayCalendarIdsByType(String holidayCalendarTypeKey,
                                                ContextInfo contextInfo)
                                         throws InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException,
                                                PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of HolidayCalendar Ids by Type.

Specified by:: getHolidayCalendarIdsByType in interface AcademicCalendarService

Parameters:: holidayCalendarTypeKey - an identifier for an HolidayCalendar Type; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of HolidayCalendars matching holidayCalendarTypeKey or an empty list if none found
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayCalendarTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getHolidayCalendarsByStartYear

public List<HolidayCalendarInfo> getHolidayCalendarsByStartYear(Integer year,
                                                                ContextInfo contextInfo)
                                                         throws InvalidParameterException,
                                                                MissingParameterException,
                                                                OperationFailedException,
                                                                PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of HolidayCalendars that start in the given year.

Specified by:: getHolidayCalendarsByStartYear in interface AcademicCalendarService

Parameters:: year - calendar year during which the holiday calendar starts; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of HolidayCalendars starting in the given year
Throws:: InvalidParameterException - contextInfo i snot valid; MissingParameterException - year or context is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForHolidayCalendarIds

public List<String> searchForHolidayCalendarIds(QueryByCriteria criteria,
                                                ContextInfo contextInfo)
                                         throws InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException,
                                                PermissionDeniedException

Description copied from interface: AcademicCalendarService

Searches for HolidayCalendars that meet the given search criteria.

Specified by:: searchForHolidayCalendarIds in interface AcademicCalendarService

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of HolidayCalendar identifiers matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForHolidayCalendars

public List<HolidayCalendarInfo> searchForHolidayCalendars(QueryByCriteria criteria,
                                                           ContextInfo contextInfo)
                                                    throws InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Description copied from interface: AcademicCalendarService

Searches for HolidayCalendars that meet the given search criteria.

Specified by:: searchForHolidayCalendars in interface AcademicCalendarService

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of HolidayCalendars matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

validateHolidayCalendar

public List<ValidationResultInfo> validateHolidayCalendar(String validationTypeKey,
                                                          String holidayCalendarTypeKey,
                                                          HolidayCalendarInfo holidayCalendarInfo,
                                                          ContextInfo contextInfo)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Description copied from interface: AcademicCalendarService

Validates a HolidayCalendar. Depending on the value of validationType, this validation could be limited to tests on just the current HolidayCalendar and its directly contained subobjects or expanded to perform all tests related to this HolidayCalendar. If an identifier is present for the HolidayCalendar (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the HolidayCalendar can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the HolidayCalendar with the given data can be created.

Specified by:: validateHolidayCalendar in interface AcademicCalendarService

Parameters:: validationTypeKey - the identifier for the validation Type; holidayCalendarTypeKey - the identifier for the HolidayCalendar Type to be validated; holidayCalendarInfo - the HolidayCalendar to be validated; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of validation results or an empty list if validation succeeded
Throws:: DoesNotExistException - validationTypeKey or holidayCalendarTypeKey is not found; InvalidParameterException - holidayCalendarInfo or contextInfo is not valid; MissingParameterException - validationTypeKey, holidayCalendarTypeKey, holidayCalendarInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getTermIdsByType

public List<String> getTermIdsByType(String termTypeKey,
                                     ContextInfo contextInfo)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of Term Ids by Type.

Specified by:: getTermIdsByType in interface AcademicCalendarService

Parameters:: termTypeKey - an identifier for a Term Type; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Terms matching termTypeKey or an empty list if none found
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - termTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getTermsByCode

public List<TermInfo> getTermsByCode(String code,
                                     ContextInfo contextInfo)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets a list of Terms by Code. Typically, a Term Code is unique.

Specified by:: getTermsByCode in interface AcademicCalendarService

Parameters:: code - a Term Code; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Terms with the given Term Code
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - code or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForTermIds

public List<String> searchForTermIds(QueryByCriteria criteria,
                                     ContextInfo contextInfo)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Description copied from interface: AcademicCalendarService

Searches for Terms that meet the given search criteria.

Specified by:: searchForTermIds in interface AcademicCalendarService

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Term identifiers matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getKeyDateTypes

public List<TypeInfo> getKeyDateTypes(ContextInfo contextInfo)
                               throws InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException

Description copied from interface: AcademicCalendarService

Gets the valid KeyDate types.

Specified by:: getKeyDateTypes in interface AcademicCalendarService

Parameters:: contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid KeyDate Types
Throws:: InvalidParameterException - contextInfo is not value; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request

getKeyDateState

public StateInfo getKeyDateState(String keyDateStateKey,
                                 ContextInfo contextInfo)
                          throws DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException

Description copied from interface: AcademicCalendarService

Gets a KeyDate State by key.

Specified by:: getKeyDateState in interface AcademicCalendarService

Parameters:: keyDateStateKey - a key for a keyDate State; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the KeyDate State requested
Throws:: DoesNotExistException - keyDateStateKey is not found; InvalidParameterException - contextInfo is invalid; MissingParameterException - keyDateStateKey or contextInfo is missing or null; OperationFailedException - unable to complete request

getKeyDateStates

public List<StateInfo> getKeyDateStates(ContextInfo contextInfo)
                                 throws InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException

Description copied from interface: AcademicCalendarService

Gets the valid KeyDate States.

Specified by:: getKeyDateStates in interface AcademicCalendarService

Parameters:: contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid KeyDate States
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request

getKeyDateIdsByType

public List<String> getKeyDateIdsByType(String keyDateTypeKey,
                                        ContextInfo contextInfo)
                                 throws InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of KeyDate Ids by Type.

Specified by:: getKeyDateIdsByType in interface AcademicCalendarService

Parameters:: keyDateTypeKey - an identifier for a KeyDate Type; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of KeyDates matching keyDateTypeKey or an empty list if none found
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - keyDateTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getKeyDateIdsByTypeForTerm

public List<String> getKeyDateIdsByTypeForTerm(String keyDateTypeKey,
                                               String termId,
                                               ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of KeyDate Ids by Type and for a specific Term

Specified by:: getKeyDateIdsByTypeForTerm in interface AcademicCalendarService

Parameters:: keyDateTypeKey - an identifier for a KeyDate Type; termId - an identifier for a term; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of KeyDates matching keyDateTypeKey and for termId or an empty list if none found
Throws:: DoesNotExistException - a keyDateTypeKey is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - keyDateTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForKeyDateIds

public List<String> searchForKeyDateIds(QueryByCriteria criteria,
                                        ContextInfo contextInfo)
                                 throws InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: AcademicCalendarService

Searches for KeyDates that meet the given search criteria.

Specified by:: searchForKeyDateIds in interface AcademicCalendarService

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of KeyDate identifiers matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

validateKeyDate

public List<ValidationResultInfo> validateKeyDate(String validationTypeKey,
                                                  String termId,
                                                  String keyDateTypeKey,
                                                  KeyDateInfo keyDateInfo,
                                                  ContextInfo contextInfo)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Description copied from interface: AcademicCalendarService

Validates a KeyDate. Depending on the value of validationType, this validation could be limited to tests on just the current KeyDate and its directly contained subobjects or expanded to perform all tests related to this KeyDate. If an identifier is present for the KeyDate (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the KeyDate can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the KeyDate with the given data can be created.

Specified by:: validateKeyDate in interface AcademicCalendarService

Parameters:: validationTypeKey - the identifier for the validation Type; termId - the identifier for the Term; keyDateTypeKey - the identifier for the KeyDate Type to be validated; keyDateInfo - the KeyDate to be validated; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of validation results or an empty list if validation succeeded
Throws:: DoesNotExistException - validationTypeKey, termId, or keyDateTypeKey is not found; InvalidParameterException - keyDateInfo or contextInfo is not valid; MissingParameterException - validationTypeKey, termId, keyDateTypeKey, keyDateInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

createKeyDate

@Transactional(readOnly=false)
public KeyDateInfo createKeyDate(String termId,
                                                       String keyDateTypeKey,
                                                       KeyDateInfo keyDateInfo,
                                                       ContextInfo contextInfo)
                          throws DataValidationErrorException,
                                 DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException,
                                 ReadOnlyException

Description copied from interface: AcademicCalendarService

Creates a new KeyDate. The KeyDate Id, Type, and Meta information may not be set in the supplied data object.

Specified by:: createKeyDate in interface AcademicCalendarService

Parameters:: termId - the identifier for the Term in which to create the KeyDate; keyDateTypeKey - the identifier for the Type of KeyDate to be created; keyDateInfo - the data with which to create the KeyDate; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the new KeyDate
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - termId is not found or keyDateTypeKey does not exist or is not supported; InvalidParameterException - keyDateInfo or contextInfo is not valid; MissingParameterException - termId, keyDateTypeKey, keyDateInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; ReadOnlyException - an attempt at supplying information designated as read only

getAcalEventType

public TypeInfo getAcalEventType(String acalEventTypeKey,
                                 ContextInfo contextInfo)
                          throws DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException

Description copied from interface: AcademicCalendarService

Rerieves a AcalEvent Type by Type key.

Specified by:: getAcalEventType in interface AcademicCalendarService

Parameters:: acalEventTypeKey - the key of a acalEvent Type; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the type requested
Throws:: DoesNotExistException - acalEventTypeKey is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - acalEventTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request

getAcalEventTypes

public List<TypeInfo> getAcalEventTypes(ContextInfo contextInfo)
                                 throws InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets the valid AcalEvent types.

Specified by:: getAcalEventTypes in interface AcademicCalendarService

Parameters:: contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid AcalEvent Types
Throws:: InvalidParameterException - contextInfo is not value; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getAcalEventTypesForAcademicCalendarType

public List<TypeInfo> getAcalEventTypesForAcademicCalendarType(String academicCalendarTypeKey,
                                                               ContextInfo contextInfo)
                                                        throws DoesNotExistException,
                                                               InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException

Description copied from interface: AcademicCalendarService

This method returns the valid AcalEvent Types for the given AcademicCalendar Type.

Specified by:: getAcalEventTypesForAcademicCalendarType in interface AcademicCalendarService

Parameters:: academicCalendarTypeKey - identifier for an AcademicCalendar Type; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid AcalEvent Types
Throws:: DoesNotExistException - academicCalendarTypeKey not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - academicCalendarTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request

getAcalEventState

public StateInfo getAcalEventState(String acalEventStateKey,
                                   ContextInfo contextInfo)
                            throws DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException

Description copied from interface: AcademicCalendarService

Gets a AcalEvent State by key.

Specified by:: getAcalEventState in interface AcademicCalendarService

Parameters:: acalEventStateKey - a key for a acalEvent State; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the AcalEvent State requested
Throws:: DoesNotExistException - acalEventStateKey is not found; InvalidParameterException - contextInfo is invalid; MissingParameterException - acalEventStateKey or contextInfo is missing or null; OperationFailedException - unable to complete request

getAcalEventStates

public List<StateInfo> getAcalEventStates(ContextInfo contextInfo)
                                   throws InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException

Description copied from interface: AcademicCalendarService

Gets the valid AcalEvent States.

Specified by:: getAcalEventStates in interface AcademicCalendarService

Parameters:: contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid AcalEvent States
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request

getAcalEvent

public AcalEventInfo getAcalEvent(String acalEventId,
                                  ContextInfo contextInfo)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a single AcalEvent by an AcalEvent Id.

Specified by:: getAcalEvent in interface AcademicCalendarService

Parameters:: acalEventId - the identifier for the AcalEvent to be retrieved; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the AcalEvent requested
Throws:: DoesNotExistException - acalEventIs is not found; InvalidParameterException - contextInfo isnot valid; MissingParameterException - acalEventKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getAcalEventsByIds

public List<AcalEventInfo> getAcalEventsByIds(List<String> acalEventIds,
                                              ContextInfo contextInfo)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list AcalEvents from a list of AcalEvent Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Specified by:: getAcalEventsByIds in interface AcademicCalendarService

Parameters:: acalEventIds - list of AcalEvent Ids; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of AcalEvents
Throws:: DoesNotExistException - an acalEventId in list was not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - acalEventIds, an Id in acalEventIds, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getAcalEventIdsByType

public List<String> getAcalEventIdsByType(String acalEventTypeKey,
                                          ContextInfo contextInfo)
                                   throws InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of AcalEvent Ids by Type.

Specified by:: getAcalEventIdsByType in interface AcademicCalendarService

Parameters:: acalEventTypeKey - an identifier for an AcalEvent Type; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of AcalEvents matching acalEventTypeKey or an empty list if none found
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - acalEventTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getAcalEventsForAcademicCalendar

public List<AcalEventInfo> getAcalEventsForAcademicCalendar(String academicCalendarId,
                                                            ContextInfo contextInfo)
                                                     throws DoesNotExistException,
                                                            InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of AcalEvents immediately mapped to an AcademicCalendar ordered by date.

Specified by:: getAcalEventsForAcademicCalendar in interface AcademicCalendarService

Parameters:: academicCalendarId - an identifier for an AcademicCalendar; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of AcalEvents mapped to the given AcademicCalendar
Throws:: DoesNotExistException - academicCalendarId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - academicCalendarId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getAcalEventsForAcademicCalendarByDate

public List<AcalEventInfo> getAcalEventsForAcademicCalendarByDate(String academicCalendarId,
                                                                  Date startDate,
                                                                  Date endDate,
                                                                  ContextInfo contextInfo)
                                                           throws DoesNotExistException,
                                                                  InvalidParameterException,
                                                                  MissingParameterException,
                                                                  OperationFailedException,
                                                                  PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of AcalEvents immediately mapped to an AcademicCalendar that fall within the given date range inclusive ordered by date.

Specified by:: getAcalEventsForAcademicCalendarByDate in interface AcademicCalendarService

Parameters:: academicCalendarId - an identifier for an AcademicCalendar; startDate - the start of date range; endDate - the end of date range; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of AcalEvents for the given AcademicCalendar in the given dates
Throws:: DoesNotExistException - academicCalendarId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - academicCalendarId, startDate, endDate, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getImpactedAcalEvents

public List<AcalEventInfo> getImpactedAcalEvents(String acalEventId,
                                                 ContextInfo contextInfo)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets a list of AcalEvents impacted by a change to a given AcalEvent. Rules may exist to calculate key dates based on a AcalEvent Type. Management of these calculation rules are not at this time exposed in this service.

Specified by:: getImpactedAcalEvents in interface AcademicCalendarService

Parameters:: acalEventId - an identifier for an AcalEvent; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of AcalEvents impacted by the given AcalEvent
Throws:: DoesNotExistException - keyDateId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - acalEventId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForAcalEventIds

public List<String> searchForAcalEventIds(QueryByCriteria criteria,
                                          ContextInfo contextInfo)
                                   throws InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Description copied from interface: AcademicCalendarService

Searches for AcalEvents that meet the given search criteria.

Specified by:: searchForAcalEventIds in interface AcademicCalendarService

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of AcalEvent identifiers matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForAcalEvents

public List<AcalEventInfo> searchForAcalEvents(QueryByCriteria criteria,
                                               ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Description copied from interface: AcademicCalendarService

Searches for AcalEvents that meet the given search criteria.

Specified by:: searchForAcalEvents in interface AcademicCalendarService

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of AcalEvents matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

validateAcalEvent

public List<ValidationResultInfo> validateAcalEvent(String validationTypeKey,
                                                    String termId,
                                                    String acalEventTypeKey,
                                                    AcalEventInfo acalEventInfo,
                                                    ContextInfo contextInfo)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Description copied from interface: AcademicCalendarService

Validates an AcalEvent. Depending on the value of validationType, this validation could be limited to tests on just the current AcalEvent and its directly contained subobjects or expanded to perform all tests related to this AcalEvent. If an identifier is present for the AcalEvent (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the AcalEvent can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the AcalEvent with the given data can be created.

Specified by:: validateAcalEvent in interface AcademicCalendarService

Parameters:: validationTypeKey - the identifier for the validation Type; termId - the identifier for the Term; acalEventTypeKey - the identifier for the AcalEvent Type to be validated; acalEventInfo - the AcalEvent to be validated; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of validation results or an empty list if validation succeeded
Throws:: DoesNotExistException - validationTypeKey, termId, or acalEventTypeKey is not found; InvalidParameterException - acalEventInfo or contextInfo is not valid; MissingParameterException - validationTypeKey, termId, acalEventTypeKey, acalEventInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

createAcalEvent

@Transactional(readOnly=false)
public AcalEventInfo createAcalEvent(String academicCalendarId,
                                                           String acalEventTypeKey,
                                                           AcalEventInfo acalEventInfo,
                                                           ContextInfo contextInfo)
                              throws DataValidationErrorException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     ReadOnlyException

Description copied from interface: AcademicCalendarService

Creates a new AcalEvent. The AcalEvent Id, Type, and Meta information may not be set in the supplied data object.

Specified by:: createAcalEvent in interface AcademicCalendarService

Parameters:: academicCalendarId - the identifier for the AcademicCalendar in which to create the AcalEvent; acalEventTypeKey - the identifier for the Type of AcalEvent to be created; acalEventInfo - the data with which to create the AcalEvent; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the new AcalEvent
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - academicCalendarId is not found or acalEventTypeKey does not exist or is not supported; InvalidParameterException - acalEventInfo or contextInfo is not valid; MissingParameterException - academicCalendarId, acalEventTypeKey, acalEventInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; ReadOnlyException - an attempt at supplying information designated as read only

updateAcalEvent

@Transactional(readOnly=false)
public AcalEventInfo updateAcalEvent(String acalEventId,
                                                           AcalEventInfo acalEventInfo,
                                                           ContextInfo contextInfo)
                              throws DataValidationErrorException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     ReadOnlyException,
                                     VersionMismatchException

Description copied from interface: AcademicCalendarService

Updates an existing AcalEvent. The AcalEvent Id, Type, and Meta information may not be changed.

Specified by:: updateAcalEvent in interface AcademicCalendarService

Parameters:: acalEventId - the identifier for the AcalEvent to be updated; acalEventInfo - the new data for the AcalEvent; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the updated AcalEvent
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - AcalEventId is not found; InvalidParameterException - acalEventInfo or contextInfo is not valid; MissingParameterException - acalEventId, acalEventInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; ReadOnlyException - an attempt at changing information deisgnated as read only; VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteAcalEvent

@Transactional(readOnly=false)
public StatusInfo deleteAcalEvent(String acalEventId,
                                                        ContextInfo contextInfo)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException

Description copied from interface: AcademicCalendarService

Deletes an existing AcalEvent.

Specified by:: deleteAcalEvent in interface AcademicCalendarService

Parameters:: acalEventId - the identifier for the AcalEvent to be deleted; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the status of the operation. This must always be true.
Throws:: DoesNotExistException - AcalEventId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - acalEventId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

calculateAcalEvent

@Transactional(readOnly=false)
public AcalEventInfo calculateAcalEvent(String acalEventId,
                                                              ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: AcademicCalendarService

Calculates the dates in the AcalEvent based on a rule attached to the AcalEvent Type. If there is no rule available for the Type of the given AcalEvent, then no changes to the AcalEvent occur.

Specified by:: calculateAcalEvent in interface AcademicCalendarService

Parameters:: acalEventId - an identifier for a AcalEvent; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the AcalEvent with the calculated dates
Throws:: DoesNotExistException - acalEventId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - acalEventId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getHolidayTypes

public List<TypeInfo> getHolidayTypes(ContextInfo contextInfo)
                               throws InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets the valid Holiday types.

Specified by:: getHolidayTypes in interface AcademicCalendarService

Parameters:: contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid Holiday Types
Throws:: InvalidParameterException - contextInfo is not value; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getHolidayTypesForHolidayCalendarType

public List<TypeInfo> getHolidayTypesForHolidayCalendarType(String holidayCalendarTypeKey,
                                                            ContextInfo contextInfo)
                                                     throws DoesNotExistException,
                                                            InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException

Description copied from interface: AcademicCalendarService

This method returns the valid Holiday Types for the given HolidayCalendar Type.

Specified by:: getHolidayTypesForHolidayCalendarType in interface AcademicCalendarService

Parameters:: holidayCalendarTypeKey - identifier for a HolidayCalendar Type; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid Holiday Types
Throws:: DoesNotExistException - holidayCalendarTypeKey not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayCalendarTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request

getHolidayState

public StateInfo getHolidayState(String holidayStateKey,
                                 ContextInfo contextInfo)
                          throws DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets a Holiday State by key.

Specified by:: getHolidayState in interface AcademicCalendarService

Parameters:: holidayStateKey - a key for a holiday State; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the Holiday State requested
Throws:: DoesNotExistException - holidayStateKey is not found; InvalidParameterException - contextInfo is invalid; MissingParameterException - holidayStateKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getHolidayStates

public List<StateInfo> getHolidayStates(ContextInfo contextInfo)
                                 throws InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets the valid Holiday States.

Specified by:: getHolidayStates in interface AcademicCalendarService

Parameters:: contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid Holiday States
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getHoliday

public HolidayInfo getHoliday(String holidayId,
                              ContextInfo contextInfo)
                       throws DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a single Holiday by a Holiday Id.

Specified by:: getHoliday in interface AcademicCalendarService

Parameters:: holidayId - the identifier for the Holiday to be retrieved; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the Holiday requested
Throws:: DoesNotExistException - holidayIs is not found; InvalidParameterException - contextInfo isnot valid; MissingParameterException - holidayId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getHolidaysByIds

public List<HolidayInfo> getHolidaysByIds(List<String> holidayIds,
                                          ContextInfo contextInfo)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list Holidays from a list of Holiday Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Specified by:: getHolidaysByIds in interface AcademicCalendarService

Parameters:: holidayIds - list of Holiday Ids; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Holidays
Throws:: DoesNotExistException - a holidayId in list was not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayIds, an Id in holidayIds, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getHolidayIdsByType

public List<String> getHolidayIdsByType(String holidayTypeKey,
                                        ContextInfo contextInfo)
                                 throws InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of Holiday Ids by Type.

Specified by:: getHolidayIdsByType in interface AcademicCalendarService

Parameters:: holidayTypeKey - an identifier for an Holiday Type; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Holidays matching holidayTypeKey or an empty list if none found
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getHolidaysForHolidayCalendar

public List<HolidayInfo> getHolidaysForHolidayCalendar(String holidayCalendarId,
                                                       ContextInfo contextInfo)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of Holidays immediately mapped to a HolidayCalendar ordered by date.

Specified by:: getHolidaysForHolidayCalendar in interface AcademicCalendarService

Parameters:: holidayCalendarId - an identifier for a HolidayCalendar; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Holidays mapped to the given HolidayCalendar
Throws:: DoesNotExistException - holidayCalendarId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayCalendarId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getHolidaysForHolidayCalendarByDate

public List<HolidayInfo> getHolidaysForHolidayCalendarByDate(String holidayCalendarId,
                                                             Date startDate,
                                                             Date endDate,
                                                             ContextInfo contextInfo)
                                                      throws DoesNotExistException,
                                                             InvalidParameterException,
                                                             MissingParameterException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Description copied from interface: AcademicCalendarService

Retrieves a list of Holidays immediately mapped to a HolidayCalendar that fall within the given date range inclusive ordered by date.

Specified by:: getHolidaysForHolidayCalendarByDate in interface AcademicCalendarService

Parameters:: holidayCalendarId - an identifier for a HolidayCalendar; startDate - the start of date range; endDate - the end of date range; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Holidays for the given HolidayCalendar in the given dates
Throws:: DoesNotExistException - holidayCalendarId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayCalendarId, startDate, endDate, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getImpactedHolidays

public List<HolidayInfo> getImpactedHolidays(String holidayId,
                                             ContextInfo contextInfo)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets a list of Holidays impacted by a change to a given Holiday. Rules may exist to calculate key dates based on a Holiday Type. Management of these calculation rules are not at this time exposed in this service.

Specified by:: getImpactedHolidays in interface AcademicCalendarService

Parameters:: holidayId - an identifier for a Holiday; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Holidays impacted by the given Holiday
Throws:: DoesNotExistException - keyDateId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - holidayId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForHolidayIds

public List<String> searchForHolidayIds(QueryByCriteria criteria,
                                        ContextInfo contextInfo)
                                 throws InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: AcademicCalendarService

Searches for Holidays that meet the given search criteria.

Specified by:: searchForHolidayIds in interface AcademicCalendarService

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of Holiday identifiers matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

validateHoliday

public List<ValidationResultInfo> validateHoliday(String validationTypeKey,
                                                  String holidayCalendarId,
                                                  String holidayTypeKey,
                                                  HolidayInfo holidayInfo,
                                                  ContextInfo contextInfo)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Description copied from interface: AcademicCalendarService

Validates a Holiday. Depending on the value of validationType, this validation could be limited to tests on just the current Holiday and its directly contained subobjects or expanded to perform all tests related to this Holiday. If an identifier is present for the Holiday (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the Holiday can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the Holiday with the given data can be created.

Specified by:: validateHoliday in interface AcademicCalendarService

Parameters:: validationTypeKey - the identifier for the validation Type; holidayCalendarId - the identifier for the HolidayCalendar; holidayTypeKey - the identifier for the Holiday Type to be validated; holidayInfo - the Holiday to be validated; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of validation results or an empty list if validation succeeded
Throws:: DoesNotExistException - validationTypeKey, holidayCalendarId, or holidayTypeKey is not found; InvalidParameterException - holidayInfo or contextInfo is not valid; MissingParameterException - validationTypeKey, holidayCalendarId, holidayTypeKey, holidayInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

createHoliday

@Transactional(readOnly=false)
public HolidayInfo createHoliday(String holidayCalendarId,
                                                       String holidayTypeKey,
                                                       HolidayInfo holidayInfo,
                                                       ContextInfo contextInfo)
                          throws DataValidationErrorException,
                                 DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException,
                                 ReadOnlyException

Description copied from interface: AcademicCalendarService

Creates a new Holiday. The Holiday Id, Type, and Meta information may not be set in the supplied data object.

Specified by:: createHoliday in interface AcademicCalendarService

Parameters:: holidayCalendarId - the identifier for the HolidayCalendar in which to create the Holiday; holidayTypeKey - the identifier for the Type of Holiday to be created; holidayInfo - the data with which to create the Holiday; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the new Holiday
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - holidayCalendarId is not found or holidayTypeKey does not exist or is not supported; InvalidParameterException - holidayInfo or contextInfo is not valid; MissingParameterException - holidayCalendarId, holidayTypeKey, holidayInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; ReadOnlyException - an attempt at supplying information designated as read only

getAcademicCalendarData

public String getAcademicCalendarData(String academicCalendarId,
                                      String calendarDataFormatTypeKey,
                                      ContextInfo contextInfo)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Description copied from interface: AcademicCalendarService

Generates calendaring data for the Terms and key dates in an Academic Calendar. The format of the data is specified by the calendarDataFormatType. An example of such a type is VCALENDAR.

NOTE: this might be better placed in the Calendar (interface) Service.

Specified by:: getAcademicCalendarData in interface AcademicCalendarService

Parameters:: academicCalendarId - the key of the AcademicCalendar to be retrieved; calendarDataFormatTypeKey - the type of format
Returns:: calendar data
Throws:: DoesNotExistException - the AcademicCalendar or format type does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getInstructionalDaysForTerm

public Integer getInstructionalDaysForTerm(String termId,
                                           ContextInfo contextInfo)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

Description copied from interface: AcademicCalendarService

Calculates the number of instructional days for a Term. The number of instructional days is the number of class days in a Term minus the non-instructional holidays on the related holiday calendar.

Specified by:: getInstructionalDaysForTerm in interface AcademicCalendarService

Parameters:: termId - an identifier for a Term; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the number of instructional days in the given Term
Throws:: DoesNotExistException - termId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - termId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getAcademicCalendarsForTerm

public List<AcademicCalendarInfo> getAcademicCalendarsForTerm(String termId,
                                                              ContextInfo contextInfo)
                                                       throws InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException,
                                                              PermissionDeniedException,
                                                              DoesNotExistException

Description copied from interface: AcademicCalendarService

Gets the list of academic calendars that use this term.

Specified by:: getAcademicCalendarsForTerm in interface AcademicCalendarService

Parameters:: termId - term identifier; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of AcademicCalendars using this term
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - termId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; DoesNotExistException - termId is not found

getHolidaysByDateForAcademicCalendar

public List<HolidayInfo> getHolidaysByDateForAcademicCalendar(String academicCalendarId,
                                                              Date startDate,
                                                              Date endDate,
                                                              ContextInfo contextInfo)
                                                       throws DoesNotExistException,
                                                              InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Description copied from interface: AcademicCalendarService

Gets a list of holidays for a particular Academic Calendar further qualified by the dates. Can be used to get holidays for a term or any time period within the specified dates

Specified by:: getHolidaysByDateForAcademicCalendar in interface AcademicCalendarService

Parameters:: academicCalendarId - an identifier for an Academic Calendar; startDate - the start of date range; endDate - the end of date range; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of holidays for a particular Academic Calendar in the given dates
Throws:: DoesNotExistException - academicCalendarId is not found; InvalidParameterException - If the academicCalendarId is invalid or the dates are out of the range; MissingParameterException - Missing dates or academic Calendar Id; OperationFailedException - unable to complete request for any reason; PermissionDeniedException - authorization failure

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.kuali.student.enrollment.class2.acal.service.impl Class AcademicCalendarServiceImpl

AcademicCalendarServiceImpl

getAcalEventAssembler

setAcalEventAssembler

getKeyDateAssembler

setKeyDateAssembler

getHolidayAssembler

setHolidayAssembler

getHolidayCalendarAssembler

setHolidayCalendarAssembler

getDataDictionaryService

setDataDictionaryService

getTypeService

setTypeService

getStateService

setStateService

getAcademicCalendarType

getAcademicCalendarTypes

getAcademicCalendarState

getAcademicCalendarStates

getAcademicCalendar

getAcademicCalendarsByIds

getAcademicCalendarIdsByType

getAcademicCalendarsByStartYear

createAcademicCalendar

updateAcademicCalendar

deleteAcademicCalendar

copyAcademicCalendar

getHolidayCalendar

getHolidayCalendarsByIds

createHolidayCalendar

copyHolidayCalendar

updateHolidayCalendar

deleteHolidayCalendar

getTermType

getTermTypes

getTermTypesForAcademicCalendarType

getTermTypesForTermType

getTermState

getTermStates

getTerm

getTermsByIds

getTermsForAcademicCalendar

getCurrentTerms

getIncludedTermsInTerm

getContainingTerms

validateTerm

createTerm

updateTerm

deleteTerm

addTermToAcademicCalendar

removeTermFromAcademicCalendar

addTermToTerm

removeTermFromTerm

getKeyDateType

getKeyDateTypesForTermType

getKeyDate

getKeyDatesByIds

getKeyDatesForTerm

getKeyDatesForTermByDate

getImpactedKeyDates

updateKeyDate

deleteKeyDate

calculateKeyDate

getHolidayType

updateHoliday

deleteHoliday

calculateHoliday

getAtpService

setAtpService

getAcalAssembler

setAcalAssembler

getTermAssembler

setTermAssembler

searchForAcademicCalendars

searchForTerms

searchForKeyDates

searchForHolidays

searchForAcademicCalendarIds

validateAcademicCalendar

org.kuali.student.enrollment.class2.acal.service.impl
Class AcademicCalendarServiceImpl