CourseSeatCountSubscriptionService (Kuali Student 2.0.0-services-SNAPSHOT API)

public interface CourseSeatCountSubscriptionService

Method Summary

Methods
Modifier and Type	Method and Description
`StatusInfo`	`removeSubscription(String subscriptionId, ContextInfo contextInfo)` Remove the subscription of callback to stop listening.
`String`	`subscribeToCourseSeatCounts(SubscriptionActionEnum action, CourseSeatCountCallbackService courseSeatCountCallbackService, ContextInfo contextInfo)` Subscribe a callback to listen for CourseSeatCounts.
`String`	`subscribeToCourseSeatCountsByActivityOffering(SubscriptionActionEnum action, String activityOfferingId, CourseSeatCountCallbackService courseSeatCountCallbackService, ContextInfo contextInfo)` Subscribe a callback to listen for CourseSeatCounts for a given ActivityOffering.
`String`	`subscribeToCourseSeatCountsByActivityOfferings(SubscriptionActionEnum action, List<String> activityOfferingIds, CourseSeatCountCallbackService courseSeatCountCallbackService, ContextInfo contextInfo)` Subscribe a callback to listen for CourseSeatCounts for a given ActivityOfferings.
`String`	`subscribeToCourseSeatCountsByIds(SubscriptionActionEnum action, List<String> courseSeatCountId, CourseSeatCountCallbackService courseSeatCountCallbackService, ContextInfo contextInfo)` Subscribe a callback to listen for CourseSeatCounts for the given Ids.
`String`	`subscribeToCourseSeatCountsByType(SubscriptionActionEnum action, String courseSeatCountTypeKey, CourseSeatCountCallbackService courseSeatCountCallbackService, ContextInfo contextInfo)` Subscribe a callback to listen for CourseSeatCounts for a given type.

Method Detail

subscribeToCourseSeatCounts

String subscribeToCourseSeatCounts(SubscriptionActionEnum action,
                                 CourseSeatCountCallbackService courseSeatCountCallbackService,
                                 ContextInfo contextInfo)
                                   throws InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Subscribe a callback to listen for CourseSeatCounts.

Parameters:: action - action to listen for; courseSeatCountCallbackService - callback executable code to be invoked when the change event executes.; contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:: callback registration id that can be used to explicitly desubscribe the listener.
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - action, courseSeatCountCallbackService or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

subscribeToCourseSeatCountsByIds

String subscribeToCourseSeatCountsByIds(SubscriptionActionEnum action,
                                      List<String> courseSeatCountId,
                                      CourseSeatCountCallbackService courseSeatCountCallbackService,
                                      ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Subscribe a callback to listen for CourseSeatCounts for the given Ids.

Parameters:: action - action to listen for; courseSeatCountId - the identifier for the CourseSeatCounts to listen for.; courseSeatCountCallbackService - callback executable code to be invoked when the change event executes; contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:: callback registration id that can be used to explicitly desubscribe the listener.
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - action, courseSeatCountId, courseSeatCountCallbackService or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

subscribeToCourseSeatCountsByActivityOffering

String subscribeToCourseSeatCountsByActivityOffering(SubscriptionActionEnum action,
                                                   String activityOfferingId,
                                                   CourseSeatCountCallbackService courseSeatCountCallbackService,
                                                   ContextInfo contextInfo)
                                                     throws InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Subscribe a callback to listen for CourseSeatCounts for a given ActivityOffering.

Parameters:: action - action to listen for; activityOfferingId - the identifier for the ActivityOffering to be retrieved.; courseSeatCountCallbackService - callback executable code to be invoked when the change event executes; contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:: callback registration id that can be used to explicitly desubscribe the listener.
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - action, activityOfferingId, courseSeatCountCallbackService or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

subscribeToCourseSeatCountsByActivityOfferings

String subscribeToCourseSeatCountsByActivityOfferings(SubscriptionActionEnum action,
                                                    List<String> activityOfferingIds,
                                                    CourseSeatCountCallbackService courseSeatCountCallbackService,
                                                    ContextInfo contextInfo)
                                                      throws InvalidParameterException,
                                                             MissingParameterException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Subscribe a callback to listen for CourseSeatCounts for a given ActivityOfferings.

Parameters:: action - action to listen for; activityOfferingIds - the identifier for the ActivityOffering to be retrieved.; courseSeatCountCallbackService - callback executable code to be invoked when the change event executes; contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:: callback registration id that can be used to explicitly desubscribe the listener.
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - action, activityOfferingIds, courseSeatCountCallbackService or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

subscribeToCourseSeatCountsByType

String subscribeToCourseSeatCountsByType(SubscriptionActionEnum action,
                                       String courseSeatCountTypeKey,
                                       CourseSeatCountCallbackService courseSeatCountCallbackService,
                                       ContextInfo contextInfo)
                                         throws InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException,
                                                PermissionDeniedException

Subscribe a callback to listen for CourseSeatCounts for a given type.

Parameters:: action - action to listen for; courseSeatCountTypeKey - the identifier for the CourseSeatCount type to be retrieved.; courseSeatCountCallbackService - callback executable code to be invoked when the change event executes; contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:: callback registration id that can be used to explicitly desubscribe the listener.
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - action, courseSeatCountCallbackService or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

removeSubscription

StatusInfo removeSubscription(String subscriptionId,
                            ContextInfo contextInfo)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Remove the subscription of callback to stop listening.

Parameters:: subscriptionId - the identifier for the subscription; contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:: status indicating if it it unsubscribed
Throws:: DoesNotExistException - courseRegistrationId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - courseRegistrationId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

Interface CourseSeatCountSubscriptionService