Interface IssueConstrainerOublietteAssignmentSession

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

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

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

  • Method Details

    • canAssignIssueConstrainers

      boolean canAssignIssueConstrainers()
      Tests if this user can alter issue constrainer/oubliette 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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canAssignIssueConstrainerToOubliette

      boolean canAssignIssueConstrainerToOubliette(Id oublietteId)
      Tests if this user can alter issue constrainer/oubliette 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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Parameters:
      oublietteId - the Id of the Oubliette
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - oublietteId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableOublietteIds

      IdList getAssignableOublietteIds(Id oublietteId) throws OperationFailedException
      Gets a list of oubliettes including and under the given oubliette node in which any issue constrainer can be assigned.
      Parameters:
      oublietteId - the Id of the Oubliette
      Returns:
      list of assignable oubliette Ids
      Throws:
      NullArgumentException - oublietteId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableOublietteIdsForIssueConstrainer

      IdList getAssignableOublietteIdsForIssueConstrainer(Id oublietteId, Id issueConstrainerId) throws OperationFailedException
      Gets a list of oubliettes including and under the given oubliette node in which a specific issue constrainer can be assigned.
      Parameters:
      oublietteId - the Id of the Oubliette
      issueConstrainerId - the Id of the IssueConstrainer
      Returns:
      list of assignable oubliette Ids
      Throws:
      NullArgumentException - oublietteId or issueConstrainerId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignIssueConstrainerToOubliette

      void assignIssueConstrainerToOubliette(Id issueConstrainerId, Id oublietteId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing IssueConstrainer to an oublietteId .
      Parameters:
      issueConstrainerId - the Id of the IssueConstrainer
      oublietteId - the Id of the Oubliette
      Throws:
      AlreadyExistsException - issueConstrainerId is already assigned to oublietteId
      NotFoundException - issueConstrainerId or oublietteId not found
      NullArgumentException - issueConstrainerId or oublietteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignIssueConstrainerFromOubliette

      void unassignIssueConstrainerFromOubliette(Id issueConstrainerId, Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes an IssueConstrainer from an Oubliette .
      Parameters:
      issueConstrainerId - the Id of the IssueConstrainer
      oublietteId - the Id of the Oubliette
      Throws:
      NotFoundException - issueConstrainerId or oublietteId not found or issueConstrainerId not assigned to oublietteId
      NullArgumentException - issueConstrainerId or oublietteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignIssueConstrainerToOubliette

      void reassignIssueConstrainerToOubliette(Id issueConstrainerId, Id fromOublietteId, Id toOublietteId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves an IssueConstrainer from one Oubliette to another. Mappings to other Oubliettes are unaffected.
      Parameters:
      issueConstrainerId - the Id of the IssueConstrainer
      fromOublietteId - the Id of the current Oubliette
      toOublietteId - the Id of the destination Oubliette
      Throws:
      AlreadyExistsException - issueConstrainerId already assigned to toOublietteId
      NotFoundException - issueConstrainerId, fromOublietteId , or toOublietteeId not found or issueConstrainerId not mapped to fromOublietteId
      NullArgumentException - issueConstrainerId, fromOublietteId , or toOublietteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.