Interface FunctionLookupSession

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

This session provides methods for retrieving Function objects.

This session defines two sets of views which offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete and ordered result set or is an error condition
  • isolated vault view: All function methods in this session operate, retrieve and pertain to functions defined explicitly in the current vault. Using an isolated view is useful for managing functions with the FunctionAdminSession .
  • federated vault view: All function methods in this session operate, retrieve and pertain to all functions defined in this vault and any other vaults implicitly available in this vault through vault inheritence.
  • active function view: All function lookup methods return active functions.
  • any status function view: Active and inactive functions are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there a particular element is inaccessible. For example, a hierarchy output can be plugged into a lookup method to retrieve all objects known to a hierarchy, but it may not be necessary to break execution if a node from the hierarchy no longer exists. However, some administrative applications may need to know whether it had retrieved an entire set of objects and may sacrifice some interoperability for the sake of precision.

Functions may have an additional records indicated by their respective record types.

  • 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.

    • canLookupFunctions

      boolean canLookupFunctions()
      Tests if this user can perform Function 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.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeFunctionView

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

    • usePlenaryFunctionView

      void usePlenaryFunctionView()
      A complete view of the Function 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 functions 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.

    • useActiveFunctionView

      void useActiveFunctionView()
      Only active functions are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusFunctionView

      void useAnyStatusFunctionView()
      Active and inactive functions are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getFunction

      Function getFunction(Id functionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Function specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Function may have a different Id than requested, such as the case where a duplicate Id was assigned to a Function and retained for compatibility.
      Parameters:
      functionId - the Id of the Function to retrieve
      Returns:
      the returned Function
      Throws:
      NotFoundException - no Function found with the given Id
      NullArgumentException - functionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFunctionsByIds

      FunctionList getFunctionsByIds(IdList functionIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a FunctionList corresponding to the given IdList . In plenary mode, the returned list contains all of the functions 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 Functions may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      functionIds - the list of Ids to retrieve
      Returns:
      the returned Function list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - functionIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFunctionsByGenusType

      FunctionList getFunctionsByGenusType(Type functionGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a FunctionList corresponding to the given function genus Type which does not include functions of genus types derived from the specified Type .In plenary mode, the returned list contains all known functions or an error results. Otherwise, the returned list may contain only those functions that are accessible through this session.
      Parameters:
      functionGenusType - a function genus type
      Returns:
      the returned Function list
      Throws:
      NullArgumentException - functionGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFunctionsByParentGenusType

      FunctionList getFunctionsByParentGenusType(Type functionGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a FunctionList corresponding to the given function genus Type and include any additional functions with genus types derived from the specified Type .In plenary mode, the returned list contains all known functions or an error results. Otherwise, the returned list may contain only those functions that are accessible through this session.
      Parameters:
      functionGenusType - a function genus type
      Returns:
      the returned Function list
      Throws:
      NullArgumentException - functionGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFunctionsByRecordType

      FunctionList getFunctionsByRecordType(Type functionRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a FunctionList containing the given function record Type . In plenary mode, the returned list contains all known functions or an error results. Otherwise, the returned list may contain only those functions that are accessible through this session.
      Parameters:
      functionRecordType - a function record type
      Returns:
      the returned Function list
      Throws:
      NullArgumentException - functionRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFunctionsByQualifierHierarchy

      FunctionList getFunctionsByQualifierHierarchy(Id qualifierHierarchyId) throws OperationFailedException, PermissionDeniedException
      Gets a FunctionList for the given qualifier hierarchy. In plenary mode, the returned list contains all known functions or an error results. Otherwise, the returned list may contain only those functions that are accessible through this session.
      Parameters:
      qualifierHierarchyId - a qualifier hierarchy Id
      Returns:
      the returned Function list
      Throws:
      NullArgumentException - qualifierHierarchyId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFunctions

      FunctionList getFunctions() throws OperationFailedException, PermissionDeniedException
      Gets all Functions . In plenary mode, the returned list contains all known functions or an error results. Otherwise, the returned list may contain only those functions that are accessible through this session.
      Returns:
      a list of Functions
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.