Interface AuditProcessorEnablerAdminSession

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

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

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

The delete operations delete AuditProcessorEnablers . To unmap an AuditProcessorEnabler from the current Inquest , the AuditProcessorEnablerInquestAssignmentSession should be used. These delete operations attempt to remove the AuditProcessorEnabler 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.

    • canCreateAuditProcessorEnablers

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

    • canCreateAuditProcessorEnablerWithRecordTypes

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

    • getAuditProcessorEnablerFormForCreate

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

    • createAuditProcessorEnabler

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

    • canUpdateAuditProcessorEnablers

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

    • getAuditProcessorEnablerFormForUpdate

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

    • updateAuditProcessorEnabler

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

    • canDeleteAuditProcessorEnablers

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

    • deleteAuditProcessorEnabler

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

    • canManageAuditProcessorEnablerAliases

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

    • aliasAuditProcessorEnabler

      void aliasAuditProcessorEnabler(Id auditProcessorEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an Id to an AuditProcessorEnabler for the purpose of creating compatibility. The primary Id of the AuditProcessorEnabler 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 enabler, it is reassigned to the given audit processor enabler Id .
      Parameters:
      auditProcessorEnablerId - the Id of an AuditProcessorEnabler
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - auditProcessorEnablerId not found
      NullArgumentException - auditProcessorEnablerId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.