Interface ProcessConstrainerEnablerAdminSession

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

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

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

The delete operations delete ProcessConstrainerEnablers . To unmap a ProcessConstrainerEnabler from the current Office , the ProcessConstrainerEnablerOfficeAssignmentSession should be used. These delete operations attempt to remove the ProcessConstrainerEnabler 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.

    • canCreateProcessConstrainerEnablers

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

    • canCreateProcessConstrainerEnablerWithRecordTypes

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

    • getProcessConstrainerEnablerFormForCreate

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

    • createProcessConstrainerEnabler

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

    • canUpdateProcessConstrainerEnablers

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

    • getProcessConstrainerEnablerFormForUpdate

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

    • updateProcessConstrainerEnabler

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

    • canDeleteProcessConstrainerEnablers

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

    • deleteProcessConstrainerEnabler

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

    • canManageProcessConstrainerEnablerAliases

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

    • aliasProcessConstrainerEnabler

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