ProficiencyQueryBean

Name ProficiencyQueryBean
Usage HandcarLearningService
getProficiencyNgramsInBank getProficienciesInBank
Type Complex

Description

A bean for querying a proficiency

OSID reference:
ProficiencyQuery

Structure Definition

ShortName Name Type Description Required? Read only? Implementation Notes
ids Ids StringList Ids to filter      
genusTypeIds Genus Type Ids StringList Ids of genus types to do the filtering      
keyword Keyword String Keyword or phrase used to query an object      
resourceIds Resource Ids StringList Query on ids of resources to which this proficiency is attached      
objectiveIds Objective Ids StringList Query on objectives that the activities are attached      
levelIds Level Ids StringList Query on ids of levels to which this proficiency is attached      
startCompletion Minimum Completion BigDecimal Query on the minimum completion level, inclusive      
endCompletion Minimum Completion BigDecimal Query on the maximum completion level, inclusive      
completionMatch Minimum Completion Boolean Indicates if the min/max completion should match if completion is within or not

Defaults to true		      
endReasonIds End Reason Ids StringList End reason ids to match      
effective Effective Boolean Finds objects that ARE effective or are NOT effective as of NOW      
startDateStartRange Start Date Start Range Date Queries the start date portion of the temporal specifying the beginning part of the range.      
startDateEndRange Start Date End Range Date Queries the start date portion of the temporal specifying the ending part of the range.      
startDateMatch Start Date Match Boolean Indicates the start date must be within the range specified (default is true) or outside the
range specified.

Default is true.		      
endDateStartRange End Date Start Range Date Queries the end date portion of the temporal specifying the beginning part of the range.      
endDateEndRange End Date End Range Date Queries the end date portion of the temporal specifying the ending part of the range.      
endDateMatch End Date Match Boolean Indicates the end date must be within the range specified (default is true) or outside the
range specified.

Default is true		      
addedBys Added Bys StringList Audit Trail Ids of people who added object to do the filtering      
addedOnStartDate Added On Start Date String Audit Trail start date to filter on when the object was created

Expected to be in one of the following formats:

  1. YYYY-MM-DDTHH:MM:SSZ

  2. YYYY-MM-DDTHH:MM:SS

  3. YYYY-MM-DDTHH:MM

  4. YYYY-MM-DDTHH

  5. YYYY-MM-DD
      
addedOnEndDate Added On End Date String Audit Trail end date to filter on when the object was created

Expected to be in one of the following formats:

  1. YYYY-MM-DDTHH:MM:SSZ

  2. YYYY-MM-DDTHH:MM:SS

  3. YYYY-MM-DDTHH:MM

  4. YYYY-MM-DDTHH

  5. YYYY-MM-DD
      
updatedBys Added On Start Date StringList Audit Trail ids of people who last updated the object      
updatedOnStartDate Updated On Start Date String Audit Trail start date to filter on when the object was last updated

Expected to be in one of the following formats:

  1. YYYY-MM-DDTHH:MM:SSZ

  2. YYYY-MM-DDTHH:MM:SS

  3. YYYY-MM-DDTHH:MM

  4. YYYY-MM-DDTHH

  5. YYYY-MM-DD
      
updatedOnEndDate Updated On End Date String Audit Trail end date to filter on when the object was last updated

Expected to be in one of the following formats:

  1. YYYY-MM-DDTHH:MM:SSZ

  2. YYYY-MM-DDTHH:MM:SS

  3. YYYY-MM-DDTHH:MM

  4. YYYY-MM-DDTHH

  5. YYYY-MM-DD
      
startAt Start At Integer The select row to start at before returning.

This defaults to 1 if not specified and will return starting at the first row.

Start At and Max Values are the final filters to be applied to a method that returns a list of
objects.		      
maxValues Maximum Values Integer Maximum number of values (objects) to return from the method

If used in conjunction with startAt ti can be used to perform paging.

Start At and Max Values are the final filters to be applied to a method that returns a list of
objects.		      

JSON Structure

{
     "type" : "ProficiencyQuery",
     "ids" : ["id", ...],
     "genusTypeIds" : ["id", ...],
     "keyword" : "XXXX",
     "resourceIds" : ["id", ...],
     "objectiveIds" : ["id", ...],
     "levelIds" : ["id", ...],
     "startCompletion" : startCompletion,
     "endCompletion" : endCompletion,
     "completionMatch" : true,
     "endReasonIds" : ["id", ...],
     "effective" : true,
     "startDateStartRange" : "YYYY-MM-DD",
     "startDateEndRange" : "YYYY-MM-DD",
     "startDateMatch" : true,
     "endDateStartRange" : "YYYY-MM-DD",
     "endDateEndRange" : "YYYY-MM-DD",
     "endDateMatch" : true,
     "addedBys" : ["XXXX", ...],
     "addedOnStartDate" : "YYYY-MM-DD",
     "addedOnEndDate" : "YYYY-MM-DD",
     "updatedBys" : ["XXXX", ...],
     "updatedOnStartDate" : "YYYY-MM-DD",
     "updatedOnEndDate" : "YYYY-MM-DD",
     "startAt" : 999,
     "maxValues" : 999
}