org.kuali.rice.location.api.campus
Interface CampusService

All Known Implementing Classes:

CampusServiceImpl

public interface CampusService

CampusService interface.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

List<Campus>	findAllCampuses() This will return all Campus.
List<CampusType>	findAllCampusTypes() This will return all CampusType.
CampusQueryResults	findCampuses(QueryByCriteria queryByCriteria) This method find Campuses based on a query criteria.
CampusTypeQueryResults	findCampusTypes(QueryByCriteria queryByCriteria) This method find CampusTypes based on a query criteria.
Campus	getCampus(String code) This will return a Campus.
CampusType	getCampusType(String code) This will return a CampusType.

Method Detail

getCampus

@Cacheable(value="http://rice.kuali.org/location/v2_0/CampusType",
           key="\'code=\' + #p0")
Campus getCampus(String code)
                 throws RiceIllegalArgumentException

This will return a Campus.

Parameters:

code - the code of the campus to return

Throws:

RiceIllegalArgumentException - if the code is null

IllegalStateException - if the campus does not exist in the system under the specific code

findAllCampuses

@Cacheable(value="http://rice.kuali.org/location/v2_0/CampusType",
           key="\'all\'")
List<Campus> findAllCampuses()

This will return all Campus.

getCampusType

@Cacheable(value="http://rice.kuali.org/location/v2_0/CampusTypeType",
           key="\'code=\' + #p0")
CampusType getCampusType(String code)
                         throws RiceIllegalArgumentException

This will return a CampusType.

Parameters:

code - the code of the campus type to return

Returns:

CampusType object represented by the passed in code

Throws:

RiceIllegalArgumentException - if the code is null

findAllCampusTypes

@Cacheable(value="http://rice.kuali.org/location/v2_0/CampusTypeType",
           key="\'all\'")
List<CampusType> findAllCampusTypes()

This will return all CampusType.

findCampuses

CampusQueryResults findCampuses(QueryByCriteria queryByCriteria)
                                throws RiceIllegalArgumentException

This method find Campuses based on a query criteria. The criteria cannot be null.

Parameters:

queryByCriteria - the criteria. Cannot be null.

Returns:

query results. will never return null.

Throws:

IllegalArgumentException - if the queryByCriteria is null

RiceIllegalArgumentException

Since:

2.0.1

findCampusTypes

CampusTypeQueryResults findCampusTypes(QueryByCriteria queryByCriteria)
                                       throws RiceIllegalArgumentException

This method find CampusTypes based on a query criteria. The criteria cannot be null.

Parameters:

queryByCriteria - the criteria. Cannot be null.

Returns:

query results. will never return null.

Throws:

IllegalArgumentException - if the queryByCriteria is null

RiceIllegalArgumentException

Since:

2.0.1