View: Hide Browser | Browser on the left | Browser on the right | Dictionary
Report:General | Attributes | Operations | Relations

class User

Contains all relevant information about a specific user.

General
NameUser
Visibility  public
Active  false
Abstract  false
Leaffalse
Rootfalse

Attributes
NameTypeInitial Value
 addrsAddress  
 dbhDBH  
 equipmentgroupsint  
 idint  
 timeperiodTimePeriod  
 usergroupsint  

Operations
NameReturn Type
 checkActiveProfile( alertid : int) boolean 
 checkAlertQueue() boolean 
 checkNewAlerts( nA : NewAlerts, uG : UserGroups, eG : EquipmentGroups) int 
 checkRights( alertid : int) boolean 
 collectAddresses() boolean 
 collectEquipmentGroups() boolean 
 collectInfo() boolean 
 collectQueue()() boolean 
 collectTimePeriod() boolean 
 collectUserGroups() boolean 
 new( userid : int, dbh : DBH)  
 queueAlert( alarmid : int) boolean 
 sendAlert( alertid : int, addressid : int) boolean 

Relations
NameTypeBeginsEnds
 <unnamed>dependencyUserAddress
 <unnamed>dependencyUserTimePeriod
 <unnamed>dependencyEngineUser


attribute addrs

General
Nameaddrs
OwnerUser
Type  Address
Type Modifier  []
Changeability  changeable
Visibility  private
Ordering  unordered
Scope  instance


attribute dbh

General
Namedbh
OwnerUser
Type  DBH
Type Modifier  *
Changeability  changeable
Visibility  private
Ordering  unordered
Scope  instance


attribute equipmentgroups

General
Nameequipmentgroups
OwnerUser
Type  int
Type Modifier  []
Changeability  changeable
Visibility  private
Ordering  unordered
Scope  instance


attribute id

User id

General
Nameid
OwnerUser
Type  int
Changeability  changeable
Visibility  private
Ordering  unordered
Scope  instance


attribute timeperiod

General
Nametimeperiod
OwnerUser
Type  TimePeriod
Changeability  changeable
Visibility  private
Ordering  unordered
Scope  instance


attribute usergroups

General
Nameusergroups
OwnerUser
Type  int
Type Modifier  []
Changeability  changeable
Visibility  private
Ordering  unordered
Scope  instance


operation  checkActiveProfile

Check if an alert is part of the users active profile

General
NamecheckActiveProfile
OwnerUser
Return Type  boolean 
Concurrency  sequential
Query  false
Visibility  private
Scope  instance
Abstract  false
Leaffalse
Rootfalse

Parameters
NameTypeDefault ValueDirection Kind
alertidint  inout


parameter alertid

General
Name  alertid
Owner  checkActiveProfile
Type  int 
Direction Kind  inout


operation  checkAlertQueue

Checks queued alerts and sends them if necesarry or deletes them if they are too old.

General
NamecheckAlertQueue
OwnerUser
Return Type  boolean 
Concurrency  sequential
Query  false
Visibility  public
Scope  instance
Abstract  false
Leaffalse
Rootfalse


operation  checkNewAlerts

Checks the new alerts and sends or queues them.

General
NamecheckNewAlerts
OwnerUser
Return Type  int 
Concurrency  sequential
Query  false
Visibility  public
Scope  instance
Abstract  false
Leaffalse
Rootfalse

Parameters
NameTypeDefault ValueDirection Kind
eGEquipmentGroups  inout
nANewAlerts  inout
uGUserGroups  inout


parameter eG

General
Name  eG
Owner  checkNewAlerts
Type  EquipmentGroups 
Type Modifier  *
Direction Kind  inout


parameter nA

General
Name  nA
Owner  checkNewAlerts
Type  NewAlerts 
Type Modifier  *
Direction Kind  inout


parameter uG

General
Name  uG
Owner  checkNewAlerts
Type  UserGroups 
Type Modifier  *
Direction Kind  inout


operation  checkRights

Checks to see if the user is allowed to receive an alert.

General
NamecheckRights
OwnerUser
Return Type  boolean 
Concurrency  sequential
Query  false
Visibility  private
Scope  instance
Abstract  false
Leaffalse
Rootfalse

Parameters
NameTypeDefault ValueDirection Kind
alertidint  inout


parameter alertid

General
Name  alertid
Owner  checkRights
Type  int 
Direction Kind  inout


operation  collectAddresses

Collect information about users addresses

General
NamecollectAddresses
OwnerUser
Return Type  boolean 
Concurrency  sequential
Query  false
Visibility  private
Scope  instance
Abstract  false
Leaffalse
Rootfalse


operation  collectEquipmentGroups

Collects list of equipment groups the user is allowed to access

General
NamecollectEquipmentGroups
OwnerUser
Return Type  boolean 
Concurrency  sequential
Query  false
Visibility  private
Scope  instance
Abstract  false
Leaffalse
Rootfalse


operation  collectInfo

Collect all relevant information about user form db.

General
NamecollectInfo
OwnerUser
Return Type  boolean 
Concurrency  sequential
Query  false
Visibility  private
Scope  instance
Abstract  false
Leaffalse
Rootfalse


operation  collectQueue()

Reads in information about queued alerts

General
NamecollectQueue()
OwnerUser
Return Type  boolean 
Concurrency  sequential
Query  false
Visibility  public
Scope  instance
Abstract  false
Leaffalse
Rootfalse


operation  collectTimePeriod

Collect information about active time period

General
NamecollectTimePeriod
OwnerUser
Return Type  boolean 
Concurrency  sequential
Query  false
Visibility  private
Scope  instance
Abstract  false
Leaffalse
Rootfalse


operation  collectUserGroups

Collects the user groups the use is member of

General
NamecollectUserGroups
OwnerUser
Return Type  boolean 
Concurrency  sequential
Query  false
Visibility  private
Scope  instance
Abstract  false
Leaffalse
Rootfalse


operation  new

constructor

General
Namenew
OwnerUser
Concurrency  sequential
Query  false
Visibility  public
Scope  instance
Abstract  false
Leaffalse
Rootfalse

Parameters
NameTypeDefault ValueDirection Kind
dbhDBH  inout
useridint  inout


parameter dbh

Reference to database connection

General
Name  dbh
Owner  new
Type  DBH 
Type Modifier  *
Direction Kind  inout


parameter userid

General
Name  userid
Owner  new
Type  int 
Direction Kind  inout


operation  queueAlert

General
NamequeueAlert
OwnerUser
Return Type  boolean 
Concurrency  sequential
Query  false
Visibility  public
Scope  instance
Abstract  false
Leaffalse
Rootfalse

Parameters
NameTypeDefault ValueDirection Kind
alarmidint  inout


parameter alarmid

General
Name  alarmid
Owner  queueAlert
Type  int 
Direction Kind  inout


operation  sendAlert

Sends an alarm.

General
NamesendAlert
OwnerUser
Return Type  boolean 
Concurrency  sequential
Query  false
Visibility  private
Scope  instance
Abstract  false
Leaffalse
Rootfalse

Parameters
NameTypeDefault ValueDirection Kind
addressidint  inout
alertidint  inout


parameter addressid

General
Name  addressid
Owner  sendAlert
Type  int 
Direction Kind  inout


parameter alertid

General
Name  alertid
Owner  sendAlert
Type  int 
Direction Kind  inout