Interface IssueConstrainerEnablerOublietteAssignmentSession

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

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

  • Method Details

    • canAssignIssueConstrainerEnablers

      boolean canAssignIssueConstrainerEnablers()
      Tests if this user can alter issue constrainer 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.

    • canAssignIssueConstrainerEnablerToOubliette

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

    • getAssignableOublietteIdsForIssueConstrainerEnabler

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

    • assignIssueConstrainerEnablerToOubliette

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

    • unassignIssueConstrainerEnablerFromOubliette

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

    • reassignIssueConstrainerEnablerToOubliette

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