Interface SequencingSession

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

This session provides methods to sequence the elements in a Chain.

Like all OsidSessions, SequencingSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getAntimatroidId

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

    • getAntimatroid

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

    • canSequence

      boolean canSequence()
      Tests if this user can sequence things. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.
      Returns:
      false if sequencing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • moveElementAhead

      void moveElementAhead(Id chainId, Id referenceId, Id id) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Moves an element ahead of a reference element in a chain.
      Parameters:
      chainId - the Id of the chain
      referenceId - the Id of the reference element
      id - the Id of the element to move ahead of referenceId
      Throws:
      NotFoundException - chainId, referenceId, or id not found, or referenceId or id is not related to chainId
      NullArgumentException - chainId, referenceId, or id is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • moveElementBehind

      void moveElementBehind(Id chainId, Id referenceId, Id id) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Moves an element beind a reference element in a chain.
      Parameters:
      chainId - the Id of the chain
      referenceId - the Id of the reference element
      id - the Id of the element to move behind of referenceId
      Throws:
      NotFoundException - parentId, referenceId, or id not found, or referenceId or id is not a child of parentId
      NullArgumentException - chainId, referenceId, or id is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • sequenceElements

      void sequenceElements(Id chainId, Id[] ids) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Sequences a set of elements in a chain.
      Parameters:
      chainId - the Id of the chain
      ids - the Id of the elements
      Throws:
      NotFoundException - chainId or an id not found, or an id is not related to chainId
      NullArgumentException - chainId or ids is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.