|
Arena
1.0
A content management system
|
|
Arena
1.0
A content management system
|
This class represents a list of groups to which a specific user may belong. More...
Inheritance diagram for Plugins.User.Groups.AGroupList:Public Member Functions | |
| def | __init__ |
| Constructor. More... | |
| def | init |
| Initializer. | |
| def | fetch |
| Fetch the list of groups to which the specified user belongs. More... | |
| def | append |
| Add the user to the specified group. More... | |
| def | remove |
| Remove the user from the specified group. More... | |
| def | category |
| Retrieve the name of the category in the data source used by the group list. | |
| def | user |
| Retrieve the name of the user for whom the group list applies. More... | |
| Public Member Functions inherited from Plugins.DataSource.DataLists.ADataList | |
| def | __init__ |
| Construct a new data list instance. More... | |
| def | init |
| Initialize a new data list instance. More... | |
| def | fetch |
| Fetch the list from the data source. More... | |
| def | append |
Append the specified item to the list. More... | |
| def | remove |
Remove the specified item from the list. More... | |
| def | toString |
| Construct a string representation of the list. More... | |
| def | DataSource |
| Retrieve the data source used by the list. More... | |
| def | item |
| Retrieve the specified value from the list. More... | |
| def | items |
| Retrieve the dictionary object used to store column values and primary keys. More... | |
| def | __getitem__ |
| Obtain the specified value from the list. More... | |
| def | __setitem__ |
| Set the value of the specified item. More... | |
| def | __delitem__ |
| Delete the specified item from the list. More... | |
| def | keys |
| Retrieve the list of keys in use by the list. More... | |
| def | __contains__ |
| Public Member Functions inherited from Library.Base.Events.ALoggingEventfulObject | |
| def | __init__ |
| Constructor. More... | |
| def | init |
| Initializer. | |
| def | error |
| Generate an error event. More... | |
| def | log |
| Log the specified item. More... | |
| def | Log |
| Retrieve the log used by the class. | |
| Public Member Functions inherited from Library.Base.Events.AnEventfulObject | |
| def | __init__ |
| Constructor. More... | |
| def | init |
| Initializer. | |
| def | __del__ |
| Destructor. | |
| def | parseParams |
| Parse the specified parameters, looking for named events and setting event handlers as appropriate. More... | |
| def | generate |
| Generate the named event. | |
| def | update |
| Update the events generated by the object. | |
| def | error |
| Generate an error event. More... | |
| def | toString |
| Construct a string representation of the object. More... | |
| def | on |
| Set the handler for the specified event. More... | |
| def | onMultiple |
| Set handlers for multiple events. More... | |
| def | handlerFor |
| Retrieve the handler for the specified event. More... | |
| def | generates |
| Determine whether or not the object generates the named event. More... | |
| def | __getitem__ |
| Retrieve the value of the named property. | |
| def | __setitem__ |
| Set the value of the named property. | |
| Public Member Functions inherited from Library.Base.Classwork.AnObject | |
| def | init |
| Initialize a new object instance. More... | |
| def | __init__ |
| Construct and initialize a new instance of AnObject. More... | |
| def | __del__ |
| Destroy the object instance. More... | |
| def | displayName |
| Construct a "pretty" display name for the class instance, based on the name of its class. More... | |
| def | implements |
| Determine whether the class instance is related to the specified class. More... | |
| def | toString |
| Return a string representation of the class, suitable for output to a console or text-based device. More... | |
| def | __str__ |
| Return a string representation of the class. More... | |
| def | classname |
| Return the name of the class from which the instance was created. More... | |
| def | name |
| Return the name of the class. More... | |
| Public Member Functions inherited from Library.String.Utilities.IsPrintable | |
| def | toString |
| Return a string representation of the class conveniently. More... | |
| def | __str__ |
| Return a string representation of the class. More... | |
| def | printTo |
| Print a string representation of the class to the specified stream. More... | |
This class represents a list of groups to which a specific user may belong.
| def Plugins.User.Groups.AGroupList.__init__ | ( | Self, | |
| params | |||
| ) |
Constructor.
In addition to the parameters expected by ADataList.__init__(), this routine expects that params will contain the following items:
category – The category (or table) within the data source from which the list will draw.user – The name of the user for which the list will be constructed. | def Plugins.User.Groups.AGroupList.append | ( | Self, | |
| groupName | |||
| ) |
Add the user to the specified group.
| def Plugins.User.Groups.AGroupList.fetch | ( | Self | ) |
Fetch the list of groups to which the specified user belongs.
| def Plugins.User.Groups.AGroupList.remove | ( | Self, | |
| groupName | |||
| ) |
Remove the user from the specified group.
| def Plugins.User.Groups.AGroupList.user | ( | Self | ) |
Retrieve the name of the user for whom the group list applies.
1.8.3.1