Interface SupersedingEventEnablerRuleApplicationSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface SupersedingEventEnablerRuleApplicationSession extends OsidSession

This session provides methods to apply SupersedingEventEnablers to SupersedingEvents. A SupersedingEvent with multiple SupersedingEventEnablers means any positive rule evaluation across the enablers result in an effective SupersedingEvent.

Like all OsidSessions, SupersedingEventEnablerRuleApplicationSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getCalendarId

      Id getCalendarId()
      Gets the Calendar Id associated with this session.
      Returns:
      the Calendar Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCalendar

      Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
      Gets the Calendar associated with this session.
      Returns:
      the calendar
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canAssignSupersedingEventEnablers

      boolean canAssignSupersedingEventEnablers()
      Tests if this user can alter superseding event enabler/superseding event mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • assignSupersedingEventEnablerToSupersedingEvent

      void assignSupersedingEventEnablerToSupersedingEvent(Id supersedingEventEnablerId, Id supersedingEventId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing SupersedingEventEnabler to a SupersedingEvent.
      Parameters:
      supersedingEventEnablerId - the Id of the SupersedingEventEnabler
      supersedingEventId - the Id of the SupersedingEvent
      Throws:
      AlreadyExistsException - supersedingEventEnablerId already applied to supersedingEventId
      NotFoundException - supersedingEventEnablerId or supersedingEventId not found
      NullArgumentException - supersedingEventEnablerId or supersedingEventId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignSupersedingEventEnablerFromSupersedingEvent

      void unassignSupersedingEventEnablerFromSupersedingEvent(Id supersedingEventEnablerId, Id supersedingEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a SupersedingEventEnabler from a SupersedingEvent.
      Parameters:
      supersedingEventEnablerId - the Id of the SupersedingEventEnabler
      supersedingEventId - the Id of the Calendar
      Throws:
      NotFoundException - supersedingEventEnablerId or supersedingEventId not found or supersedingEventEnablerId not applied to supersedingEventId
      NullArgumentException - supersedingEventEnablerId or supersedingEventId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSequenceSupersedingEventEnablers

      boolean canSequenceSupersedingEventEnablers()
      Tests if this user can order SupersedingEventEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
      Returns:
      false if SupersedingEventEnabler ordering is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • moveSupersedingEventEnablerAhead

      void moveSupersedingEventEnablerAhead(Id supersedingEventEnablerId, Id supersedingEventId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Reorders superseding event enablers for a superseding event by moving the specified superseding event enabler in front of a reference superseding event enabler.
      Parameters:
      supersedingEventEnablerId - the Id of a SupersedingEventEnabler
      supersedingEventId - the Id of a SupersedingEvent
      referenceId - the reference superseding event enabler Id
      Throws:
      NotFoundException - supersedingEventEnablerId, supersedingEventId, or referenceId not found or, supersedingEventEnablerId or referenceId not related to supersedingEventId
      NullArgumentException - supersedingEventEnablerId, supersedingEventId, or referenceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • moveSupersedingEventEnablerBehind

      void moveSupersedingEventEnablerBehind(Id supersedingEventEnablerId, Id supersedingEventId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Reorders superseding event enablers for a superseding event by moving the specified superseding event enabler behind a reference superseding event enabler.
      Parameters:
      supersedingEventEnablerId - the Id of a SupersedingEventEnabler
      supersedingEventId - the Id of a SupersedingEvent
      referenceId - the reference superseding event enabler Id
      Throws:
      NotFoundException - supersedingEventEnablerId, supersedingEventId, or referenceId not found or, supersedingEventEnablerId or referenceId not related to supersedingEventId
      NullArgumentException - supersedingEventEnablerId, supersedingEventId, or referenceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • orderSupersedingEventEnablers

      void orderSupersedingEventEnablers(Id[] supersedingEventEnablerIds, Id supersedingEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Reorders a set of superseding event enablers for a superseding event.
      Parameters:
      supersedingEventEnablerIds - the Ids for a set of SupersedingEventEnablerIds
      supersedingEventId - the Id of a SupersedingEvent
      Throws:
      NotFoundException - supersedingEventId not found or, an supersedingEventEnablerId not related to supersedingEventId
      NullArgumentException - supersedingEventEnablerIds or supersedingEventId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.