Interface AgendaAdminSession

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

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

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

The delete operations delete Agendas . To unmap an Agenda from the current Engine , the AgendaEngineAssignmentSession should be used. These delete operations attempt to remove the Agenda itself thus removing it from all known Engine catalogs.

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

  • Method Details

    • getEngineId

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

    • getEngine

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

    • canCreateAgendas

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

    • canCreateAgendaWithRecordTypes

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

    • getAgendaFormForCreate

      AgendaForm getAgendaFormForCreate(Type[] agendaRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the agenda form for creating new agendas. A new form should be requested for each create transaction.
      Parameters:
      agendaRecordTypes - array of agenda record types
      Returns:
      the agenda form
      Throws:
      NullArgumentException - agendaRecordTypes 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.

    • createAgenda

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

    • canUpdateAgendas

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

    • getAgendaFormForUpdate

      AgendaForm getAgendaFormForUpdate(Id agendaId) throws NotFoundException, OperationFailedException
      Gets the agenda form for updating an existing agenda. A new agenda form should be requested for each update transaction.
      Parameters:
      agendaId - the Id of the Agenda
      Returns:
      the agenda form
      Throws:
      NotFoundException - agendaId is not found
      NullArgumentException - agendaId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • updateAgenda

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

    • canDeleteAgendas

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

    • deleteAgenda

      void deleteAgenda(Id agendaId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Deletes an Agenda .
      Parameters:
      agendaId - the Id of the Agenda to remove
      Throws:
      NotFoundException - agendaId not found
      NullArgumentException - agendaId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageAgendaAliases

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

    • aliasAgenda

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