org.kuali.student.core.atp.service
Interface AtpService

All Superinterfaces:

DictionaryService, SearchService

All Known Implementing Classes:

AtpServiceImpl

public interface AtpService
extends SearchService, DictionaryService

Academic Time Period Service Description and Assumptions

This service supports the management of Academic Time Periods and their associated Date Ranges and Milestones. The intent is to provide a flexible but structured way to define the various time frames that are used throughout the definition, offering and scheduling of Learning Units. This is a catalogue service with basic operations.

Method Summary

DateRangeInfo	addDateRange(String atpKey, String dateRangeKey, DateRangeInfo dateRangeInfo) Adds a new dateRange to an existing Academic Time Period
MilestoneInfo	addMilestone(String atpKey, String milestoneKey, MilestoneInfo milestoneInfo) Add a new milestone to an existing Academic Time Period
AtpInfo	createAtp(String atpTypeKey, String atpKey, AtpInfo atpInfo) Creates a new Academic Time Period
StatusInfo	deleteAtp(String atpKey) Deletes an existing Academic Time Period
AtpInfo	getAtp(String atpKey) Retrieves the details of a single Academic Time Period by atpKey
AtpDurationTypeInfo	getAtpDurationType(String atpDurationTypeKey) Retrieves information about a particular academic time period duration type
List<AtpDurationTypeInfo>	getAtpDurationTypes() Retrieves the list of Academic Time Period Duration Types known by this service
List<AtpInfo>	getAtpsByAtpType(String atpTypeKey) Retrieves a list of Academic Time Periods of the specified type
List<AtpInfo>	getAtpsByDate(Date searchDate) Retrieves the list of Academic Time Periods that the supplied date falls within
List<AtpInfo>	getAtpsByDates(Date startDate, Date endDate) Retrieves the list of Academic Time Periods that are totally contained within the supplied dates.
AtpSeasonalTypeInfo	getAtpSeasonalType(String atpSeasonalTypeKey) Retrieves information about a particular academic time period seasonal type
List<AtpSeasonalTypeInfo>	getAtpSeasonalTypes() Retrieves the list of Academic Time Period Seasonal Types known by this service
AtpTypeInfo	getAtpType(String atpTypeKey) Retrieves information about a particular academic time period type
List<AtpTypeInfo>	getAtpTypes() Retrieves the list of academic time period types known by this service
DateRangeInfo	getDateRange(String dateRangeKey) Retrieves the details of the specified daterange
List<DateRangeInfo>	getDateRangesByAtp(String atpKey) Retrieves the list of DateRanges for a specified Academic Time Period
List<DateRangeInfo>	getDateRangesByDate(Date searchDate) Retrieves the list of DateRanges which encompass the specified date
DateRangeTypeInfo	getDateRangeType(String dateRangeTypeKey) Retrieves information about a particular date range type
List<DateRangeTypeInfo>	getDateRangeTypes() Retrieves the list of date range types known by this service
List<DateRangeTypeInfo>	getDateRangeTypesForAtpType(String atpTypeKey) Retrieves the list of dateRange types that are defined for a particular Atp Type
MilestoneInfo	getMilestone(String milestoneKey) Retrieves the details of the specified milestone
List<MilestoneInfo>	getMilestonesByAtp(String atpKey) Retrieves the list of milestones for a specified Academic Time Period
List<MilestoneInfo>	getMilestonesByDates(Date startDate, Date endDate) Retrieves the list of milestones that fall within a specified set of dates
List<MilestoneInfo>	getMilestonesByDatesAndType(String milestoneTypeKey, Date startDate, Date endDate) Retrieves a list of milestones of a specified type that fall within a specified set of dates
MilestoneTypeInfo	getMilestoneType(String milestoneTypeKey) Retrieves information about a particular milestone type
List<MilestoneTypeInfo>	getMilestoneTypes() Retrieves the list of milestone types known by this service
List<MilestoneTypeInfo>	getMilestoneTypesForAtpType(String atpTypeKey) Retrieves the list of milestone types that are defined for a particular Atp Type
StatusInfo	removeDateRange(String dateRangeKey) Removes an existing daterange.
StatusInfo	removeMilestone(String milestoneKey) Removes an existing milestone.
AtpInfo	updateAtp(String atpKey, AtpInfo atpInfo) Updates an existing Academic Time Period
DateRangeInfo	updateDateRange(String dateRangeKey, DateRangeInfo dateRangeInfo) Updates an existing daterange
MilestoneInfo	updateMilestone(String milestoneKey, MilestoneInfo milestoneInfo) Updates an existing milestone.
List<ValidationResultInfo>	validateAtp(String validationType, AtpInfo atpInfo) Validates an academic time period.
List<ValidationResultInfo>	validateDateRange(String validationType, DateRangeInfo dateRangeInfo) Validates a date range.
List<ValidationResultInfo>	validateMilestone(String validationType, MilestoneInfo milestoneInfo) Validates a milestone.

Methods inherited from interface org.kuali.student.common.search.service.SearchService

getSearchCriteriaType, getSearchCriteriaTypes, getSearchResultType, getSearchResultTypes, getSearchType, getSearchTypes, getSearchTypesByCriteria, getSearchTypesByResult, search

Methods inherited from interface org.kuali.student.common.dictionary.service.DictionaryService

getObjectStructure, getObjectTypes

Method Detail

getAtpTypes

List<AtpTypeInfo> getAtpTypes()
                              throws OperationFailedException

Retrieves the list of academic time period types known by this service

Returns:

list of academic time period types

Throws:

OperationFailedException - unable to complete request

getAtpType

AtpTypeInfo getAtpType(String atpTypeKey)
                       throws DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException

Retrieves information about a particular academic time period type

Parameters:

atpTypeKey - academic time period type identifier

Returns:

academic time period type information

Throws:

DoesNotExistException - specified atp type not found

InvalidParameterException - invalid atpTypeKey

MissingParameterException - atpTypeKey not specified

OperationFailedException - unable to complete request

getAtpSeasonalTypes

List<AtpSeasonalTypeInfo> getAtpSeasonalTypes()
                                              throws OperationFailedException

Retrieves the list of Academic Time Period Seasonal Types known by this service

Returns:

List of academic time period seasonal types

Throws:

OperationFailedException - unable to complete request

getAtpSeasonalType

AtpSeasonalTypeInfo getAtpSeasonalType(String atpSeasonalTypeKey)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException

Retrieves information about a particular academic time period seasonal type

Parameters:

atpSeasonalTypeKey - academic time period seasonal type identifier

Returns:

academic time period seasonal type information

Throws:

DoesNotExistException - specified atp seasonal type not found

InvalidParameterException - invalid atpSeasonalTypeKey

MissingParameterException - atpSeasonalTypeKey not specified

OperationFailedException - unable to complete request

getAtpDurationTypes

List<AtpDurationTypeInfo> getAtpDurationTypes()
                                              throws OperationFailedException

Retrieves the list of Academic Time Period Duration Types known by this service

Returns:

List of academic time period duration types

Throws:

OperationFailedException - unable to complete request

getAtpDurationType

AtpDurationTypeInfo getAtpDurationType(String atpDurationTypeKey)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException

Retrieves information about a particular academic time period duration type

Parameters:

atpDurationTypeKey - academic time period duration type identifier

Returns:

academic time period duration type information

Throws:

DoesNotExistException - specified atp duration type not found

InvalidParameterException - invalid atpDurationTypeKey

MissingParameterException - atpDurationTypeKey not specified

OperationFailedException - unable to complete request

getMilestoneTypes

List<MilestoneTypeInfo> getMilestoneTypes()
                                          throws OperationFailedException

Retrieves the list of milestone types known by this service

Returns:

List of milestone types

Throws:

OperationFailedException - unable to complete request

getMilestoneType

MilestoneTypeInfo getMilestoneType(String milestoneTypeKey)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException

Retrieves information about a particular milestone type

Parameters:

milestoneTypeKey - milestone type identifier

Returns:

milestone type information

Throws:

DoesNotExistException - specified milestone type not found

InvalidParameterException - invalid milestoneTypeKey

MissingParameterException - milestoneTypeKey not specified

OperationFailedException - unable to complete request

getMilestoneTypesForAtpType

List<MilestoneTypeInfo> getMilestoneTypesForAtpType(String atpTypeKey)
                                                    throws DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException

Retrieves the list of milestone types that are defined for a particular Atp Type

Parameters:

atpTypeKey - atpTypeKey

Returns:

List of milestone types

Throws:

DoesNotExistException - specified atpTypeKey not found

InvalidParameterException - invalid atpTypeKey

MissingParameterException - atpTypeKey not specified

OperationFailedException - unable to complete request

getDateRangeTypes

List<DateRangeTypeInfo> getDateRangeTypes()
                                          throws OperationFailedException

Retrieves the list of date range types known by this service

Returns:

List of date range types

Throws:

OperationFailedException - unable to complete request

getDateRangeType

DateRangeTypeInfo getDateRangeType(String dateRangeTypeKey)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException

Retrieves information about a particular date range type

Parameters:

dateRangeTypeKey - date range type identifier

Returns:

date range type information

Throws:

DoesNotExistException - specified date range type not found

InvalidParameterException - invalid dateRangeTypeKey

MissingParameterException - dateRangeTypeKey not specified

OperationFailedException - unable to complete request

getDateRangeTypesForAtpType

List<DateRangeTypeInfo> getDateRangeTypesForAtpType(String atpTypeKey)
                                                    throws DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException

Retrieves the list of dateRange types that are defined for a particular Atp Type

Parameters:

atpTypeKey - atpTypeKey

Returns:

List of milestone types

Throws:

DoesNotExistException - specified atpTypeKey not found

InvalidParameterException - invalid atpTypeKey

MissingParameterException - atpTypeKey not specified

OperationFailedException - unable to complete request

validateAtp

List<ValidationResultInfo> validateAtp(String validationType,
                                       AtpInfo atpInfo)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException

Validates an academic time period. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained subobjects or expanded to perform all tests related to this object. If an identifier is present for the academic time period and a record is found for that identifier, the validation checks if the academic time period can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.

Parameters:

validationType - Identifier of the extent of validation

atpInfo - The academic time period information to be tested.

Returns:

Results from performing the validation

Throws:

DoesNotExistException - validationTypeKey not found

InvalidParameterException - invalid validationTypeKey, atpInfo

MissingParameterException - missing validationTypeKey, atpInfo

OperationFailedException - unable to complete request

validateMilestone

List<ValidationResultInfo> validateMilestone(String validationType,
                                             MilestoneInfo milestoneInfo)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException

Validates a milestone. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained subobjects or expanded to perform all tests related to this object. If an identifier is present for the milestone and a record is found for that identifier, the validation checks if the milestone can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.

Parameters:

validationType - Identifier of the extent of validation

milestoneInfo - The milestone information to be tested.

Returns:

Results from performing the validation

Throws:

DoesNotExistException - validationTypeKey not found

InvalidParameterException - invalid validationTypeKey, milestoneInfo

MissingParameterException - missing validationTypeKey, milestoneInfo

OperationFailedException - unable to complete request

validateDateRange

List<ValidationResultInfo> validateDateRange(String validationType,
                                             DateRangeInfo dateRangeInfo)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException

Validates a date range. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained subobjects or expanded to perform all tests related to this object. If an identifier is present for the date range and a record is found for that identifier, the validation checks if the academic time period can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.

Parameters:

validationType - Identifier of the extent of validation

dateRangeInfo - The date range information to be tested.

Returns:

Results from performing the validation

Throws:

DoesNotExistException - validationTypeKey not found

InvalidParameterException - invalid validationTypeKey, dateRangeInfo

MissingParameterException - missing validationTypeKey, dateRangeInfo

OperationFailedException - unable to complete request

getAtp

AtpInfo getAtp(String atpKey)
               throws DoesNotExistException,
                      InvalidParameterException,
                      MissingParameterException,
                      OperationFailedException

Retrieves the details of a single Academic Time Period by atpKey

Parameters:

atpKey - Unique key of the Academic Time Period to be retrieved

Returns:

Details of the Academic Time Period requested

Throws:

DoesNotExistException - atpKey not found

InvalidParameterException - invalid atpKey

MissingParameterException - invalid atpKey

OperationFailedException - unable to complete request

getAtpsByDate

List<AtpInfo> getAtpsByDate(Date searchDate)
                            throws InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException

Retrieves the list of Academic Time Periods that the supplied date falls within

Parameters:

searchDate - Timestamp to be matched

Returns:

List of Academic Time Periods that contain the supplied searchDate

Throws:

InvalidParameterException - invalid searchDate

MissingParameterException - invalid searchDate

OperationFailedException - unable to complete request

getAtpsByDates

List<AtpInfo> getAtpsByDates(Date startDate,
                             Date endDate)
                             throws InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException

Retrieves the list of Academic Time Periods that are totally contained within the supplied dates. The entire Atp falls within the supplied dates

Parameters:

startDate - Earliest Timestamp

endDate - Latest Timestamp

Returns:

List of Academic Time Periods that contain the supplied searchDate

Throws:

InvalidParameterException - invalid searchDate

MissingParameterException - invalid searchDate

OperationFailedException - unable to complete request

getAtpsByAtpType

List<AtpInfo> getAtpsByAtpType(String atpTypeKey)
                               throws InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException

Retrieves a list of Academic Time Periods of the specified type

Parameters:

atpTypeKey - ATP type to be retrieved

Returns:

List of Academic Time Periods that contain the supplied date

Throws:

InvalidParameterException - invalid atpTypeKey

MissingParameterException - invalid atpTypeKey

OperationFailedException - unable to complete request

getMilestone

MilestoneInfo getMilestone(String milestoneKey)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException

Retrieves the details of the specified milestone

Parameters:

milestoneKey - Unique id of the milestone to be retrieved

Returns:

Details of requested milestone

Throws:

DoesNotExistException - milestoneKey not found

InvalidParameterException - invalid milestoneKey

MissingParameterException - invalid milestoneKey

OperationFailedException - unable to complete request

getMilestonesByAtp

List<MilestoneInfo> getMilestonesByAtp(String atpKey)
                                       throws InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException

Retrieves the list of milestones for a specified Academic Time Period

Parameters:

atpKey - Unique key of the Academic Time Period to be retieved

Returns:

List of milestones for this Academic Time Period

Throws:

InvalidParameterException - invalid atpKey

MissingParameterException - invalid atpKey

OperationFailedException - unable to complete request

getMilestonesByDates

List<MilestoneInfo> getMilestonesByDates(Date startDate,
                                         Date endDate)
                                         throws InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException

Retrieves the list of milestones that fall within a specified set of dates

Parameters:

startDate - Start Date for date span

endDate - End Date for date span

Returns:

List of milestones that fall within this set of dates

Throws:

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameter(s) missing

OperationFailedException - unable to complete request

getMilestonesByDatesAndType

List<MilestoneInfo> getMilestonesByDatesAndType(String milestoneTypeKey,
                                                Date startDate,
                                                Date endDate)
                                                throws InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException

Retrieves a list of milestones of a specified type that fall within a specified set of dates

Parameters:

milestoneTypeKey - Milestone type to be retrieved

startDate - Start Date for date range

endDate - End Date for date range

Returns:

List of milestones of this milestone type within this set of dates

Throws:

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

getDateRange

DateRangeInfo getDateRange(String dateRangeKey)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException

Retrieves the details of the specified daterange

Parameters:

dateRangeKey - Unique id of the date range to be retrieved

Returns:

Details of requested daterange

Throws:

DoesNotExistException - dateRangeKey not found

InvalidParameterException - invalid dateRangeKey

MissingParameterException - missing dateRangeKey

OperationFailedException - unable to complete request

getDateRangesByAtp

List<DateRangeInfo> getDateRangesByAtp(String atpKey)
                                       throws InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException

Retrieves the list of DateRanges for a specified Academic Time Period

Parameters:

atpKey - Unique key of the Academic Time Period to be retieved

Returns:

List of dateRanges for this Academic Time Period

Throws:

InvalidParameterException - invalid atpKey

MissingParameterException - invalid atpKey

OperationFailedException - unable to complete request

getDateRangesByDate

List<DateRangeInfo> getDateRangesByDate(Date searchDate)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException

Retrieves the list of DateRanges which encompass the specified date

Parameters:

searchDate - Timestamp to be matched

Returns:

List of dateRanges that contain the supplied searchDate

Throws:

InvalidParameterException - invalid searchDate

MissingParameterException - invalid searchDate

OperationFailedException - unable to complete request

createAtp

AtpInfo createAtp(String atpTypeKey,
                  String atpKey,
                  AtpInfo atpInfo)
                  throws AlreadyExistsException,
                         DataValidationErrorException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException

Creates a new Academic Time Period

Parameters:

atpTypeKey - Type of ATP to be created

atpKey - Key of ATP to be created

atpInfo - Details of ATP to be created

Returns:

Details of ATP just created

Throws:

AlreadyExistsException - ATP being created already exists

DataValidationErrorException - One or more values invalid for this operation

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

updateAtp

AtpInfo updateAtp(String atpKey,
                  AtpInfo atpInfo)
                  throws DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException,
                         VersionMismatchException

Updates an existing Academic Time Period

Parameters:

atpKey - Key of ATP to be updated

atpInfo - Details of updates to ATP being updated

Returns:

Details of ATP just updated

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - ATP being updated does not exist

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - The action was attempted on an out of date version.

deleteAtp

StatusInfo deleteAtp(String atpKey)
                     throws DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException,
                            PermissionDeniedException

Deletes an existing Academic Time Period

Parameters:

atpKey - Key of ATP to be deleted

Returns:

status of the operation (success, failed)

Throws:

DoesNotExistException - ATP being deleted does not exist

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

addMilestone

MilestoneInfo addMilestone(String atpKey,
                           String milestoneKey,
                           MilestoneInfo milestoneInfo)
                           throws AlreadyExistsException,
                                  DataValidationErrorException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException

Add a new milestone to an existing Academic Time Period

Parameters:

atpKey - Key of ATP to be updated

milestoneKey - Id of milestone to be added

milestoneInfo - Details of milestone to be added

Returns:

Details of the newly created milestone

Throws:

AlreadyExistsException - Milestone being added already exists

DataValidationErrorException - One or more values invalid for this operation

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

updateMilestone

MilestoneInfo updateMilestone(String milestoneKey,
                              MilestoneInfo milestoneInfo)
                              throws DataValidationErrorException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     VersionMismatchException

Updates an existing milestone.

Parameters:

milestoneKey - ID of milestone to be updated

milestoneInfo - Details of milestone to be updated

Returns:

Details of the updated milestone

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - Milestone being updated does not exist

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - The action was attempted on an out of date version.

removeMilestone

StatusInfo removeMilestone(String milestoneKey)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException

Removes an existing milestone.

Parameters:

milestoneKey - Id of milestone to be removed

Returns:

Status of the operation (success, failed)

Throws:

DoesNotExistException - Milestone being removed does not exist

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

addDateRange

DateRangeInfo addDateRange(String atpKey,
                           String dateRangeKey,
                           DateRangeInfo dateRangeInfo)
                           throws AlreadyExistsException,
                                  DataValidationErrorException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException

Adds a new dateRange to an existing Academic Time Period

Parameters:

atpKey - key of the ATP to be associated with the dateRange

dateRangeKey - identifier of the dateRange to be added

dateRangeInfo - details of the dateRange to be added

Returns:

details of the newly created dateRange

Throws:

AlreadyExistsException - dateRange being added already exists

DataValidationErrorException - one or more values invalid for this operation

InvalidParameterException - one or more parameters invalid

MissingParameterException - one or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

updateDateRange

DateRangeInfo updateDateRange(String dateRangeKey,
                              DateRangeInfo dateRangeInfo)
                              throws DataValidationErrorException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     VersionMismatchException

Updates an existing daterange

Parameters:

dateRangeKey - identifier of daterange to be updated

dateRangeInfo - details of daterange to be updated

Returns:

details of the updated dateRange

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - dateRange being updated does not exist

InvalidParameterException - one or more parameters invalid

MissingParameterException - one or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - action was attempted on an out of date version.

removeDateRange

StatusInfo removeDateRange(String dateRangeKey)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException

Removes an existing daterange.

Parameters:

dateRangeKey - key of daterange to be removed

Returns:

status of the operation (success, failed)

Throws:

DoesNotExistException - DateRange being removed does not exist

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure