Interface IssueConstrainerEnablerOublietteSession

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

This session provides methods to retrieve IssueConstrainerEnabler to Oubliette mappings. An IssueConstrainerEnabler may appear in multiple Oubliettes. Each oub liette 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

    • canLookupIssueConstrainerEnablerOublietteMappings

      boolean canLookupIssueConstrainerEnablerOublietteMappings()
      Tests if this user can perform lookups of issue constrainer enabler/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.

    • useComparativeIssueConstrainerEnablerOublietteView

      void useComparativeIssueConstrainerEnablerOublietteView()
      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.

    • usePlenaryIssueConstrainerEnablerOublietteView

      void usePlenaryIssueConstrainerEnablerOublietteView()
      A complete view of the IssueConstrainerEnabler 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.

    • getIssueConstrainerEnablerIdsByOubliette

      IdList getIssueConstrainerEnablerIdsByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of IssueConstrainerEnablerIds associated with an Oubliette .
      Parameters:
      oublietteId - Id of the Oubliette
      Returns:
      list of related issue constrainer enabler 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.

    • getIssueConstrainerEnablersByOubliette

      IssueConstrainerEnablerList getIssueConstrainerEnablersByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of IssueConstrainerEnablers associated with an Oubliette .
      Parameters:
      oublietteId - Id of the Oubliette
      Returns:
      list of related issue constrainer enablers
      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.

    • getIssueConstrainerEnablerIdsByOubliettes

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

    • getIssueConstrainerEnablersByOubliettes

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

    • getOublietteIdsByIssueConstrainerEnabler

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

    • getOubliettesByIssueConstrainerEnabler

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