Interface ProcessProcessorEnablerAdminSession

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

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

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

The delete operations delete ProcessProcessorEnablers . To unmap a ProcessProcessorEnabler from the current Office , the ProcessProcessorEnablerOfficeAssignmentSession should be used. These delete operations attempt to remove the ProcessProcessorEnabler itself thus removing it from all known Office catalogs.

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

  • Method Details

    • getOfficeId

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

    • getOffice

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

    • canCreateProcessProcessorEnablers

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

    • canCreateProcessProcessorEnablerWithRecordTypes

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

    • getProcessProcessorEnablerFormForCreate

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

    • createProcessProcessorEnabler

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

    • canUpdateProcessProcessorEnablers

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

    • getProcessProcessorEnablerFormForUpdate

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

    • updateProcessProcessorEnabler

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

    • canDeleteProcessProcessorEnablers

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

    • deleteProcessProcessorEnabler

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

    • canManageProcessProcessorEnablerAliases

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

    • aliasProcessProcessorEnabler

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