Interface AuditConstrainerEnablerAdminSession

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

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

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

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

    • canCreateAuditConstrainerEnablers

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

    • canCreateAuditConstrainerEnablerWithRecordTypes

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

    • getAuditConstrainerEnablerFormForCreate

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

    • createAuditConstrainerEnabler

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

    • canUpdateAuditConstrainerEnablers

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

    • getAuditConstrainerEnablerFormForUpdate

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

    • updateAuditConstrainerEnabler

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

    • canDeleteAuditConstrainerEnablers

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

    • deleteAuditConstrainerEnabler

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

    • canManageAuditConstrainerEnablerAliases

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

    • aliasAuditConstrainerEnabler

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