csdk.v2.api.user

Interface IUserContext

All Superinterfaces:

IContext, Serializable

public interface IUserContext
extends IContext

Define os métodos disponíveis para consulta de usuários do sistema.

Method Summary

Modifier and Type	Method and Description
IUser[]	getAllUsers(Window window) Solicita a lista de todos os usuários do sistema.
IUser	getCurrentUser() Obtém o usuário logado no sistema.
IUser	getUserByLogin(String login, Window window) Solicita o usuário que possui um determinado login.

Methods inherited from interface csdk.v2.api.core.IContext

isActive, onContextActivate, onContextDeactivate

Method Detail

getCurrentUser

IUser getCurrentUser()
              throws UserException

Obtém o usuário logado no sistema.

Returns:

o usuário.

Throws:

UserException - em caso de erro na consulta ao usuário.

getAllUsers

IUser[] getAllUsers(Window window)
             throws UserException

Solicita a lista de todos os usuários do sistema.

Parameters:

window - a janela mãe da requisição.

Returns:

a lista de todos os usuários

Throws:

UserException - em caso de erro na consulta ao usuário.

getUserByLogin

IUser getUserByLogin(String login,
                     Window window)
              throws UserException

Solicita o usuário que possui um determinado login.

Parameters:

login - o login do usuário procurado

window - a janela mãe da requisição.

Returns:

o usuário que possui o login procurado ou null caso esse usuário não exista.

Throws:

UserException - em caso de erro na consulta ao usuário.