com.plumtree.server
Interface IPTUserManager


public interface IPTUserManager

Used to perform administrative tasks on users

See Also:
IPTUser

Method Summary
 IPTSession AcceptInvitation(java.lang.String sInvitationCode, java.lang.String sProposedUserName, java.lang.String sProposedPassword)
          An invitation is a token that can be sent to a potential user.
 void AddAdminFolderShortcut(int lNewFolderIDShortcut)
          AdminFolderShortcuts are favorite admin folders associated with the current user.
 IPTQueryResult GetLockedAccounts()
          Returns a QueryResult that lists the users that have been locked.
 IPTQueryResult QueryAdminFolderShortcuts()
          AdminFolderShortcuts are favorite admin folders associated with the current user.
 void RemoveAdminFolderShortcut(int lFolderIDShortcut)
          AdminFolderShortcuts are favorite admin folders associated with the current user.
 

Method Detail

GetLockedAccounts

public IPTQueryResult GetLockedAccounts()
Returns a QueryResult that lists the users that have been locked. Users may be locked through IPTUser.SetLockStatus. This may happen when a security violation is suspected (for example when an employee is terminated, or when a user has attempted to login with incorrect passwords a number of times.) The QueryResult contains these properties: PT_PROPID_OBJECTID, PT_PROPID_DESCRIPTION, PT_PROPID_FOLDERID, PT_PROPID_CREATED, PT_PROPID_USERLOCKEDACCOUNTS_LOCKCANEXPIRE.
Returns:
the queryresult describing the locked users

AcceptInvitation

public IPTSession AcceptInvitation(java.lang.String sInvitationCode,
                                   java.lang.String sProposedUserName,
                                   java.lang.String sProposedPassword)
An invitation is a token that can be sent to a potential user. The potential user can then use the token to create a user that has characteristics specified by the token creator.
Parameters:
sInvitationCode - the token to be used to create the user
sProposedUserName - the name for the new user
sProposedPassword - the password for the new user
Returns:
TODO: DOCUMENT_ME

AddAdminFolderShortcut

public void AddAdminFolderShortcut(int lNewFolderIDShortcut)
AdminFolderShortcuts are favorite admin folders associated with the current user. The UI may display these favorites as links to the associated admin folders. Call this function to add a new admin folder to the list of favorites for the current user.
Parameters:
lNewFolderIDShortcut - the ID of the admin folder to add

RemoveAdminFolderShortcut

public void RemoveAdminFolderShortcut(int lFolderIDShortcut)
AdminFolderShortcuts are favorite admin folders associated with the current user. The UI may display these favorites as links to the associated admin folders. Call this function remove an admin folder from the list of favorites for the current user
Parameters:
lFolderIDShortcut - the ID of the admin folder to remove

QueryAdminFolderShortcuts

public IPTQueryResult QueryAdminFolderShortcuts()
AdminFolderShortcuts are favorite admin folders associated with the current user. The UI may display these favorites as links to the associated admin folders. Call this function to retrieve a QueryResult containing information about the AdminFolderShortcuts for the current user. The QueryResult will include PT_PROPID_OBJECTID, PT_PROPID_NAME, and PT_PROPID_ISLOCALIZED.
Returns:
a QueryResult describing the shortcuts for the current user.


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.