Synergy source documentation: Class BUserMan

Overview

Package

Class

Tree

Deprecated

Index

Synergy Documentation

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

au.edu.swin.synergy.plugin.userman
Class BUserMan

java.lang.Object
  |
  +--au.edu.swin.synergy.kernel.BPlugin
        |
        +--au.edu.swin.synergy.plugin.userman.BUserMan

public class BUserMan
extends BPlugin

User manager GUI

Inner Class Summary
`class`	`BUserMan.WindowListener` Listens for the crud user manager window closing.

Fields inherited from class au.edu.swin.synergy.kernel.BPlugin

kernel

Constructor Summary
`BUserMan()`

Method Summary
`protected void`	`doDialect()` This method will be called whenever the current locale changes as we need to refill the text on the interface with values from the appropriate locale.
`protected void`	`doRefresh()` This will get all the users and groups from the server
`protected BUser`	`getCurrentUser()` This will get the user who is currently logged in to a server.
`protected boolean`	`isAdministrator()` This will indicate whether the currently authenticated user is an administrator or not.
`protected boolean`	`isLoggedIn()` This will determine whether the user is logged in so that an appropriate message can be displayed to the user if they are not.
`void`	`onBCommandEvent(Object source, BCommandEvent event)` Please complete the missing tags for onBCommandEvent
`void`	`registerHelp()` This will register the help files associated with the user manager to the help plugin
`void`	`setup(BStringList params)` Please complete the missing tags for setup

Methods inherited from class au.edu.swin.synergy.kernel.BPlugin

dispatchEvent, 
dispatchEventAndWait, 
dispatchEventServer, 
dispatchEventServerAndWait, 
dispatchEventTo, 
dispatchEventToAndWait, 
getDependancies, 
getKernel, 
setKernel, 
setup, 
unload

Methods inherited from class java.lang.Object

clone, 
equals, 
finalize, 
getClass, 
hashCode, 
notify, 
notifyAll, 
toString, 
wait, 
wait, 
wait

Constructor Detail

BUserMan

public BUserMan()

Method Detail

doDialect

protected void doDialect()

This method will be called whenever the current locale changes as we need to refill the text on the interface with values from the appropriate locale.

setup

public void setup(BStringList params)

Please complete the missing tags for setup

Parameters:: -
Returns:
Throws:: BUserMan.WindowListener -
Overrides:: setup in class BPlugin
Pre Condition:
Post Condition:

onBCommandEvent

public void onBCommandEvent(Object source,
                            BCommandEvent event)

Please complete the missing tags for onBCommandEvent

Parameters:: -
Returns:
Throws:: BUserMan.WindowListener -
Overrides:: onBCommandEvent in class BPlugin
Pre Condition:
Post Condition:

isLoggedIn

protected boolean isLoggedIn()

This will determine whether the user is logged in so that an appropriate message can be displayed to the user if they are not.

isAdministrator

protected boolean isAdministrator()

This will indicate whether the currently authenticated user is an administrator or not.

Returns:: True if they are, false otherwise
Post Condition:: The isAdministrator and isUser flags will be set in BCRUDUserManager

getCurrentUser

protected BUser getCurrentUser()

This will get the user who is currently logged in to a server. This will be the user that is doing the editting.

doRefresh

protected void doRefresh()

This will get all the users and groups from the server

registerHelp

public void registerHelp()

This will register the help files associated with the user manager to the help plugin