AnsweredAssumed Answered

Custom Building block documentation contradiction Q4 2015

Question asked by rs0048203 on Jul 14, 2016
Latest reply on Aug 1, 2016 by scott.hurrey

getViewCoursesSearch documentation contradiction in Q4 2015

  Want to verify the following method call from a custom building block is indeed valid/invalid:

CourseSearch courseSearch = SearchHelper.getViewCoursesSearch( searchKey, searchOp, searchText, dateOp, calendar.getTime(),

serviceLevel, filterRowStatus, checkDomainEntitlement, displayIntegrated, checkEmarketPlaceEntitlement, startIndex, pageSize, sortCol, sortDir);

 

source code line in B2 rebuild:

CourseSearch search = SearchHelper.getViewCoursesSearch(searchKey,operator,value,dateOp,date,serviceLevel,false,false,false,false,true,pageNum,pageSize,key,sortDir);

 

Class CourseSearch Documentation indicates that this call (with paging) should not cause build errors

http://library.blackboard.com/ref/564b246f-4b44-4e85-881e-3731b8a3fe45/blackboard/persist/course/CourseSearch.html#getViewCoursesSearch(blackboard.persist.course.CourseSearch.SearchKey,%20blackboard.persist.SearchOperator,%20java.lang.String,%20blackboard.persist.SearchOperator,%20java.util.Date,%20blackboard.data.course.Course.ServiceLevel,%20boolean,%20boolean,%20boolean)

 

 

 

public class CourseSearch

extends blackboard.persist.impl.BaseSearch

 

 

Class to encapsulate user searches as viewed from the control and admin panels. The factory method example for getting a CourseSearch for not paging: CourseSearch courseSearch = SearchHelper.getViewCoursesSearch( searchKey, searchOp, searchText,

dateOp, calendar.getTime(), serviceLevel, filterRowStatus, checkDomainEntitlement ); The factory method example for getting a CourseSearch for paging: CourseSearch courseSearch = SearchHelper.getViewCoursesSearch( searchKey, searchOp, searchText, dateOp, calendar.getTime(),

serviceLevel, filterRowStatus, checkDomainEntitlement, displayIntegrated, checkEmarketPlaceEntitlement, startIndex, pageSize, sortCol, sortDir); The difference for initializing a courseSearch between paging and not paging is: paging needs 4 more parameters:

startIndex, pageSize, sortCol, sortDir

 

Since:

    Bb 7.1

 

But, looking at API interface documentation does not show these additional 4 arguments

public static CourseSearch getViewCoursesSearch(CourseSearch.SearchKey key,

SearchOperator op,

java.lang.String value,

SearchOperator dateOp,

java.util.Date createdDate,

Course.ServiceLevel serviceLevel,

boolean bFilterRowStatus,

boolean bCheckDomainEntitlement,

boolean displayIntegrated)

Which is documented below:

http://library.blackboard.com/ref/62ff4d8c-ade4-49aa-ac79-61ba8da42a62/Building%20Blocks%20API%20version%209.1.201510.1171669/blackboard/persist/course/CourseSearch.html#CourseSearch()

Outcomes