Interface IssueProcessorEnablerAdminSession

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

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

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

The delete operations delete IssueProcessorEnablers . To unmap an IssueProcessorEnabler from the current Oubliette , the IssueProcessorEnablerOublietteAssignmentSession should be used. These delete operations attempt to remove the IssueProcessorEnabler itself thus removing it from all known Oubliette catalogs.

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

  • Method Details

    • getOublietteId

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

    • getOubliette

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

    • canCreateIssueProcessorEnablers

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

    • canCreateIssueProcessorEnablerWithRecordTypes

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

    • getIssueProcessorEnablerFormForCreate

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

    • createIssueProcessorEnabler

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

    • canUpdateIssueProcessorEnablers

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

    • getIssueProcessorEnablerFormForUpdate

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

    • updateIssueProcessorEnabler

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

    • canDeleteIssueProcessorEnablers

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

    • deleteIssueProcessorEnabler

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

    • canManageIssueProcessorEnablerAliases

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

    • aliasIssueProcessorEnabler

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