Interface JobConstrainerEnablerFoundryAssignmentSession

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

This session provides methods to re-assign JobConstrainerEnabler to Foundry mappings. A JobConstrainerEnabler may appear in multiple Foundry objects and removing the last reference to a JobConstrainerEnabler is the equivalent of deleting it. Each Foundry may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a JobConstrainerEnabler to another Foundry is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignJobConstrainerEnablers

      boolean canAssignJobConstrainerEnablers()
      Tests if this user can alter job constrainer enabler/foundry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canAssignJobConstrainerEnablersToFoundry

      boolean canAssignJobConstrainerEnablersToFoundry(Id foundryId)
      Tests if this user can alter job constrainer enabler/foundry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Parameters:
      foundryId - the Id of the Foundry
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - foundryId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableFoundryIds

      IdList getAssignableFoundryIds(Id foundryId) throws OperationFailedException
      Gets a list of foundries including and under the given foundry node in which any job constrainer enabler can be assigned.
      Parameters:
      foundryId - the Id of the Foundry
      Returns:
      list of assignable foundry Ids
      Throws:
      NullArgumentException - foundryId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableFoundryIdsForJobConstrainerEnabler

      IdList getAssignableFoundryIdsForJobConstrainerEnabler(Id foundryId, Id jobConstrainerEnablerId) throws OperationFailedException
      Gets a list of foundries including and under the given foundry node in which a specific job constrainer enabler can be assigned.
      Parameters:
      foundryId - the Id of the Foundry
      jobConstrainerEnablerId - the Id of the JobConstrainerEnabler
      Returns:
      list of assignable foundry Ids
      Throws:
      NullArgumentException - foundryId or jobConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignJobConstrainerEnablerToFoundry

      void assignJobConstrainerEnablerToFoundry(Id jobConstrainerEnablerId, Id foundryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing JobConstrainerEnabler to a Foundry .
      Parameters:
      jobConstrainerEnablerId - the Id of the JobConstrainerEnabler
      foundryId - the Id of the Foundry
      Throws:
      AlreadyExistsException - jobConstrainerEnablerId is already assigned to foundryId
      NotFoundException - jobConstrainerEnablerId or foundryId not found
      NullArgumentException - jobConstrainerEnablerId or foundryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignJobConstrainerEnablerFromFoundry

      void unassignJobConstrainerEnablerFromFoundry(Id jobConstrainerEnablerId, Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a JobConstrainerEnabler from a Foundry .
      Parameters:
      jobConstrainerEnablerId - the Id of the JobConstrainerEnabler
      foundryId - the Id of the Foundry
      Throws:
      NotFoundException - jobConstrainerEnablerId or foundryId not found or jobConstrainerEnablerId not assigned to foundryId
      NullArgumentException - jobConstrainerEnablerId or foundryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignJobConstrainerEnablerToFoundry

      void reassignJobConstrainerEnablerToFoundry(Id jobConstrainerEnablerId, Id fromFoundryId, Id toFoundryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves a JobConstrainerEnabler from one Foundry to another. Mappings to other Foundries are unaffected.
      Parameters:
      jobConstrainerEnablerId - the Id of the JobConstrainerEnabler
      fromFoundryId - the Id of the current Foundry
      toFoundryId - the Id of the destination Foundry
      Throws:
      AlreadyExistsException - jobConstrainerEnablerId already assigned to toFoundryId
      NotFoundException - jobConstrainerEnablerId, fromFoundryId , or toFoundryId not found or jobConstrainerEnablerId not mapped to fromFoundryId
      NullArgumentException - jobConstrainerEnablerId, fromFoundryId , or toFoundryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.