Interface IssueConstrainerOublietteSession

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

This session provides methods to retrieve IssueConstrai ner to Oubliette mappings. An IssueConstrai ner may appear in multiple Oubliette objects. Each oubliette may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition

  • Method Details

    • canLookupIssueConstrainerOublietteMappings

      boolean canLookupIssueConstrainerOublietteMappings()
      Tests if this user can perform lookups of issue constrainer/oubliette mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeIssueConstrainerOublietteView

      void useComparativeIssueConstrainerOublietteView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryIssueConstrainerOublietteView

      void usePlenaryIssueConstrainerOublietteView()
      A complete view of the IssueConstrainer and Oubliette returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • getIssueConstrainerIdsByOubliette

      IdList getIssueConstrainerIdsByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of IssueConstrainerIds associated with an Oubliette .
      Parameters:
      oublietteId - Id of the Oubliette
      Returns:
      list of related issue constrainer Ids
      Throws:
      NotFoundException - oublietteId is not found
      NullArgumentException - oublietteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainersByOubliette

      IssueConstrainerList getIssueConstrainersByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of IssueConstrainers associated with an Oubliette .
      Parameters:
      oublietteId - Id of the Oubliette
      Returns:
      list of related issue constrainers
      Throws:
      NotFoundException - oublietteId is not found
      NullArgumentException - oublietteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainerIdsByOubliettes

      IdList getIssueConstrainerIdsByOubliettes(IdList oublietteIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of IssueConstrainerIds corresponding to a list of Oubliettes .
      Parameters:
      oublietteIds - list of oubliette Ids
      Returns:
      list of issue constrainer Ids
      Throws:
      NullArgumentException - oublietteIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainersByOubliettes

      IssueConstrainerList getIssueConstrainersByOubliettes(IdList oublietteIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of IssueConstrainer corresponding to a list of Oubliettes .
      Parameters:
      oublietteIds - list of oubliette Ids
      Returns:
      list of issue constrainer Ids
      Throws:
      NullArgumentException - oublietteIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getOublietteIdsByIssueConstrainer

      IdList getOublietteIdsByIssueConstrainer(Id issueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Oubliette Ids mapped to an IssueConstrainer .
      Parameters:
      issueConstrainerId - Id of an IssueConstrainer
      Returns:
      list of oubliette Ids
      Throws:
      NotFoundException - issueConstrainerId is not found
      NullArgumentException - issueConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getOubliettesByIssueConstrainer

      OublietteList getOubliettesByIssueConstrainer(Id issueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Oubliettes mapped to an IssueConstrainer .
      Parameters:
      issueConstrainerId - Id of an IssueConstrainer
      Returns:
      list of oubliettes
      Throws:
      NotFoundException - issueConstrainerId is not found
      NullArgumentException - issueConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.