Logo Search packages:      
Sourcecode: zope-cmfmember version File versions  Download package

member.py

try:
    from Interface import Interface
except ImportError:
    # for Zope versions before 2.6.0
    from Interface import Base as Interface

try:
    from Products.CMFPlone import utils as plone_utils
except ImportError:
    from Products.CMFPlone import PloneUtilities as plone_utils

from Products.Archetypes.utils import shasattr

00014 class IMember(Interface):
    """
    User object integration. Contract w/CMF regarding Member object
    behavior. A Member is a wrapped user object.
    """
    
00020     def getPassword():
        """ Gets the password for a Member. """
        pass
        
00024     def getRawGroups():
        """ Fetches the Group names from GRUF with prefix. """
        pass
        
00028     def getRoles():
        """ Return the list of roles assigned to a Member. """
        pass
        
00032     def setRoles(roles):
        """ Assign a set of roles to a Member. """
        pass
        
00036     def getRolesInContext(object):
        """ 
        Return the list of roles assigned to a Member
        in the context of an object. 
        """
        pass
    
00043     def getUser():
        """ Return the user object associated with the Member. """
        pass
        
00047     def getUserName():
        """ Gets the Member object, then return the username of the Member. """
        pass
        
00051     def hasUser():
        """
        Returns 1 if there is a real acl_users user associated with
        this Member, 0 if there is a temporary internal one.
        """
        pass
        
00058     def has_role(roles, object=None):
        """ 
        Check to see if a user has a given role or roles. 
        Passing an object examines the Local Roles on that object.
        """
        pass
        
00065     def isOrphan():
        """ Returns 1 if a Member has been orphaned and 0 if not. """
        pass
        
00069     def setGroups(groups):
        """ Assigns the groups to the Member using GRoupUserFolder. """
        pass
        
00073     def getGroups():
        """ Returns the groups from GRUF. """
        pass
        
00077     def setMemberProperties(props):
        """ 
        Assigns keyword arguments as properties of a Member for
        compatibility to CMFCore Member handling.
        """
        pass
        
00084     def setUser(user):
        """ Set the Member's user object. """
        pass
    
00088     def setDomains(domains):
        """ Sets domain restrictions in the Security Profile of a Member. """
        pass
        
00092     def getDomains():
        """ Return the list of domain restrictions for a Member. """
        pass
    
00096     def valid_groups():
        """ Returns a list of valid groups from GRUF. """
        pass
        
00100     def valid_roles():
        """ Returns a list of valid roles for Members. """
        pass
        
00104     def getEmail():
        """ Returns the email address of a Member. """
        pass
        
00108     def getLast_login_time():
        """ Returns the time the Member last logged into the system. """
        pass
        
00112     def setLast_login_time(last_login_time):
        """ Sets the time of the most recent login. """
        pass

00116     def getMemberId():
        """ Returns the Id of the Member. """
        pass
        
00120     def setSecurityProfile(password=None, roles=None, domains=None):
        """ Sets the security profile attributes of the Member. """
        pass
        
00124     def getId():
        """ Accessor for the ID field of a Member. """
        pass
        
00128     def getProperty(id, default):
        """ Return user property by using the accessor for the property. """
        pass
            
00132 class IMemberPlone(Interface):
    """
      Contract with Plone (i.e. in addition to IMember) regarding Member object.
      These are the default fields for a Plone Member.
    """
00137     def getFullname():
        """ Accessor for the fullname field. """
        pass
        
00141     def setFullname(fullname):
        """ Mutator for the fullname field. """
        pass
 
00145     def getVisible_ids():
        """ Accessor for the visible_ids field. """
        pass
        
00149     def setVisible_ids(visible_ids):
        """ Mutator for the visible_ids field. """
        pass
        
00153     def getWysiwyg_editor():
        """ Accessor for the WYSIWYG editor field. """
        pass
        
00157     def setWysiwyg_editor(editor):
        """ Mutator for the WYSIWYG editor field. """
        pass
        
00161     def getPortrait():
        """ Accessor for the portrait field. """
        pass
        
00165     def setPortrait(portraitfile):
        """ Mutator for the portrait field. """
        pass

    if shasattr(plone_utils, 'getFSVersionTuple') and \
       plone_utils.getFSVersionTuple >= (2, 1):
        
00172         def getHome_page():
            """ Accessor for the home_page field """
            pass

00176         def setHome_page(home_page):
            """ Mutator for the home_page field """
            pass

00180         def getLocation():
            """ Accessor for the location field """
            pass

00184         def setLocation(home_page):
            """ Mutator for the location field """
            pass

00188         def getLanguage(home_page):
            """ Accessor for the language field """
            pass

00192         def setLanguage(home_page):
            """ Mutator for the language field """
            pass

Generated by  Doxygen 1.6.0   Back to index