com.foreach.across.modules.user.services.GroupService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of user-module Show documentation
User Module
The newest version!
/*
 * Copyright 2014 the original author or authors
 *
 * 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.foreach.across.modules.user.services;

import com.foreach.across.modules.user.business.Group;
import com.foreach.across.modules.user.business.GroupProperties;
import com.foreach.across.modules.user.business.UserDirectory;
import com.querydsl.core.types.OrderSpecifier;
import com.querydsl.core.types.Predicate;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.querydsl.QuerydslPredicateExecutor;

import java.util.Collection;
import java.util.Optional;

/**
 * @author Arne Vandamme
 */
public interface GroupService extends QuerydslPredicateExecutor
{
	Collection getGroups();

	Optional getGroupById( long id );

	/**
	 * Get the group with a given name in the default directory.
	 *
	 * @param name of the group
	 * @return instance or {@code null} if not found
	 */
	Optional getGroupByName( String name );

	/**
	 * Get the group with a given name in the specified directory.
	 *
	 * @param name          of the group
	 * @param userDirectory the group should belong to
	 * @return instance or {@code null} if not found
	 */
	Optional getGroupByName( String name, UserDirectory userDirectory );

	Group save( Group groupDto );

	void delete( long groupId );

	GroupProperties getProperties( Group group );

	void saveProperties( GroupProperties groupProperties );

	void deleteProperties( Group group );

	void deleteProperties( long groupId );

	/**
	 * Returns all groups having a specific property value.  Will return all matching
	 * groups across all user directories.
	 *
	 * @param propertyName  name of the property
	 * @param propertyValue value the property should have
	 * @return groups
	 */
	Collection getGroupsWithPropertyValue( String propertyName, Object propertyValue );

	@Override
	Optional findOne( Predicate predicate );

	@Override
	Collection findAll( Predicate predicate );

	@Override
	Collection findAll( Predicate predicate, OrderSpecifier... orderSpecifiers );

	@Override
	Page findAll( Predicate predicate, Pageable pageable );

	@Override
	long count( Predicate predicate );
}