Interface ProcessEnablerAdminSession

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

This session creates and removes process enablers. The data for create and update is provided via the ProcessEnablerForm .

  • 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.

    • canCreateProcessEnabler

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

    • canCreateProcessEnablerWithRecordTypes

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

    • getProcessEnablerFormForCreate

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

    • createProcessEnabler

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

    • canUpdateProcessEnablers

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

    • getProcessEnablerFormForUpdate

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

    • updateProcessEnabler

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

    • canDeleteProcessEnablers

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

    • deleteProcessEnabler

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

    • canManageProcessEnablerAliases

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

    • aliasProcessEnabler

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