com.ptc.netmarkets.user
Interface NmUserService

All Known Implementing Classes:

NmUserServiceFwd, StandardNmUserService

public interface NmUserService

Supported API: false

Extendable: false

Method Summary

NmChangeModel[]	addToAdmin(NmCommandBean cb, ArrayList users) Supported API: false
NmDefaultHTMLTable	checkedOutStuff(NmCommandBean cb) Supported API: false
ArrayList	findOrgGroups(NmCommandBean cb, String query, int maxCount, int clientType) Supported API: false
ArrayList	findOrgUsers(NmCommandBean cb, String query, int maxCount, int clientType) Searches the user repository and returns an ArrayList containing all users whose common name attribute contains the passed in query.
ArrayList	getAdminRowData(NmUser nmUser) Supported API: false
TimeZone	getLocalTimeZoneForUser() Supported API: false
TimeZone	getLocalTimeZoneForUser(WTPrincipal user) Get the preferred TimeZone for the specified user.
String	getLocalTimeZoneStringForUser() Supported API: false
NmUser	getNmUser(WTUser user, WTContainer container) Supported API: false
NmUser	getNmUserLastFirst(WTUser user, ContainerTeamManaged container) Supported API: false
NmUser	getNmUserRegistered(WTUser user) Supported API: false
NmUser	getNmUserRegisteredLastFirst(WTUser user) Supported API: false
WTUser	getProjectUserByEmail(NmOid nmprojectoid, String email) Returns the WTUser object of the user identified by the passed in email from the current project.
WTUser	getProjectUserByEmail(Project2 project, String email) Returns the WTUser object of the user identified by the passed in email from the current project.
String[][]	getTimeZoneStrings() Supported API: false
String	getUserName() Supported API: false
String	getUserOrgName() Supported API: false
NmOid	getUserOrgOid() Supported API: false
ArrayList	getUserToProfile(NmCommandBean cb) gets the user's directory attributes (index 0) and local time zone (index 1) for the user on the url if the user has access else the current user Supported API: false
boolean	hasProjectLinkAccess() Supported API: false
boolean	isExchangeAdmin() Supported API: false
boolean	isOrgAdmin(NmCommandBean cb) Supported API: false
boolean	isOrgAdmin(NmOid containerOid) Supported API: false
boolean	isOrgAdmin(WTContainer container) Supported API: false
NmDefaultHTMLTable	listAdmin(NmCommandBean cb) Supported API: false
NmDefaultHTMLTable	listUserEvents(NmCommandBean cb) Supported API: false
void	processSwitchFormSubmittal(String signature, String invitedEmail, String registeredEmail, String dnToSwitch, String projectOID) Supported API: false
NmChangeModel[]	removeFromAdmin(NmCommandBean cb, NmOid userOid) Supported API: false
NmChangeModel[]	removeUserFromRole(NmCommandBean cb) Supported API: false
NmChangeModel[]	replaceUserInProject(NmCommandBean cb, ArrayList users) Replaces the selected user with the new user.
void	resolveAmbiguousEmail(String existingUserRefString, String newUserRefString, NmOid nmprojectoid) Searches the user repository and returns an ArrayList containing all users whose common name attribute contains the passed in query.
void	sendSwitchForm(String invitedEmail, String registeredEmail, String projectOID, String dnToSwitch) Supported API: false
void	setLocalTimeZoneForUser(String zoneID) Supported API: false
void	setLocalTimeZoneForUser(TimeZone zone) Supported API: false
NmUser	setUserProperties(NmOid userOid, WTContainer container) Supported API: false
String	signMessage(String msg) Supported API: false
ArrayList	userHasCheckouts(NmCommandBean cb, NmOid projectOid, NmOid userOid) Returns null if the user does not have checkouts.
boolean	verifySignedMessage(String msg, String signature) Supported API: false
NmModel	view(NmCommandBean cb) Supported API: false

Method Detail

removeUserFromRole

public NmChangeModel[] removeUserFromRole(NmCommandBean cb)
                                   throws WTException

Supported API: false

Parameters:

cb -

Returns:

NmChangeModel[]

Throws:

WTException

view

public NmModel view(NmCommandBean cb)
             throws WTException

Supported API: false

Parameters:

cb -

Returns:

NmModel

Throws:

WTException

sendSwitchForm

public void sendSwitchForm(String invitedEmail,
                           String registeredEmail,
                           String projectOID,
                           String dnToSwitch)
                    throws WTException

Supported API: false

Parameters:

invitedEmail -

registeredEmail -

projectOID -

dnToSwitch -

Throws:

WTException

processSwitchFormSubmittal

public void processSwitchFormSubmittal(String signature,
                                       String invitedEmail,
                                       String registeredEmail,
                                       String dnToSwitch,
                                       String projectOID)
                                throws WTException

Supported API: false

Parameters:

signature -

invitedEmail -

registeredEmail -

dnToSwitch -

projectOID -

Throws:

WTException

checkedOutStuff

public NmDefaultHTMLTable checkedOutStuff(NmCommandBean cb)
                                   throws WTException

Supported API: false

Parameters:

cb -

Returns:

NmDefaultHTMLTable

Throws:

WTException

listUserEvents

public NmDefaultHTMLTable listUserEvents(NmCommandBean cb)
                                  throws WTException

Supported API: false

Parameters:

cb -

Returns:

NmDefaultHTMLTable

Throws:

WTException

setUserProperties

public NmUser setUserProperties(NmOid userOid,
                                WTContainer container)
                         throws WTException

Supported API: false

Parameters:

userOid -

container -

Returns:

NmUser

Throws:

WTException

setLocalTimeZoneForUser

public void setLocalTimeZoneForUser(TimeZone zone)
                             throws WTException

Supported API: false

Parameters:

zone -

Throws:

WTException

setLocalTimeZoneForUser

public void setLocalTimeZoneForUser(String zoneID)
                             throws WTException

Supported API: false

Parameters:

zoneID -

Throws:

WTException

getLocalTimeZoneForUser

public TimeZone getLocalTimeZoneForUser()
                                 throws WTException

Supported API: false

Returns:

TimeZone

Throws:

WTException

getLocalTimeZoneForUser

public TimeZone getLocalTimeZoneForUser(WTPrincipal user)
                                 throws WTException

Get the preferred TimeZone for the specified user.

Supported API: false

Parameters:

user -

Returns:

TimeZone

Throws:

WTException

getLocalTimeZoneStringForUser

public String getLocalTimeZoneStringForUser()
                                     throws WTException

Supported API: false

Returns:

String

Throws:

WTException

getTimeZoneStrings

public String[][] getTimeZoneStrings()
                              throws WTException

Supported API: false

Returns:

String[][]

Throws:

WTException

getUserName

public String getUserName()
                   throws WTException

Supported API: false

Returns:

String

Throws:

WTException

getUserOrgName

public String getUserOrgName()
                      throws WTException

Supported API: false

Returns:

String

Throws:

WTException

findOrgUsers

public ArrayList findOrgUsers(NmCommandBean cb,
                              String query,
                              int maxCount,
                              int clientType)
                       throws WTException

Searches the user repository and returns an ArrayList containing all users whose common name attribute contains the passed in query. All users returned are from the current session principals organization, or if the current session principal is an exchange admin and the current project is an organization, the users returned belong to the organization that is set as the current project.

Supported API: false

Parameters:

cb -

query -

maxCount -

clientType -

Returns:

ArrayList

Throws:

WTException

resolveAmbiguousEmail

public void resolveAmbiguousEmail(String existingUserRefString,
                                  String newUserRefString,
                                  NmOid nmprojectoid)
                           throws WTException

Searches the user repository and returns an ArrayList containing all users whose common name attribute contains the passed in query. All users returned are from the current session principals organization only.

Supported API: false

Parameters:

existingUserRefString -

newUserRefString -

nmprojectoid -

Throws:

WTException

getProjectUserByEmail

public WTUser getProjectUserByEmail(NmOid nmprojectoid,
                                    String email)
                             throws WTException

Returns the WTUser object of the user identified by the passed in email from the current project.

Supported API: false

Parameters:

nmprojectoid -

email -

Returns:

WTUser

Throws:

WTException

getProjectUserByEmail

public WTUser getProjectUserByEmail(Project2 project,
                                    String email)
                             throws WTException

Returns the WTUser object of the user identified by the passed in email from the current project.

Supported API: false

Parameters:

project -

email -

Returns:

WTUser

Throws:

WTException

replaceUserInProject

public NmChangeModel[] replaceUserInProject(NmCommandBean cb,
                                            ArrayList users)
                                     throws WTException

Replaces the selected user with the new user.

Supported API: false

Parameters:

cb -

users -

Returns:

NmChangeModel[]

Throws:

WTException

userHasCheckouts

public ArrayList userHasCheckouts(NmCommandBean cb,
                                  NmOid projectOid,
                                  NmOid userOid)
                           throws WTException

Returns null if the user does not have checkouts.

Supported API: false

Parameters:

cb -

projectOid -

userOid -

Returns:

ArrayList

Throws:

WTException

getNmUser

public NmUser getNmUser(WTUser user,
                        WTContainer container)
                 throws WTException

Supported API: false

Parameters:

user -

container -

Returns:

NmUser

Throws:

WTException

getNmUserRegistered

public NmUser getNmUserRegistered(WTUser user)
                           throws WTException

Supported API: false

Parameters:

user -

Returns:

NmUser

Throws:

WTException

getNmUserLastFirst

public NmUser getNmUserLastFirst(WTUser user,
                                 ContainerTeamManaged container)
                          throws WTException

Supported API: false

Parameters:

user -

container -

Returns:

NmUser

Throws:

WTException

getNmUserRegisteredLastFirst

public NmUser getNmUserRegisteredLastFirst(WTUser user)
                                    throws WTException

Supported API: false

Parameters:

user -

Returns:

NmUser

Throws:

WTException

isExchangeAdmin

public boolean isExchangeAdmin()
                        throws WTException

Supported API: false

Returns:

boolean

Throws:

WTException

getUserToProfile

public ArrayList getUserToProfile(NmCommandBean cb)
                           throws WTException

gets the user's directory attributes (index 0) and local time zone (index 1) for the user on the url if the user has access else the current user

Supported API: false

Parameters:

cb -

Returns:

ArrayList

Throws:

WTException

getUserOrgOid

public NmOid getUserOrgOid()
                    throws WTException

Supported API: false

Returns:

NmOid

Throws:

WTException

findOrgGroups

public ArrayList findOrgGroups(NmCommandBean cb,
                               String query,
                               int maxCount,
                               int clientType)
                        throws WTException

Supported API: false

Parameters:

cb -

query -

maxCount -

clientType -

Returns:

ArrayList

Throws:

WTException

signMessage

public String signMessage(String msg)
                   throws WTException

Supported API: false

Parameters:

msg -

Returns:

String

Throws:

WTException

verifySignedMessage

public boolean verifySignedMessage(String msg,
                                   String signature)
                            throws WTException

Supported API: false

Parameters:

msg -

signature -

Returns:

boolean

Throws:

WTException

listAdmin

public NmDefaultHTMLTable listAdmin(NmCommandBean cb)
                             throws WTException

Supported API: false

Parameters:

cb -

Returns:

NmDefaultHTMLTable

Throws:

WTException

removeFromAdmin

public NmChangeModel[] removeFromAdmin(NmCommandBean cb,
                                       NmOid userOid)
                                throws WTException

Supported API: false

Parameters:

cb -

userOid -

Returns:

NmChangeModel[]

Throws:

WTException

addToAdmin

public NmChangeModel[] addToAdmin(NmCommandBean cb,
                                  ArrayList users)
                           throws WTException

Supported API: false

Parameters:

cb -

users -

Returns:

NmChangeModel[]

Throws:

WTException

getAdminRowData

public ArrayList getAdminRowData(NmUser nmUser)
                          throws WTException

Supported API: false

Parameters:

nmUser -

Returns:

ArrayList

Throws:

WTException

hasProjectLinkAccess

public boolean hasProjectLinkAccess()
                             throws WTException

Supported API: false

Returns:

boolean

Throws:

WTException

isOrgAdmin

public boolean isOrgAdmin(WTContainer container)
                   throws WTException

Supported API: false

Parameters:

container -

Returns:

boolean

Throws:

WTException

isOrgAdmin

public boolean isOrgAdmin(NmOid containerOid)
                   throws WTException

Supported API: false

Parameters:

containerOid -

Returns:

boolean

Throws:

WTException

isOrgAdmin

public boolean isOrgAdmin(NmCommandBean cb)
                   throws WTException

Supported API: false

Parameters:

cb -

Returns:

boolean

Throws:

WTException