com.plumtree.server
Interface IPTUserManager

public interface IPTUserManager

Used to perform administrative tasks on users

Author:

michaels

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.
void	DeleteUserPasswordHistory(int lUserID) Deletes the password history for the specified user.
IPTQueryResult	GetLockedAccounts(java.lang.String bstrDescription, int nSkipRows, int nMaxRows) Returns a QueryResult that lists the users that have been locked.
boolean	IsPasswordInHistory(int lUserID, java.lang.String strPassword, int lHistoryLength) Check whether the new password is already present in the user's password history or not.
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.
void	UpdatePasswordHistory(int lUserID, java.lang.String strPassword) Updates the password history row for this user with the new password.

Method Detail

GetLockedAccounts

IPTQueryResult GetLockedAccounts(java.lang.String bstrDescription,
                                 int nSkipRows,
                                 int nMaxRows)

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.) This also happens when the "disable" user instead of "delete" user option is turned on in an Authentication Source. In this case users are "agent disabled" as opposed to deleted.

The QueryResult contains these properties: PT_PROPID_OBJECTID, PT_PROPID_NAME, PT_PROPID_USER_LOGINNAME, PT_PROPID_DESCRIPTION, PT_PROPID_FOLDERID, PT_PROPID_CREATED, PT_PROPID_USERLOCKEDACCOUNTS_LOCKCANEXPIRE.

Parameters:

bstrDescription - filters on locked account description, or the reason the account was locked

nSkipRows - number of rows to skip at the beginning, or 0 for none

nMaxRows - maximum number of rows to return, or -1 for all

Returns:

the queryresult describing the locked users

AcceptInvitation

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

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

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

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.

UpdatePasswordHistory

void UpdatePasswordHistory(int lUserID,
                           java.lang.String strPassword)

Updates the password history row for this user with the new password.

Parameters:

lUserID - the user to update

strPassword - the new password to store

IsPasswordInHistory

boolean IsPasswordInHistory(int lUserID,
                            java.lang.String strPassword,
                            int lHistoryLength)

Check whether the new password is already present in the user's password history or not.

Parameters:

lUserID - the user to check

strPassword - the new password to validate

lHistoryLength - the number of stored passwords to check

Returns:

whether or not the password is already in the user's password history.

DeleteUserPasswordHistory

void DeleteUserPasswordHistory(int lUserID)

Deletes the password history for the specified user. This should be done when the user is deleted.

Parameters:

lUserID - the user ID for password history deletion.