Interface CommissionEnablerFoundrySession

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

This session provides methods to retrieve CommissionEnabler to Foundry mappings. A CommissionEnabler may appear in multiple Foundry objects. Each foundry 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

    • canLookupCommissionEnablerFoundryMappings

      boolean canLookupCommissionEnablerFoundryMappings()
      Tests if this user can perform lookups of commission enabler/foundry 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 . This 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.

    • useComparativeCommissionEnablerFoundryView

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

    • usePlenaryCommissionEnablerFoundryView

      void usePlenaryCommissionEnablerFoundryView()
      A complete view of the CommissionEnabler and Foundry 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.

    • getCommissionEnablerIdsByFoundry

      IdList getCommissionEnablerIdsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of CommissionEnablerIds associated with a Foundry .
      Parameters:
      foundryId - Id of the Foundry
      Returns:
      list of related commission enabler Ids
      Throws:
      NotFoundException - foundryId is not found
      NullArgumentException - foundryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionEnablersByFoundry

      CommissionEnablerList getCommissionEnablersByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of commission enabler associated with a Foundry .
      Parameters:
      foundryId - Id of the Foundry
      Returns:
      list of related commission enablers
      Throws:
      NotFoundException - foundryId is not found
      NullArgumentException - foundryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionEnablerIdsByFoundries

      IdList getCommissionEnablerIdsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of CommissionEnablerIds corresponding to a list of Foundries .
      Parameters:
      foundryIds - list of foundry Ids
      Returns:
      list of commission enabler Ids
      Throws:
      NullArgumentException - foundryIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionEnablersByFoundries

      CommissionEnablerList getCommissionEnablersByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of commission enabler corresponding to a list of Foundries .
      Parameters:
      foundryIds - list of foundry Ids
      Returns:
      list of commission enablers
      Throws:
      NullArgumentException - foundryIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFoundryIdsByCommissionEnabler

      IdList getFoundryIdsByCommissionEnabler(Id commissionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Foundry Ids mapped to a CommissionEnabler .
      Parameters:
      commissionEnablerId - Id of a CommissionEnabler
      Returns:
      list of foundries
      Throws:
      NotFoundException - commissionEnablerId is not found
      NullArgumentException - commissionEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFoundrysByCommissionEnabler

      FoundryList getFoundrysByCommissionEnabler(Id commissionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Foundries mapped to a CommissionEnabler .
      Parameters:
      commissionEnablerId - Id of a CommissionEnabler
      Returns:
      list of foundries
      Throws:
      NotFoundException - commissionEnablerId is not found
      NullArgumentException - commissionEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.