Interface ActionEnablerSystemAssignmentSession

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

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

Adding a reference of an ActionEnabler to another System is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignActionEnablers

      boolean canAssignActionEnablers()
      Tests if this user can alter action enabler/system 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.

    • canAssignActionEnablersToSystem

      boolean canAssignActionEnablersToSystem(Id systemId)
      Tests if this user can alter action enabler/system 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:
      systemId - the Id of the System
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - systemId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableSystemIds

      IdList getAssignableSystemIds(Id systemId) throws OperationFailedException
      Gets a list of systems including and under the given system node in which any action enabler can be assigned.
      Parameters:
      systemId - the Id of the System
      Returns:
      list of assignable system Ids
      Throws:
      NullArgumentException - systemId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableSystemIdsForActionEnabler

      IdList getAssignableSystemIdsForActionEnabler(Id systemId, Id actionEnablerId) throws OperationFailedException
      Gets a list of systems including and under the given system node in which a specific action enabler can be assigned.
      Parameters:
      systemId - the Id of the System
      actionEnablerId - the Id of the ActionEnabler
      Returns:
      list of assignable system Ids
      Throws:
      NullArgumentException - systemId or actionEnablerId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignActionEnablerToSystem

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

    • unassignActionEnablerFromSystem

      void unassignActionEnablerFromSystem(Id actionEnablerId, Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes an ActionEnabler from a System .
      Parameters:
      actionEnablerId - the Id of the ActionEnabler
      systemId - the Id of the System
      Throws:
      NotFoundException - actionEnablerId or systemId not found or actionEnablerId already assigned to systemId
      NullArgumentException - actionEnablerId or systemId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignActionEnablerToSystem

      void reassignActionEnablerToSystem(Id actionEnablerId, Id fromSystemId, Id toSystemId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves an ActionEnabler from one System to another. Mappings to other Systems are unaffected.
      Parameters:
      actionEnablerId - the Id of the ActionEnabler
      fromSystemId - the Id of the current System
      toSystemId - the Id of the destination System
      Throws:
      AlreadyExistsException - actionEnablerId already assigned to toSystemId
      NotFoundException - actionEnablerId, fromSystemId , or toSystemId not found or actionEnablerId not mapped to fromSystemId
      NullArgumentException - actionEnablerId, fromSystemId , or toSystemId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.