| Name | Campus | |
|---|---|---|
| Version | ||
| Included Services | ||
| Java Package | org.kuali.rice.location.api.campus | |
CampusService interface.
| Method | getCampus | ||
|---|---|---|---|
| Description | This will return a {@link Campus}. | ||
| Parameters | String | code | the code of the campus to return |
| Return | Campus | ??? | |
| Errors | RiceIllegalArgumentException | if the code is null | |
| Method | findAllCampuses | ||
|---|---|---|---|
| Description | This will return all {@link Campus}. | ||
| Parameters | None | None | No Parameters |
| Return | CampusList | ??? | |
| Errors | NONE | No Errors | |
| Method | getCampusType | ||
|---|---|---|---|
| Description | This will return a {@link CampusType}. | ||
| Parameters | String | code | the code of the campus type to return |
| Return | CampusType | CampusType object represented by the passed in code | |
| Errors | RiceIllegalArgumentException | if the code is null | |
| Method | findAllCampusTypes | ||
|---|---|---|---|
| Description | This will return all {@link CampusType}. | ||
| Parameters | None | None | No Parameters |
| Return | CampusTypeList | ??? | |
| Errors | NONE | No Errors | |
| Method | findCampuses | ||
|---|---|---|---|
| Description | This method find Campuses based on a query criteria. The criteria cannot be null. | ||
| Parameters | QueryByCriteria | queryByCriteria | the criteria. Cannot be null. |
| Return | CampusQueryResults | query results. will never return null. | |
| Errors | RiceIllegalArgumentException | ??? | |
| Method | findCampusTypes | ||
|---|---|---|---|
| Description | This method find CampusTypes based on a query criteria. The criteria cannot be null. | ||
| Parameters | QueryByCriteria | queryByCriteria | the criteria. Cannot be null. |
| Return | CampusTypeQueryResults | query results. will never return null. | |
| Errors | RiceIllegalArgumentException | ??? | |