/* * Copyright 2015 Eric F. Savage, code@efsavage.com * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.ajah.user.group.data; import java.util.List; import com.ajah.spring.jdbc.AjahDao; import com.ajah.spring.jdbc.criteria.Order; import com.ajah.spring.jdbc.err.DataOperationException; import com.ajah.user.UserId; import com.ajah.user.group.GroupId; import com.ajah.user.group.GroupUser; import com.ajah.user.group.GroupUserId; import com.ajah.user.group.GroupUserStatus; import com.ajah.user.group.GroupUserType; /** * DAO interface for {@link GroupUser}. * * @author Eric F. Savage <code@efsavage.com> * */ public interface GroupUserDao extends AjahDao<GroupUserId, GroupUser> { /** * Returns a list of {@link GroupUser}s that match the specified criteria. * * @param groupId * The group to filter on, optional. * @param search * The search field, optional. * @param type * The GroupUserType to filter on, optional. * @param status * The GroupUserStatus to filter on, optional. * @param sort * The field to sort by, defaults to id, optional. * @param order * The order to sort by The order to sort by, defaults to * ascending, optional. * @param page * The page of results to fetch. * @param count * The number of results per page. * @return A list of {@link GroupUser}s, which may be empty. * @throws DataOperationException * If the query could not be executed. */ List<GroupUser> list(GroupId groupId, String search, GroupUserType type, GroupUserStatus status, String sort, Order order, int page, int count) throws DataOperationException; /** * Counts the records available that match the criteria. * * @param groupId * The group to filter on, optional. * @param type * The groupUser type to limit to, optional. * @param status * The status to limit to, optional. * @return The number of matching records. * @throws DataOperationException * If the query could not be executed. */ int count(GroupId groupId, GroupUserType type, GroupUserStatus status) throws DataOperationException; /** * Counts the records available that match the search criteria. * * @param groupId * The group to filter on, optional. * @param search * The search query. * @param type * The GroupUserType to filter on, optional. * @param status * The GroupUserStatus to filter on, optional. * @return The number of matching records. * @throws DataOperationException * If the query could not be executed. */ int searchCount(GroupId groupId, String search, GroupUserType type, GroupUserStatus status) throws DataOperationException; List<GroupUser> list(UserId userId, GroupUserStatus status) throws DataOperationException; }