Trees       Indices       Help   
SUE - Revision 232
AccessEngine :: AERegistrar :: UIESet :: Class UIESet
[hide private]
[frames] | no frames]

Class UIESet

source code

object --+
         |
        UIESet
Associates the names of installed UIEs with times when they should be automatically loaded by SUE under a particular user profile. Supported times for automatically loading UIEs include when SUE starts, when any new AETier is created, or when a AETier with a particular process name is created.

Instance Methods [hide private]
 
__init__(self, name)
Stores the name of the UIESet.		 source code
 
addToStartup(self, kind, name, index)
Adds the name of a UIE of the given kind to the on_startup dictionary so that it is loaded automatically when SUE starts.		 source code
 
removeFromStartup(self, kind, name)
Removes the name of a UIE of the given kind from the on_startup dictionary so that it is no longer loaded automatically on SUE startup.		 source code
 
addToAETier(self, kind, name, tier_name, index)
Adds the name of a UIE of the given kind to the on_tier dictionary so that it is loaded automatically when a AETier with the given name is created.		 source code
 
removeFromAETier(self, kind, name, tier_name)
Removes the name of a UIE of the given kind from the on_tier dictionary so that it is no longer loaded automatically on when a AETier with the given name is created.		 source code
 
addToAnyAETier(self, kind, name, index)
Adds the name of a UIE of the given kind to the on_any_tier dictionary so that it is loaded automatically when any AETier starts.		 source code
 
removeFromAnyAETier(self, kind, name)
Removes the name of a UIE of the given kind from the on_any_tier dictionary so that it is no longer loaded automatically when any AETier is created.		 source code
 
removeFromAll(self, name, kind=None)
Removes all references to the UIE with the given name and kind from the on_startup, on_tier, and on_any_tier dictionaries.		 source code
list of string
listStartup(self, kind)
Gets a list of all UIE names of the given kind that are to be loaded at SUE startup.		 source code
dictionary of string : list
listAETierMap(self, kind)
Gets a list of all UIE names of the given kind paired with the names of the AETiers on which they will load.		 source code
list of string
listAETier(self, kind, tier=None)
Gets a list of all UIE names of the given kind that are to be loaded when a AETier with the given name is created.		 source code
list of string
listAnyAETier(self, kind)
Gets a list of all UIE names of the given kind that are to be loaded when any AETier is created.		 source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Instance Variables [hide private]
string name
Name of this UIESet
dictionary on_any_tier
Lists of UIE names keyed by UIE kind
dictionary on_startup
Lists of UIE names keyed by UIE kind
dictionary on_tier
Lists of UIE names keyed by UIE kind in dictionaries keyed by AETier name
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name)
(Constructor)

source code 
Stores the name of the UIESet. Initializes the instance dictionaries.
Parameters:
  • name (string) - Name of the UIESet
Overrides: object.__init__

addToStartup(self, kind, name, index)

source code 
Adds the name of a UIE of the given kind to the on_startup dictionary so that it is loaded automatically when SUE starts. The index determines when in the list of all on_startup UIEs of the given kind the named UIE is loaded.
Parameters:
  • kind (string) - Kind of UIE, one of ALL_KINDS
  • name (string) - Name of the UIE, unique across all UIEs of the same kind
  • index (integer or None) - Load order of the UIE when multiple UIEs are to be loaded at the given time. A value of None meaning after all other UIEs of the same kind.

removeFromStartup(self, kind, name)

source code 
Removes the name of a UIE of the given kind from the on_startup dictionary so that it is no longer loaded automatically on SUE startup.
Parameters:
  • kind (string) - Kind of UIE, one of ALL_KINDS
  • name (string) - Name of the UIE, unique across all UIEs of the same kind
Raises:
  • ValueError - When the UIE of the given name and kind is not associated with this profile to be loaded on startup

addToAETier(self, kind, name, tier_name, index)

source code 
Adds the name of a UIE of the given kind to the on_tier dictionary so that it is loaded automatically when a AETier with the given name is created. The index determines when in the list of all on_tier UIEs of the given kind the named UIE is loaded.
Parameters:
  • kind (string) - Kind of UIE, one of ALL_KINDS
  • name (string) - Name of the UIE, unique across all UIEs of the same kind
  • tier_name (string) - Name of the AETier
  • index (integer or None) - Load order of the UIE when multiple UIEs are to be loaded at the given time. A value of None meaning after all other UIEs of the same kind.

removeFromAETier(self, kind, name, tier_name)

source code 
Removes the name of a UIE of the given kind from the on_tier dictionary so that it is no longer loaded automatically on when a AETier with the given name is created.
Parameters:
  • kind (string) - Kind of UIE, one of ALL_KINDS
  • name (string) - Name of the UIE, unique across all UIEs
  • tier_name (string) - Name of the AETier
Raises:
  • ValueError - When the UIE of the given name and kind is not associated with this profile to be loaded when the given AETier starts

addToAnyAETier(self, kind, name, index)

source code 
Adds the name of a UIE of the given kind to the on_any_tier dictionary so that it is loaded automatically when any AETier starts. The index determines when in the list of all on_any_tier UIEs of the given kind the named UIE is loaded.
Parameters:
  • kind (string) - Kind of UIE, one of ALL_KINDS
  • name (string) - Name of the UIE, unique across all UIEs of the same kind
  • index (integer or None) - Load order of the UIE when multiple UIEs are to be loaded at the given time. A value of None meaning after all other UIEs of the same kind.

removeFromAnyAETier(self, kind, name)

source code 
Removes the name of a UIE of the given kind from the on_any_tier dictionary so that it is no longer loaded automatically when any AETier is created.
Parameters:
  • kind (string) - Kind of UIE, one of ALL_KINDS
  • name (string) - Name of the UIE, unique across all UIEs of the same kind
Raises:
  • ValueError - When the UIE of the given name and kind is not associated with this profile to be loaded when any AETier is created

removeFromAll(self, name, kind=None)

source code 
Removes all references to the UIE with the given name and kind from the on_startup, on_tier, and on_any_tier dictionaries. Ignores all exceptions.
Parameters:
  • name (string) - Name of the UIE, unique across all UIEs of the same kind
  • kind (string) - Kind of UIE, one of ALL_KINDS, or None to indicate the kind is unknown and all kinds should be searched

listStartup(self, kind)

source code 
Gets a list of all UIE names of the given kind that are to be loaded at SUE startup.
Parameters:
  • kind (string) - Kind of UIE, one of ALL_KINDS
Returns: list of string
Names of all UIEs to be loaded at SUE startup

listAETierMap(self, kind)

source code 
Gets a list of all UIE names of the given kind paired with the names of the AETiers on which they will load.
Parameters:
  • kind (string) - Kind of UIE, one of ALL_KINDS
Returns: dictionary of string : list
Lists of AEScript names associated with AETier names

listAETier(self, kind, tier=None)

source code 
Gets a list of all UIE names of the given kind that are to be loaded when a AETier with the given name is created. If the given AETier name is None, then list all UIEs to be loaded for particular AETiers.
Parameters:
  • kind (string) - Kind of UIE, one of ALL_KINDS
  • tier (string) - Name of the AETier
Returns: list of string
Names of all UIEs to be loaded at AETier creation time

listAnyAETier(self, kind)

source code 
Gets a list of all UIE names of the given kind that are to be loaded when any AETier is created.
Parameters:
  • kind (string) - Kind of UIE, one of ALL_KINDS
Returns: list of string
Names of all UIEs to be loaded at AETier creation time

   Trees       Indices       Help   
SUE - Revision 232
Generated by Epydoc 3.0beta1 on Mon Jun 30 13:05:56 2008 http://epydoc.sourceforge.net