Interface AuditProcessorAdminSession

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

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

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

The delete operations delete AuditProcessors . To unmap an AuditProcessor from the current Inquest , the AuditProcessorInquestAssignmentSession should be used. These delete operations attempt to remove the AuditProcessor itself thus removing it from all known Inquest catalogs.

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

  • Method Details

    • getInquestId

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

    • getInquest

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

    • canCreateAuditProcessors

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

    • canCreateAuditProcessorWithRecordTypes

      boolean canCreateAuditProcessorWithRecordTypes(Type[] auditProcessorRecordTypes)
      Tests if this user can create a single AuditProcessor using the desired record types. While InquiryRulesManager.getAuditProcessorRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific AuditProcessor . Providing an empty array tests if an AuditProcessor can be cr eated with no records.
      Parameters:
      auditProcessorRecordTypes - array of audit processor record types
      Returns:
      true if AuditProcessor creation using the specified record Types is supported, false otherwise
      Throws:
      NullArgumentException - auditProcessorRecordTypes is null
      Compliance:
      mandatory - This method must be implemented.

    • getAuditProcessorFormForCreate

      AuditProcessorForm getAuditProcessorFormForCreate(Type[] auditProcessorRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the audit processor form for creating new audit processors. A new form should be requested for each create transaction.
      Parameters:
      auditProcessorRecordTypes - array of audit processor record types
      Returns:
      the audit processor form
      Throws:
      NullArgumentException - auditProcessorRecordTypes 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.

    • createAuditProcessor

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

    • canUpdateAuditProcessors

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

    • getAuditProcessorFormForUpdate

      AuditProcessorForm getAuditProcessorFormForUpdate(Id auditProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the audit processor form for updating an existing audit processor. A new audit processor form should be requested for each update transaction.
      Parameters:
      auditProcessorId - the Id of the AuditProcessor
      Returns:
      the audit processor form
      Throws:
      NotFoundException - auditProcessorId is not found
      NullArgumentException - auditProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • updateAuditProcessor

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

    • canDeleteAuditProcessors

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

    • deleteAuditProcessor

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

    • canManageAuditProcessorAliases

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

    • aliasAuditProcessor

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