com.tcdng.jacklyn.common.web.UserSessionViewAccessProvider Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018-2020 The Code Department
 * 
 * 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.tcdng.jacklyn.common.web;

import java.util.List;

import com.tcdng.unify.core.UnifyComponent;
import com.tcdng.unify.core.UnifyException;

/**
 * User session view access provider.
 * 
 * @author Lateef Ojulari
 * @since 1.0
 */
public interface UserSessionViewAccessProvider extends UnifyComponent {

    /**
     * Finds current user session branch IDs
     * 
     * @return list of branch IDs. Null is returned for system or application
     *         admin users.
     * @throws UnifyException
     *             if an error occurs
     */
    List findUserSessionBranchIds() throws UnifyException;

    /**
     * Finds current user session department IDs
     * 
     * @return list of department IDs. Null is returned for system or
     *         application admin users.
     * @throws UnifyException
     *             if an error occurs
     */
    List findUserSessionDepartmentIds() throws UnifyException;
}