Interface ScheduleSlotAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ScheduleSlotBatchAdminSession
public interface ScheduleSlotAdminSession extends OsidSession

This session creates, updates, and deletes Schedule Slots . The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a ScheduleSlot , a ScheduleSlotForm is requested using getScheduleSlotFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned ScheduleSlotForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the ScheduleSlotForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ScheduleSlotForm corresponds to an attempted transaction.

For updates, ScheduleSlotForms are requested to the ScheduleSlot Id that is to be updated using getScheduleSlotFormForUpdate() . Similarly, the ScheduleSlotForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ScheduleSlotForm can only be used once for a successful update and cannot be reused.

The delete operations delete Schedule Slots . To unmap a ScheduleSlot from the current Calendar , the ScheduleSlotCalendarAssignmentSession should be used. These delete operations attempt to remove the ScheduleSlot itself thus removing it from all known Calendar catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

  • 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 associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canCreateScheduleSlots

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

    • canCreateScheduleSlotWithRecordTypes

      boolean canCreateScheduleSlotWithRecordTypes(Type[] scheduleSlotRecordTypes)
      Tests if this user can create a single ScheduleSlot using the desired record types. While CalendaringManager.getScheduleSlotRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific ScheduleSlot . Providing an empty array tests if a ScheduleSlot can be created with no records.
      Parameters:
      scheduleSlotRecordTypes - array of schedule slot record types
      Returns:
      true if ScheduleSlot creation using the specified record Types is supported, false otherwise
      Throws:
      NullArgumentException - scheduleSlotRecordTypes is null
      Compliance:
      mandatory - This method must be implemented.

    • getScheduleSlotFormForCreate

      ScheduleSlotForm getScheduleSlotFormForCreate(Type[] scheduleSlotRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the schedule slot form for creating new schedule slots. A new form should be requested for each create transaction.
      Parameters:
      scheduleSlotRecordTypes - array of schedule slot record types
      Returns:
      the schedule slot form
      Throws:
      NullArgumentException - scheduleSlotRecordTypes is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - unable to get form for requested record types
      Compliance:
      mandatory - This method must be implemented.

    • createScheduleSlot

      ScheduleSlot createScheduleSlot(ScheduleSlotForm scheduleSlotForm) throws OperationFailedException, PermissionDeniedException
      Creates a new ScheduleSlot .
      Parameters:
      scheduleSlotForm - the form for this ScheduleSlot
      Returns:
      the new ScheduleSlot
      Throws:
      IllegalStateException - scheduleSlotForm already used in a create transaction
      InvalidArgumentException - one or more of the form elements is invalid
      NullArgumentException - scheduleSlotForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - scheduleSlotForm did not originate from getScheduleSlotFormForCreate()
      Compliance:
      mandatory - This method must be implemented.

    • canUpdateScheduleSlots

      boolean canUpdateScheduleSlots()
      Tests if this user can update ScheduleSlots . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a ScheduleSlot will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
      Returns:
      false if schedule slot modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getScheduleSlotFormForUpdate

      ScheduleSlotForm getScheduleSlotFormForUpdate(Id scheduleSlotId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the schedule slot form for updating an existing schedule slot. A new schedule slot form should be requested for each update transaction.
      Parameters:
      scheduleSlotId - the Id of the ScheduleSlot
      Returns:
      the schedule slot form
      Throws:
      NotFoundException - scheduleSlotId is not found
      NullArgumentException - scheduleSlotId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • updateScheduleSlot

      void updateScheduleSlot(ScheduleSlotForm scheduleSlotForm) throws OperationFailedException, PermissionDeniedException
      Updates an existing schedule slot.
      Parameters:
      scheduleSlotForm - the form containing the elements to be updated
      Throws:
      IllegalStateException - scheduleSlotForm already used in an update transaction
      InvalidArgumentException - the form contains an invalid value
      NullArgumentException - scheduleSlotForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - scheduleSlotForm did not originate from getScheduleSlotFormForUpdate()
      Compliance:
      mandatory - This method must be implemented.

    • canDeleteScheduleSlots

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

    • deleteScheduleSlot

      void deleteScheduleSlot(Id scheduleSlotId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Deletes the ScheduleSlot identified by the given Id .
      Parameters:
      scheduleSlotId - the Id of the ScheduleSlot to delete
      Throws:
      NotFoundException - a ScheduleSlot was not found identified by the given Id
      NullArgumentException - scheduleSlotId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageScheduleSlotAliases

      boolean canManageScheduleSlotAliases()
      Tests if this user can manage Id aliases for ScheduleSlots . A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
      Returns:
      false if ScheduleSlot aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasScheduleSlot

      void aliasScheduleSlot(Id scheduleSlotId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an Id to a ScheduleSlot for the purpose of creating compatibility. The primary Id of the ScheduleSlot is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another schedule slot, it is reassigned to the given schedule slot Id .
      Parameters:
      scheduleSlotId - the Id of a ScheduleSlot
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - scheduleSlotId not found
      NullArgumentException - scheduleSlotId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.