Interface AuthorizationEnablerVaultSession

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

This session provides methods to retrieve AuthorizationEnabler to Vault mappings. An AuthorizationEnabler may appear in multiple Vaults . Each vault 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

    • canLookupAuthorizationEnablerVaultMappings

      boolean canLookupAuthorizationEnablerVaultMappings()
      Tests if this user can perform lookups of authorization enabler/vault 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.

    • useComparativeAuthorizationEnablerVaultView

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

    • usePlenaryAuthorizationEnablerVaultView

      void usePlenaryAuthorizationEnablerVaultView()
      A complete view of the AuthorizationEnabler and Vault 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.

    • getAuthorizationEnablerIdsByVault

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

    • getAuthorizationEnablersByVault

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

    • getAuthorizationEnablerIdsByVaults

      IdList getAuthorizationEnablerIdsByVaults(IdList vaultIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of AuthorizationEnablerIds corresponding to a list of Vaults .
      Parameters:
      vaultIds - list of vault Ids
      Returns:
      list of authorization enabler Ids
      Throws:
      NullArgumentException - vaultIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationEnablersByVaults

      AuthorizationEnablerList getAuthorizationEnablersByVaults(IdList vaultIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of authorization enablers corresponding to a list of Vaults .
      Parameters:
      vaultIds - list of vault Ids
      Returns:
      list of authorization enablers
      Throws:
      NullArgumentException - vaultIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getVaultIdsByAuthorizationEnabler

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

    • getVaultsByAuthorizationEnabler

      VaultList getVaultsByAuthorizationEnabler(Id authorizationEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Vaults mapped to an AuthorizationEnabler .
      Parameters:
      authorizationEnablerId - Id of an AuthorizationEnabler
      Returns:
      list of vaults
      Throws:
      NotFoundException - authorizationEnablerId is not found
      NullArgumentException - authorizationEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.