Interface CyclicTimePeriodAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
CyclicTimePeriodBatchAdminSession
public interface CyclicTimePeriodAdminSession extends OsidSession

This session creates, updates, and deletes CyclicTimePeriods . 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 CyclicTimePeriod , a CyclicTimePeriodForm is requested using getCyclicTimePeriodFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned CyclicTimePeriodForm 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 CyclicTimePeriodForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each CyclicTimePeriodForm corresponds to an attempted transaction.

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

The delete operations delete CyclicTimePeriodForms. To unmap a CyclicTimePeriodFor from the current Calendar , the CyclicTimePeriodCalendarAssignmentSession should be used. These delete operations attempt to remove the CyclicTimePeriod 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.

    • canCreateCyclicTimePeriods

      boolean canCreateCyclicTimePeriods()
      Tests if this user can create CyclicTimePeriods . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a CyclicTimePeriod 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 CyclicTimePeriod creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateCyclicTimePeriodWithRecordTypes

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

    • getCyclicTimePeriodFormForCreate

      CyclicTimePeriodForm getCyclicTimePeriodFormForCreate(Type[] cyclicTimePeriodRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the cyclic time period form for creating new cyclic time periods. A new form should be requested for each create transaction.
      Parameters:
      cyclicTimePeriodRecordTypes - array of cyclic time period record types
      Returns:
      the cyclic time period form
      Throws:
      NullArgumentException - cyclicTimePeriodRecordTypes 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.

    • createCyclicTimePeriod

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

    • canUpdateCyclicTimePeriods

      boolean canUpdateCyclicTimePeriods()
      Tests if this user can update CyclicTimePeriods . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a CyclicTimePeriod 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 cyclic time period modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCyclicTimePeriodFormForUpdate

      CyclicTimePeriodForm getCyclicTimePeriodFormForUpdate(Id cyclicTimePeriodId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the cyclic time period form for updating an existing cyclic time period. A new cyclic time period form should be requested for each update transaction.
      Parameters:
      cyclicTimePeriodId - the Id of the CyclicTimePeriod
      Returns:
      the cyclic time period form
      Throws:
      NotFoundException - cyclicTimePeriodId is not found
      NullArgumentException - cyclicTimePeriodid is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • updateCyclicTimePeriod

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

    • canDeleteCyclicTimePeriods

      boolean canDeleteCyclicTimePeriods()
      Tests if this user can delete CyclicTimePeriods . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a CyclicTimePeriod 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 CyclicTimePeriod deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteCyclicTimePeriod

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

    • canManageCyclicTimePeriodAliases

      boolean canManageCyclicTimePeriodAliases()
      Tests if this user can manage Id aliases for CyclicTimePeriods . 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 CyclicTimePeriod aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasCyclicTimePeriod

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