Interface JobProcessorEnablerAdminSession

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

This session creates and removes job processor enablers. The data for create and update is provided via the JobProcessorEnablerForm .

  • Method Details

    • getFoundryId

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

    • getFoundry

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

    • canCreateJobProcessorEnabler

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

    • canCreateJobProcessorEnablerWithRecordTypes

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

    • getJobProcessorEnablerFormForCreate

      JobProcessorEnablerForm getJobProcessorEnablerFormForCreate(Type[] jobProcessorEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the job processor enabler form for creating new job processor enablers. A new form should be requested for each create transaction.
      Parameters:
      jobProcessorEnablerRecordTypes - array of job processor enabler record types
      Returns:
      the job processor enabler form
      Throws:
      NullArgumentException - jobProcessorEnablerRecordTypes is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - unable to get form with requested record types
      Compliance:
      mandatory - This method must be implemented.

    • createJobProcessorEnabler

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

    • canUpdateJobProcessorEnablers

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

    • getJobProcessorEnablerFormForUpdate

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

    • updateJobProcessorEnabler

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

    • canDeleteJobProcessorEnablers

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

    • deleteJobProcessorEnabler

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

    • canManageJobProcessorEnablerAliases

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

    • aliasJobProcessorEnabler

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