Interface IssueProcessorAdminSession

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

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

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

The delete operations delete IssueProcessors . To unmap an IssueProcessor from the current Oubliette , the IssueProcessorOublietteeAssignmentSessio n should be used. These delete operations attempt to remove the IssueProcessor 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.

    • canCreateIssueProcessors

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

    • canCreateIssueProcessorWithRecordTypes

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

    • getIssueProcessorFormForCreate

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

    • createIssueProcessor

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

    • canUpdateIssueProcessors

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

    • getIssueProcessorFormForUpdate

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

    • updateIssueProcessor

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

    • canDeleteIssueProcessors

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

    • deleteIssueProcessor

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

    • canManageIssueProcessorAliases

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

    • aliasIssueProcessor

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