Interface IssueProcessorEnablerOublietteAssignmentSession

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

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

  • Method Details

    • canAssignIssueProcessorEnablers

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

    • canAssignIssueProcessorEnablerToOubliette

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

    • getAssignableOublietteIdsForIssueProcessorEnabler

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

    • assignIssueProcessorEnablerToOubliette

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

    • unassignIssueProcessorEnablerFromOubliette

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

    • reassignIssueProcessorEnablerToOubliette

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