IUser (Perforce Java API 2015.1.1210280 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.perforce.p4java.core
Interface IUser

All Superinterfaces:: IServerResource, IUserSummary

All Known Implementing Classes:: User

public interface IUser
extends IUserSummary
extends IUserSummary

Defines a full Perforce user object. See the main Perforce documentation for full usage and semantics.

IUser objects are complete and updateable only if they come from the IServer.getUser() method (or are hand-crafted); user objects from other sources are not complete or completable, and nor are they refreshable. Setter methods defined below or on the superclass affect only local values unless a suitable update is done.

Nested Class Summary

Nested classes/interfaces inherited from interface com.perforce.p4java.core.IUserSummary
`IUserSummary.UserType`

Method Summary
`String`	`getJobView()`
`String`	`getPassword()`
`ViewMap<IReviewSubscription>`	`getReviewSubscriptions()`
`void`	`setJobView(String jobView)`
`void`	`setPassword(String password)`
`void`	`setReviewSubscriptions(ViewMap<IReviewSubscription> subs)`
`void`	`update(boolean force)` Updates this user on the Perforce server; if force is true, force the change (requires super user / admin privileges to work properly).

Methods inherited from interface com.perforce.p4java.core.IUserSummary
`getAccess, getEmail, getFullName, getLoginName, getPasswordChange, getTicketExpiration, getType, getUpdate, setAccess, setEmail, setFullName, setLoginName, setType, setUpdate`

Methods inherited from interface com.perforce.p4java.core.IServerResource
`canRefresh, canUpdate, refresh, setServer, update, update`

Method Detail

getPassword

String getPassword()

setPassword

void setPassword(String password)

getJobView

String getJobView()

setJobView

void setJobView(String jobView)

getReviewSubscriptions

ViewMap<IReviewSubscription> getReviewSubscriptions()

setReviewSubscriptions

void setReviewSubscriptions(ViewMap<IReviewSubscription> subs)

update

void update(boolean force)
            throws ConnectionException,
                   RequestException,
                   AccessException

Updates this user on the Perforce server; if force is true, force the change (requires super user / admin privileges to work properly). This method is supplied in addition to the normal IServerRespurce.update() method since that method is always called with force set to false.

Specified by:: update in interface IServerResource

Parameters:: force - if true, force the update of the object on the server.
Throws:: ConnectionException - if the Perforce server is unreachable or is not connected.; RequestException - if the Perforce server encounters an error during its processing of the request; AccessException - if the Perforce server denies access to the caller