Arena
1.0
A content management system
|
This class represents a list of subscriptions that define the access rights of a specific group. More...
Public Member Functions | |
def | __init__ |
Constructor. More... | |
def | init |
Initializer. | |
def | fetch |
Fetch subscription information for the specified groups and channels. More... | |
def | append |
Subscribe the group to the specified channel with the specified rights. More... | |
def | remove |
Remove the subscription to the specified channel. | |
def | has |
Determine if the specified right is granted to the specified channel by a subscription in the list. More... | |
def | hasAnyOf |
Determine if any of the rights specified are granted to the specified channel by a subscription in the list. More... | |
def | rightsFor |
Return a list of rights granted by a subscription to the specified channel. More... | |
def | category |
Retrieve the name of the data source category used by the subscription list. More... | |
def | __setitem__ |
Alter the rights for the specified channel. 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 subscriptions that define the access rights of a specific group.
def Plugins.User.Subscriptions.ASubscriptionList.__init__ | ( | Self, | |
params | |||
) |
Constructor.
In addition to the parameters expected by ADataList.__init__(), this method expects that params
will contain the following items:
category
– The name of the category (or table) in the data source to use as the source of subscription information. def Plugins.User.Subscriptions.ASubscriptionList.__setitem__ | ( | Self, | |
thisChannel, | |||
rights | |||
) |
Alter the rights for the specified channel.
Note that this routine overrides the behavior inherited from ADataList. Note, too, that it expects that rights specified will either be a string or list of the new rights that apply to the specified channel.
def Plugins.User.Subscriptions.ASubscriptionList.append | ( | Self, | |
channelName, | |||
groupName, | |||
rights = slDefaultRights |
|||
) |
Subscribe the group to the specified channel with the specified rights.
def Plugins.User.Subscriptions.ASubscriptionList.category | ( | Self | ) |
Retrieve the name of the data source category used by the subscription list.
def Plugins.User.Subscriptions.ASubscriptionList.fetch | ( | Self, | |
groups | |||
) |
Fetch subscription information for the specified groups and channels.
def Plugins.User.Subscriptions.ASubscriptionList.has | ( | Self, | |
thisRight, | |||
thisChannel | |||
) |
Determine if the specified right is granted to the specified channel by a subscription in the list.
def Plugins.User.Subscriptions.ASubscriptionList.hasAnyOf | ( | Self, | |
theseRights, | |||
thisChannel | |||
) |
Determine if any of the rights specified are granted to the specified channel by a subscription in the list.
def Plugins.User.Subscriptions.ASubscriptionList.rightsFor | ( | Self, | |
thisChannel | |||
) |
Return a list of rights granted by a subscription to the specified channel.