Interface PositionLookupSession

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

This session defines methods for retrieving positions.

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
  • isolated realm view: All position methods in this session operate, retrieve and pertain to positions defined explicitly in the current realm. Using an isolated view is useful for managing positions with the PositionAdminSession .
  • federated realm view: All position lookup methods in this session operate, retrieve and pertain to all positions defined in this realm and any other realms implicitly available in this realm through realm inheritence.
  • effective position view: All position lookup methods return positions where the current date falls in between the effective dates inclusive.
  • any effective position view: Positions of any effective date are returned from methods.

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

  • Method Details

    • getRealmId

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

    • getRealm

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

    • canLookupPositions

      boolean canLookupPositions()
      Tests if this user can examine this realm. 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 these operations.
      Returns:
      false if realm reading methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativePositionView

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

    • usePlenaryPositionView

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

    • useFederatedRealmView

      void useFederatedRealmView()
      Federates the view for methods in this session. A federated view will include positions in realms which are children of this realm in the realm hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedRealmView

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

    • useEffectivePositionView

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

    • useAnyEffectivePositionView

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

    • getPosition

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

    • getPositionsByIds

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

    • getPositionsByGenusType

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

    • getPositionsByParentGenusType

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

    • getPositionsByRecordType

      PositionList getPositionsByRecordType(Type positionRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a PositionList containing the given position record Type . In plenary mode, the returned list contains all known positions or an error results. Otherwise, the returned list may contain only those positions that are accessible through this session. In effective mode, positions are returned that are currently effective. In any effective mode, effective positions and those currently expired are returned.
      Parameters:
      positionRecordType - a position record type
      Returns:
      the returned PositionList
      Throws:
      NullArgumentException - positionRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPositionsOnDate

      PositionList getPositionsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a PositionList effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known positions or an error results. Otherwise, the returned list may contain only those positions that are accessible through this session. In effective mode, positions are returned that are currently effective. In any effective mode, effective positions and those currently expired are returned.
      Parameters:
      from - start of date range
      to - end of date range
      Returns:
      the returned PositionList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPositionsForOrganization

      PositionList getPositionsForOrganization(Id organizationId) throws OperationFailedException, PermissionDeniedException
      Gets a PositionList for the given organization. In plenary mode, the returned list contains all known positions or an error results. Otherwise, the returned list may contain only those positions that are accessible through this session. In effective mode, positions are returned that are currently effective. In any effective mode, effective positions and those currently expired are returned.
      Parameters:
      organizationId - an organization Id
      Returns:
      the returned PositionList
      Throws:
      NullArgumentException - organizationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPositionsForOrganizationOnDate

      PositionList getPositionsForOrganizationOnDate(Id organizationId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a PositionList for an organizatoon 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 positions or an error results. Otherwise, the returned list may contain only those positions that are accessible through this session. In effective mode, positions are returned that are currently effective. In any effective mode, effective positions and those currently expired are returned.
      Parameters:
      organizationId - an organization Id
      from - start of date range
      to - end of date range
      Returns:
      a list of positions
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - organization, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPositions

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