Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Our final goal should be to pack enough logic into the provider so that the consumer does not need to know any details about the OsidContext (or searchProperties)manages as little state as possible. Preferably, there would only be one Out-of-Band agreement for the searchProperties that the consumer must follow - more on the guid approach to come...

Key

Description

Type

repositoryId

identifies which repository belongs to the user of this OsidContext

long, alpha-numeric String

xSessionId

necessary to identify a specific user and allow that user access to X-Server services

long, alpha-numeric String

xGroupNumber

identifies a result set created by submitting a query with the /wiki/spaces/SLIB/pages/2921168923 command. This number is necessary for asynchronous searches, retrieving results and pagination

short, numeric String

newSession

a flag indicating whether the user is starting a new search session or continuing with a previous one

short String ("true"/"false")

resultsPerPage

stores how many results are showed per page. Needed for paging through results.

java.lang.Integer

resultsCursor

stores which results are currently being displayed. Needed for 'next' and 'previous' paging options

java.lang.Integer

resultsTotal

total number of results

java.lang.Integer

asynchSearchFlag

flag indicating whether an asynchronous search should be performed

short String

sourceIds

a list of source identifiers representing which databases should be searched

java.util.List or multiple Strings

...