001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019package org.apache.isis.extensions.secman.api.role;
020
021import java.util.Collection;
022import java.util.Optional;
023
024import org.apache.isis.extensions.secman.api.user.ApplicationUser;
025
026public interface ApplicationRoleRepository<R extends ApplicationRole> {
027
028    /**
029     * 
030     * @return detached entity
031     */
032    R newApplicationRole();
033    
034    Collection<R> allRoles();
035
036    R newRole(String name, String description);
037
038    Collection<R> findNameContaining(String search);
039    Collection<R> getRoles(ApplicationUser user);
040    
041    /**
042     * auto-complete support
043     * @param search
044     */
045    Collection<R> findMatching(String search);
046
047    Optional<R> findByName(String roleName);
048    Optional<R> findByNameCached(String roleName);
049
050    void addRoleToUser(ApplicationRole role, ApplicationUser user);
051    void removeRoleFromUser(ApplicationRole role, ApplicationUser user);
052
053    boolean isAdminRole(ApplicationRole role);
054
055    void deleteRole(ApplicationRole holder);
056
057    
058
059}