QueryByCriteria

Name QueryByCriteria
Usage ParameterRepositoryService RuleService GroupService IdentityService PermissionService ResponsibilityService RoleService CampusService CountryService CountyService PostalCodeService StateService AcademicCalendarService CourseOfferingService CourseOfferingSetService CourseRegistrationService CourseWaitlistService LprService LuiService LprRosterService AppointmentService AtpService CommentService FeeService HoldService OrganizationService PopulationService ProcessService RoomService SchedulingService LearningObjectiveService
findParameters findRules findRuleTemplates findGroupIds findGroups findGroupMembers findEntityDefaults findEntities findPrincipals findPermissions findPermissionTemplates findResponsibilities findResponsibilityTemplates findRoles findRoleMemberships findRoleMembers findDelegateMembers findCampuses findCampusTypes findCountries findCounties findPostalCodes findStates searchForAcademicCalendarIds searchForAcademicCalendars searchForHolidayCalendarIds searchForHolidayCalendars searchForTermIds searchForTerms searchForKeyDateIds searchForKeyDates searchForAcalEventIds searchForAcalEvents searchForHolidayIds searchForHolidays searchForCourseOfferings searchForCourseOfferingIds searchForActivityOfferings searchForActivityOfferingIds searchForRegistrationGroups searchForRegistrationGroupIds searchForSeatpoolDefinitions searchForSeatpoolDefinitionIds searchForSocRolloverResultIds searchForSocRolloverResults searchForCourseRegistrationIds searchForCourseRegistrations searchForActivityRegistrationIds searchForActivityRegistrations searchForRegistrationRequestIds searchForRegistrationRequests searchForCourseWaitlistEntries searchForCourseWaitlistEntryIds searchForLprIds searchForLprs searchForLprTransactions searchForLprTransactionIds searchForLuiIds searchForLuis searchForLuiLuiRelationIds searchForLuiLuiRelations searchForLuiCapacityIds searchForLuiCapacities searchForLprRosterIds searchForLprRosters searchForLprRosterEntryIds searchForLprRosterEntries searchForAppointmentIds searchForAppointments searchForAppointmentWindowIds searchForAppointmentWindows searchForAppointmentSlotIds searchForAppointmentSlots searchForAtpIds searchForAtps searchForAtpAtpRelationIds searchForAtpAtpRelations searchForMilestoneIds searchForMilestones searchForLifecycleKeys searchForLifecycles searchForStateKeys searchForStates searchForCommentIds searchForComments searchForTagIds searchForTags searchForFeeIds searchForFees searchForAppliedHoldIds searchForAppliedHolds searchForHoldIssueIds searchForHoldIssues searchForOrgIds searchForOrgs searchForOrgOrgRelationIds searchForOrgOrgRelations searchForOrgPersonRelationIds searchForOrgPersonRelations searchForOrgPositionRestrictionIds searchForOrgPositionRestrictions searchForPopulationIds searchForPopulations searchForPopulationRuleIds searchForPopulationRules searchForPopulationCategoryIds searchForPopulationCategories searchForProcessCategoryIds searchForProcessCategories searchForProcessKeys searchForProcess searchForCheckIds searchForChecks searchForInstructionIds searchForInstructions searchForRoomIds searchForRooms searchForBuildingIds searchForBuildings searchForRoomResponsibleOrgIds searchForRoomResponsibleOrgs searchForScheduleIds searchForSchedules searchForScheduleBatchIds searchForScheduleBatches searchForScheduleRequestIds searchForScheduleRequests searchForTimeSlotIds searchForTimeSlots searchForScheduleTransactionIds searchForScheduleTransactions searchForCourseIds searchForCourses searchForLoRepositoryKeys searchForLoRepositories searchForLoIds searchForLos searchForLoCategoryIds searchForLoCategories searchForLoLoRelationIds searchForLoLoRelations
PopulationRuleInfo
Type Complex

Description

Defines a criteria-based query. Consists of a {@link Predicate} definition
as well as a set of additional properties which control paging and other
aspects of the results which should be returned from the query.

In order to construct a new {@link QueryByCriteria}, the {@link Builder}
should be used. Use the {@link PredicateFactory} to construct
the predicate for use by the query.

This class specifies nothing regarding how the query will be executed.
It is expected that an instance will be constructed and then passed to code
which understands how to execute the desired query.

This class is mapped for use by JAXB and can therefore be used by clients
as part of remotable service definitions.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
predicate Predicate Predicate Returns the {@link Predicate} which will be used to execute the query.     One No  
startAtIndex Start At Index Integer Returns the optional zero-based "start" index for rows returned. When
this query is executed, this property should be read to determine the
first row which should be returned. If the given index is beyond the
end of the result set, then the resulting query should effectively
return no rows (as opposed to producing an index-based out of bounds
error). If the value is null, then the results should start with the
first row returned from the query.


Will never be less than 0

     One No  
maxResults Max Results Integer Returns the maximum number of results that this query is requesting
to receive. If null, then the query should return all rows, or as
many as it can. If the number request is larger than the number of
results then all results are returned.


Will never be less than 0

     One No  
countFlag Count Flag CountFlag Indicates whether or not a total row count should be returned with the
query. See {@link CountFlag} for more information on what each of these
flags means. This will never return null and defaults to
{@link CountFlag#NONE}.		 Required   One No