AccessGrid.ClientProfile.ClientProfile

Package AccessGrid :: Module ClientProfile :: Class ClientProfile

[show private | hide private]

Class ClientProfile

The client profile is used to represent the clients throughout the AG.
The client profile is all public data, however only the author of the
profile is allowed to modify it.

Method Summary
	`__init__(self, profileFile)`
	`__str__(self)`
	`CheckProfile(self)`
	`Dump(self)`
	`GetDistinguishedName(self)`
	`GetEmail(self)`
	`GetHomeVenue(self)`
	`GetLocation(self)`
	`GetName(self)`
	`GetPhoneNumber(self)`
	`GetProfileType(self)`
	`GetPublicId(self)`
	`GetVenueClientURL(self)`
	`InformationMatches(self, obj)` return true (1) if profile information is equivalent return false (0) otherwise.
	`IsDefault(self)`
	`Load(self, fileName, loadDnDetails)` loadDnDetails is used by the cache to include the reading of a DN when reading from the stored profile.
	`Save(self, fileName, saveDnDetails)` saveDnDetails is used by the cache to include the DN in the stored profile.
	`SetEmail(self, email)`
	`SetHomeVenue(self, venue)`
	`SetLocation(self, location)`
	`SetName(self, name)`
	`SetPhoneNumber(self, phoneNumber)`
	`SetProfileType(self, profileType)`
	`SetPublicId(self, publicId)`
	`SetVenueClientURL(self, venueClientURL)`

Class Variable Summary
`str`	`configSection` = `'ClientProfile'`
`dict`	`defaultProfile` = `{'ClientProfile.location': '<Insert Pos...`
`str`	`NODE` = `'node'`
`str`	`USER` = `'user'`
`list`	`validOptions` = `['type', 'name', 'email', 'phone', 'icon'...`

Method Details

InformationMatches(self, obj)

return true (1) if profile information is equivalent
  return false (0) otherwise.
This was written mostly for the ClientProfileCache to use, so
  if modifying this function keep that purpose in mind.
  Specifically, a profile should be equivalent to its cached 
  profile if the user hasn't changed his/her profile.  This means
  things such as VenueClientURL are not tested below since it can
  change after the venue client reconnects.

Load(self, fileName, loadDnDetails=0)

loadDnDetails is used by the cache to include the reading
  of a DN when reading from the stored profile.

Save(self, fileName, saveDnDetails=0)

saveDnDetails is used by the cache to include the DN
  in the stored profile.

Class Variable Details

configSection

Type:: str
Value:: 'ClientProfile'

defaultProfile

Type:: dict
Value:: {'ClientProfile.email': '<Insert Email Address Here>', 'ClientProfile.home': 'https://vv2.mcs.anl.gov:9000/Venues/default', 'ClientProfile.icon': '<Leave blank for now>', 'ClientProfile.id': '', 'ClientProfile.location': '<Insert Postal Address Here>', 'ClientProfile.name': '<Insert Name Here>', 'ClientProfile.phone': '<Insert Phone Number Here>', 'ClientProfile.techsupportinfo': '', ...

NODE

Type:: str
Value:: 'node'

USER

Type:: str
Value:: 'user'

validOptions

Type:: list
Value:: ['type', 'name', 'email', 'phone', 'icon', 'id', 'location', 'venueclienturl', ...

Generated by Epydoc 2.1 on Mon Jan 09 13:23:49 2006

http://epydoc.sf.net