Interface IssueEnablerOublietteAssignmentSession

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

This session provides methods to re-assign IssueEnablers to Oubliette mappings. An IssueEnabler may appear in multiple Oubliette catalogs and removing the last reference to an IssueEnabler 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 IssueEnabler to another Oubliette is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignIssueEnablers

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

    • canAssignIssueEnablerToOubliette

      boolean canAssignIssueEnablerToOubliette(Id oublietteId)
      Tests if this user can alter issue enabler/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 enabler 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.

    • getAssignableOublietteIdsForIssueEnabler

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

    • assignIssueEnablerToOubliette

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

    • unassignIssueEnablerFromOubliette

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

    • reassignIssueEnablerToOubliette

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