Interface JobConstrainerEnablerAdminSession

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

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

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

    • canCreateJobConstrainerEnabler

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

    • canCreateJobConstrainerEnablerWithRecordTypes

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

    • getJobConstrainerEnablerFormForCreate

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

    • createJobConstrainerEnabler

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

    • canUpdateJobConstrainerEnablers

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

    • getJobConstrainerEnablerFormForUpdate

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

    • updateJobConstrainerEnabler

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

    • canDeleteJobConstrainerEnablers

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

    • deleteJobConstrainerEnabler

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

    • canManageJobConstrainerEnablerAliases

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

    • aliasJobConstrainerEnabler

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