Automatic generation produced by ISE Eiffel
indexing
description: "Deferred Class that is a template for all User Data Access Classes"
author: "Marco Piccioni, Peizhu Li"
date: "$Date$"
revision: "$0.6$"
deferred class interface
USER_MANAGER
feature -- Access
generating_type: STRING_8
-- Name of current object's generating type
-- (type of which it is a direct instance)
-- (from ANY)
ensure -- from ANY
generating_type_not_void: Result /= Void
generating_type_not_empty: not Result.is_empty
generator: STRING_8
-- Name of current object's generating class
-- (base class of the type of which it is a direct instance)
-- (from ANY)
ensure -- from ANY
generator_not_void: Result /= Void
generator_not_empty: not Result.is_empty
feature -- Comparison
frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
-- Are `some' and `other' either both void
-- or attached to isomorphic object structures?
-- (from ANY)
ensure -- from ANY
shallow_implies_deep: standard_equal (some, other) implies Result
both_or_none_void: (some = Void) implies (Result = (other = Void))
same_type: (Result and (some /= Void)) implies some.same_type (other)
symmetric: Result implies deep_equal (other, some)
frozen equal (some: ANY; other: like arg #1): BOOLEAN
-- Are `some' and `other' either both void or attached
-- to objects considered equal?
-- (from ANY)
ensure -- from ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))
frozen is_deep_equal (other: like Current): BOOLEAN
-- Are `Current' and `other' attached to isomorphic object structures?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
ensure -- from ANY
shallow_implies_deep: standard_is_equal (other) implies Result
same_type: Result implies same_type (other)
symmetric: Result implies other.is_deep_equal (Current)
is_equal (other: like Current): BOOLEAN
-- Is `other' attached to an object considered
-- equal to current object?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
ensure -- from ANY
symmetric: Result implies other.is_equal (Current)
consistent: standard_is_equal (other) implies Result
frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
-- Are `some' and `other' either both void or attached to
-- field-by-field identical objects of the same type?
-- Always uses default object comparison criterion.
-- (from ANY)
ensure -- from ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))
frozen standard_is_equal (other: like Current): BOOLEAN
-- Is `other' attached to an object of the same type
-- as current object, and field-by-field identical to it?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
ensure -- from ANY
same_type: Result implies same_type (other)
symmetric: Result implies other.standard_is_equal (Current)
feature -- Status report
conforms_to (other: ANY): BOOLEAN
-- Does type of current object conform to type
-- of `other' (as per Eiffel: The Language, chapter 13)?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
same_type (other: ANY): BOOLEAN
-- Is type of current object identical to type of `other'?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
ensure -- from ANY
definition: Result = (conforms_to (other) and other.conforms_to (Current))
feature -- Duplication
copy (other: like Current)
-- Update current object using fields of object attached
-- to `other', so as to yield equal objects.
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
type_identity: same_type (other)
ensure -- from ANY
is_equal: is_equal (other)
frozen deep_copy (other: like Current)
-- Effect equivalent to that of:
-- copy (`other' . deep_twin)
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
ensure -- from ANY
deep_equal: deep_equal (Current, other)
frozen deep_twin: like Current
-- New object structure recursively duplicated from Current.
-- (from ANY)
ensure -- from ANY
deep_twin_not_void: Result /= Void
deep_equal: deep_equal (Current, Result)
frozen standard_copy (other: like Current)
-- Copy every field of `other' onto corresponding field
-- of current object.
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
type_identity: same_type (other)
ensure -- from ANY
is_standard_equal: standard_is_equal (other)
frozen standard_twin: like Current
-- New object field-by-field identical to `other'.
-- Always uses default copying semantics.
-- (from ANY)
ensure -- from ANY
standard_twin_not_void: Result /= Void
equal: standard_equal (Result, Current)
frozen twin: like Current
-- New object equal to `Current'
-- twin calls copy; to change copying/twining semantics, redefine copy.
-- (from ANY)
ensure -- from ANY
twin_not_void: Result /= Void
is_equal: Result.is_equal (Current)
feature -- Basic operations
frozen default: like Current
-- Default value of object's type
-- (from ANY)
frozen default_pointer: POINTER
-- Default value of type `POINTER'
-- (Avoid the need to write `p'.default for
-- some `p' of type `POINTER'.)
-- (from ANY)
default_rescue
-- Process exception for routines with no Rescue clause.
-- (Default: do nothing.)
-- (from ANY)
frozen do_nothing
-- Execute a null action.
-- (from ANY)
feature -- Attributes
encryptor: ENCRYPTOR
-- encrypt user login name and password, void to skip encryption
user_list: HASH_TABLE [USER, STRING_8]
feature -- Output
io: STD_FILES
-- Handle to standard file setup
-- (from ANY)
ensure -- from ANY
io_not_void: Result /= Void
out: STRING_8
-- New string containing terse printable representation
-- of current object
-- (from ANY)
ensure -- from ANY
out_not_void: Result /= Void
print (some: ANY)
-- Write terse external representation of `some'
-- on standard output.
-- (from ANY)
frozen tagged_out: STRING_8
-- New string containing terse printable representation
-- of current object
-- (from ANY)
ensure -- from ANY
tagged_out_not_void: Result /= Void
feature -- Platform
operating_environment: OPERATING_ENVIRONMENT
-- Objects available from the operating system
-- (from ANY)
ensure -- from ANY
operating_environment_not_void: Result /= Void
feature --Basic Operations
add_user (a_user: USER)
--adds a user to the userlist
require
a_user_valid: a_user /= Void
user_not_exists: not username_defined (a_user.username)
ensure
one_user_added: user_list.count = old user_list.count + 1
delete_user_by_name (username: STRING_8)
--
require
username_exists: username /= Void and then not username.is_empty and then user_list.has (username)
ensure
one_user_removed: user_list.count = old user_list.count - 1
get_user_by_name (username: STRING_8): USER
-- return the USER object identified by username
require
username_exists: username /= Void and then not username.is_empty and then user_list.has (username)
ensure
user_found: Result /= Void
is_user_authentication_valid (username, pass: STRING_8): BOOLEAN
-- check user authentication
require
name_pass_not_empty: username /= Void and then not username.is_empty and then pass /= Void and then not pass.is_empty
persist_data
set_encryptor (cryptor: ENCRYPTOR)
-- retrieve the saved session object with given session_id
update_user (a_user: USER)
--update a existing user
require
a_user_valid: a_user /= Void
user_exists: username_defined (a_user.username)
ensure
same_user_number: user_list.count = old user_list.count
user_count: INTEGER_32
--
username_defined (username: STRING_8): BOOLEAN
--adds a user to the userlist
require
username_valid: username /= Void and then not username.is_empty
invariant
invariant_clause: True
-- from ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)
end -- class USER_MANAGER
-- Generated by ISE Eiffel --
For more details: www.eiffel.com