Interface RealmLookupSession

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

This session provides methods for retrieving Realm objects. The Realm represents a collection of Persons .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

  • Method Details

    • canLookupRealms

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

    • useComparativeRealmView

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

    • usePlenaryRealmView

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

    • getRealm

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

    • getRealmsByIds

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

    • getRealmsByGenusType

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

    • getRealmsByParentGenusType

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

    • getRealmsByRecordType

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

    • getRealmsByProvider

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

    • getRealms

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