Interface AuthorizationLookupSession

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

This session defines methods to search and retrieve Authorization mappings.

This lookup session defines two sets of views:

  • isolated vault view: All authorization methods in this session operate, retrieve and pertain to Authorizations defined explicitly in the current Vault . Using an isolated view is useful for managing Authorizations with the AuthorizationAdminSession .
  • federated vault view; All authorization methods in this session operate, retrieve and pertain to all authorizations defined in this vault and any other authorizations implicitly available in this vault through vault inheritence.
  • effective authorization view: All authorization lookup methods return edges where the current dates falls in between the effective dates inclusive.
  • any effective authorization edge view: Authorizations of any effective date are returned.
  • explicit authorization view: All authorization methods in this session operate, retrieve and pertain to only those authorizations that have been explicitly defined and not derived from Resource groups or Qualifier hierarchies.
  • implicit authorization view; All authorization methods in this session operate, retrieve and pertain to all authorizations including those derived from Resource groups or Qualifier hierarchies.

The methods useExplicitAuthorizationView() and useImplicitAuthorizationView() behave as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getVaultId

      Id getVaultId()
      Gets the Vault Id associated with this session.
      Returns:
      the Vault Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getVault

      Vault getVault() throws OperationFailedException, PermissionDeniedException
      Gets the Vault associated with this session.
      Returns:
      the Vault associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupAuthorizations

      boolean canLookupAuthorizations()
      Tests if this user can perform authorization lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeAuthorizationView

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

    • usePlenaryAuthorizationView

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

    • useFederatedVaultView

      void useFederatedVaultView()
      Federates the view for methods in this session. A federated view will include authorizations in vaults which are children of this vault in the vault hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedVaultView

      void useIsolatedVaultView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this vault only.
      Compliance:
      mandatory - This method is must be implemented.

    • useEffectiveAuthorizationView

      void useEffectiveAuthorizationView()
      Only authorizations whose effective dates are current are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyEffectiveAuthorizationView

      void useAnyEffectiveAuthorizationView()
      All authorizations of any effective dates are returned by all methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useImplicitAuthorizationView

      void useImplicitAuthorizationView()
      Sets the view for methods in this session to implicit authorizations. An implicit view will include authorizations derived from other authorizations as a result of the Qualifier hierarchy or Resource expansion. This method is the opposite of explicitAuthorizationView() .
      Compliance:
      mandatory - This method is must be implemented.

    • useExplicitAuthorizationView

      void useExplicitAuthorizationView()
      Sets the view for methods in this session to explicit authorizations. An explicit view includes only those authorizations that were explicitly defined and not implied. This method is the opposite of implicitAuthorizationView() .
      Compliance:
      mandatory - This method is must be implemented.

    • getAuthorization

      Authorization getAuthorization(Id authorizationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Authorization specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Authorization may have a different Id than requested, such as the case where a duplicate Id was assigned to an Authorization and retained for compatibility. In effective mode, authorizations are returned that are currently effective or a NOT_FOUND may result. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      authorizationId - the Id of the Authorization to retrieve
      Returns:
      the returned Authorization
      Throws:
      NotFoundException - no Authorization found with the given Id
      NullArgumentException - authorizationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsByIds

      AuthorizationList getAuthorizationsByIds(IdList authorizationIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an AuthorizationList corresponding to the given IdLis t. In plenary mode, the returned list contains all of the authorizations specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Authorizations may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      authorizationIds - the list of Ids to retrieve
      Returns:
      the returned Authorization list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - authorizationIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsByGenusType

      AuthorizationList getAuthorizationsByGenusType(Type authorizationGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an AuthorizationList corresponding to the given authorization genus Type which does not include authorizations of genus types derived from the specified Type . In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      authorizationGenusType - an authorization genus type
      Returns:
      the returned Authorization list
      Throws:
      NullArgumentException - authorizationGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsByParentGenusType

      AuthorizationList getAuthorizationsByParentGenusType(Type authorizationGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an AuthorizationList corresponding to the given authorization genus Type and include authorizations of genus types derived from the specified Type . In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      authorizationGenusType - an authorization genus type
      Returns:
      the returned Authorization list
      Throws:
      NullArgumentException - authorizationGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsByRecordType

      AuthorizationList getAuthorizationsByRecordType(Type authorizationRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an AuthorizationList containing the given authorization record Type . In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      authorizationRecordType - an authorization record type
      Returns:
      the returned Authorization list
      Throws:
      NullArgumentException - authorizationRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsOnDate

      AuthorizationList getAuthorizationsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AuthorizationList effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      from - starting date
      to - ending date
      Returns:
      the returned Authorization list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForResource

      AuthorizationList getAuthorizationsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a list of Authorizations associated with a given resource. Authorizations related to the given resource, including those related through an Agent , are returned. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Authorization list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForResourceOnDate

      AuthorizationList getAuthorizationsForResourceOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AuthorizationList effective during the entire given date range inclusive but not confined to the date range. Authorizations related to the given resource, including those related through an Agent , are returned. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      resourceId - a resource Id
      from - starting date
      to - ending date
      Returns:
      the returned Authorization list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - resourceId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForAgent

      AuthorizationList getAuthorizationsForAgent(Id agentId) throws OperationFailedException, PermissionDeniedException
      Gets a list of Authorizations associated with a given agent. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      agentId - an agent Id
      Returns:
      the returned Authorization list
      Throws:
      NullArgumentException - agentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForAgentOnDate

      AuthorizationList getAuthorizationsForAgentOnDate(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AuthorizationList for the given agent and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      agentId - an agent Id
      from - starting date
      to - ending date
      Returns:
      the returned Authorization list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - agentId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForFunction

      AuthorizationList getAuthorizationsForFunction(Id functionId) throws OperationFailedException, PermissionDeniedException
      Gets a list of Authorizations associated with a given function. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      functionId - a function Id
      Returns:
      the returned Authorization list
      Throws:
      NullArgumentException - functionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForFunctionOnDate

      AuthorizationList getAuthorizationsForFunctionOnDate(Id functionId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AuthorizationList for the given function and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      functionId - a function Id
      from - starting date
      to - ending date
      Returns:
      the returned Authorization list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - functionId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForResourceAndFunction

      AuthorizationList getAuthorizationsForResourceAndFunction(Id resourceId, Id functionId) throws OperationFailedException, PermissionDeniedException
      Gets a list of Authorizations associated with a given resource. Authorizations related to the given resource, including those related through an Agent , are returned. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      resourceId - a resource Id
      functionId - a function Id
      Returns:
      the returned Authorization list
      Throws:
      NullArgumentException - resourceId or functionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForResourceAndFunctionOnDate

      AuthorizationList getAuthorizationsForResourceAndFunctionOnDate(Id resourceId, Id functionId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AuthorizationList effective during the entire given date range inclusive but not confined to the date range. Authorizations related to the given resource, including those related through an Agent , are returned. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      resourceId - a resource Id
      functionId - a function Id
      from - starting date
      to - ending date
      Returns:
      the returned Authorization list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - resourceId, functionId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForAgentAndFunction

      AuthorizationList getAuthorizationsForAgentAndFunction(Id agentId, Id functionId) throws OperationFailedException, PermissionDeniedException
      Gets a list of Authorizations associated with a given agent. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      agentId - an agent Id
      functionId - a function Id
      Returns:
      the returned Authorization list
      Throws:
      NullArgumentException - agentId or functionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForAgentAndFunctionOnDate

      AuthorizationList getAuthorizationsForAgentAndFunctionOnDate(Id agentId, Id functionId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AuthorizationList for the given agent and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      agentId - an agent Id
      functionId - a function Id
      from - starting date
      to - ending date
      Returns:
      the returned Authorization list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - agentId, functionId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForQualifier

      AuthorizationList getAuthorizationsForQualifier(Id qualifierId) throws OperationFailedException, PermissionDeniedException
      Gets a list of Authorizations associated with a given qualifier. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      qualifierId - a qualifier Id
      Returns:
      the returned Authorization list
      Throws:
      NullArgumentException - qualifierId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForQualifierOnDate

      AuthorizationList getAuthorizationsForQualifierOnDate(Id qualifierId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AuthorizationList for the given qualifier and effective during the entire given date range inclusive but not confined to the date range In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      qualifierId - a qualifier Id
      from - starting date
      to - ending date
      Returns:
      the returned Authorization list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - qualifierId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForResourceAndQualifier

      AuthorizationList getAuthorizationsForResourceAndQualifier(Id resourceId, Id qualifierId) throws OperationFailedException, PermissionDeniedException
      Gets a list of Authorizations associated with a given resource and qualifier. Authorizations related to the given resource, including those related through an Agent , are returned. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      resourceId - a resource Id
      qualifierId - a qualifier Id
      Returns:
      the returned Authorization list
      Throws:
      NullArgumentException - resourceId or qualifierId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForResourceAndQualifierOnDate

      AuthorizationList getAuthorizationsForResourceAndQualifierOnDate(Id resourceId, Id qualifierId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AuthorizationList for the given resource and qualifier and effective during the entire given date range inclusive but not confined to the date range. Authorizations related to the given resource, including those related through an Agent , are returned. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      resourceId - a resource Id
      qualifierId - a qualifierId Id
      from - starting date
      to - ending date
      Returns:
      the returned Authorization list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - resourceId, qualifierId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForAgentAndQualifier

      AuthorizationList getAuthorizationsForAgentAndQualifier(Id agentId, Id qualifierId) throws OperationFailedException, PermissionDeniedException
      Gets a list of Authorizations associated with a given agent and qualifier. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      agentId - an agent Id
      qualifierId - a qualifier Id
      Returns:
      the returned Authorization list
      Throws:
      NullArgumentException - agentId or qualifierId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsForAgentAndQualifierOnDate

      AuthorizationList getAuthorizationsForAgentAndQualifierOnDate(Id agentId, Id qualifierId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AuthorizationList for the given agent and qualifier and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      agentId - an agent Id
      qualifierId - a qualifierId Id
      from - starting date
      to - ending date
      Returns:
      the returned Authorization list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - agentId, qualifierId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getExplicitAuthorization

      Authorization getExplicitAuthorization(Id authorizationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the explicit Authorization that generated the given implicit authorization. If the given Authorization is explicit, then the same Authorization is returned. In effective mode, authorizations are returned that are currently effective or a NOT_FOUND may result. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Parameters:
      authorizationId - an authorization
      Returns:
      the explicit Authorization
      Throws:
      NotFoundException - authorizationId is not found
      NullArgumentException - authorizationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizations

      AuthorizationList getAuthorizations() throws OperationFailedException, PermissionDeniedException
      Geta all Authorizations . In plenary mode, the returned list contains all known authorizations or an error results. Otherwise, the returned list may contain only those authorizations that are accessible through this session. In effective mode, authorizations are returned that are currently effective. In any effective mode, active authorizations and those currently expired are returned. In explicit mode, only explicitly managed Authorizations are returned. In implicit mode, all Authorizations including those derived from Resources and the Qualifier hierarchy are returned.
      Returns:
      a list of Authorizations
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.