public class User extends UserSummary implements IUser
IUserSummary.UserType
passwordChange, ticketExpiration, type
refreshable, server, updateable
Constructor and Description |
---|
User()
Default constructor -- sets all summary and extended
fields to null.
|
User(java.util.Map<java.lang.String,java.lang.Object> map,
IServer server)
Constructs a User from the passed-in map.
|
User(java.lang.String loginName,
java.lang.String email,
java.lang.String fullName,
java.util.Date access,
java.util.Date update,
java.lang.String password,
java.lang.String jobView,
IUserSummary.UserType type,
ViewMap<IReviewSubscription> reviewSubscriptions)
Explicit-value constructor.
|
User(java.lang.String loginName,
java.lang.String email,
java.lang.String fullName,
java.util.Date access,
java.util.Date update,
java.lang.String password,
java.lang.String jobView,
ViewMap<IReviewSubscription> reviewSubscriptions)
Explicit-value constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getJobView() |
java.lang.String |
getPassword() |
ViewMap<IReviewSubscription> |
getReviewSubscriptions() |
static User |
newUser(java.lang.String name,
java.lang.String email,
java.lang.String fullName,
java.lang.String password)
Simple convenience factory method to create a new local User object
with default (null) jobView and reviewSubscriptions fields.
|
void |
refresh()
Refresh the underlying object from the Perforce server.
|
void |
setJobView(java.lang.String jobView) |
void |
setPassword(java.lang.String password) |
void |
setReviewSubscriptions(ViewMap<IReviewSubscription> reviewSubscriptions) |
void |
update()
Update the Perforce server object associated with the underlying P4Java object,
if possible.
|
void |
update(boolean force)
Force (if true) update the Perforce server object associated with the underlying
P4Java object, if possible.
|
getAccess, getEmail, getFullName, getLoginName, getPasswordChange, getTicketExpiration, getType, getUpdate, setAccess, setEmail, setFullName, setLoginName, setType, setUpdate
canRefresh, canUpdate, clearRawFields, complete, getRawField, getRawFields, hasRawField, parseDate, setRawField, setRawFields, setRefreshable, setServer, toDateString, update
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAccess, getEmail, getFullName, getLoginName, getPasswordChange, getTicketExpiration, getType, getUpdate, setAccess, setEmail, setFullName, setLoginName, setType, setUpdate
canRefresh, canUpdate, clearRawFields, complete, getRawField, getRawFields, hasRawField, setRawField, setRawFields, setServer, update
public User()
public User(java.lang.String loginName, java.lang.String email, java.lang.String fullName, java.util.Date access, java.util.Date update, java.lang.String password, java.lang.String jobView, ViewMap<IReviewSubscription> reviewSubscriptions)
loginName
- loginNameemail
- emailfullName
- fullNameaccess
- accessupdate
- updatepassword
- passwordjobView
- jobViewreviewSubscriptions
- reviewSubscriptionspublic User(java.lang.String loginName, java.lang.String email, java.lang.String fullName, java.util.Date access, java.util.Date update, java.lang.String password, java.lang.String jobView, IUserSummary.UserType type, ViewMap<IReviewSubscription> reviewSubscriptions)
loginName
- loginNameemail
- emailfullName
- fullNameaccess
- accessupdate
- updatepassword
- passwordjobView
- jobViewtype
- typereviewSubscriptions
- reviewSubscriptionspublic User(java.util.Map<java.lang.String,java.lang.Object> map, IServer server)
map
- spec mapserver
- serverpublic static User newUser(java.lang.String name, java.lang.String email, java.lang.String fullName, java.lang.String password)
name
- non-null user name.email
- user's email address.fullName
- user's full name.password
- user's password (usually ignored).public java.lang.String getPassword()
getPassword
in interface IUser
IUser.getPassword()
public void setPassword(java.lang.String password)
setPassword
in interface IUser
IUser.setPassword(java.lang.String)
public java.lang.String getJobView()
getJobView
in interface IUser
IUser.getJobView()
public void setJobView(java.lang.String jobView)
setJobView
in interface IUser
IUser.setJobView(java.lang.String)
public ViewMap<IReviewSubscription> getReviewSubscriptions()
getReviewSubscriptions
in interface IUser
IUser.getReviewSubscriptions()
public void setReviewSubscriptions(ViewMap<IReviewSubscription> reviewSubscriptions)
setReviewSubscriptions
in interface IUser
IUser.setReviewSubscriptions(com.perforce.p4java.core.ViewMap)
public void refresh() throws ConnectionException, RequestException, AccessException
IServerResource
The details of what "refreshable" means in this context are always object-dependent, but typically mean that "live" data and metadata will be updated from the server.
The results of calling this method on objects whose canRefresh method returns false are undefined (but will generally result in a UnimplementedError being thrown).
refresh
in interface IServerResource
refresh
in class ServerResource
ConnectionException
- if the Perforce server is unreachable or is not
connected.RequestException
- if the Perforce server encounters an error during
its processing of the requestAccessException
- if the Perforce server denies access to the callerServerResource.refresh()
public void update() throws ConnectionException, RequestException, AccessException
IServerResource
The results of calling this method on objects whose canUpdate method returns false are undefined (but will generally result in a UnimplementedError being thrown).
update
in interface IServerResource
update
in class ServerResource
ConnectionException
- if the Perforce server is unreachable or is not
connected.RequestException
- if the Perforce server encounters an error during
its processing of the requestAccessException
- if the Perforce server denies access to the callerServerResource.update()
public void update(boolean force) throws ConnectionException, RequestException, AccessException
IServerResource
Note, in order to force the change it may require super user / admin privileges to work properly.
The results of calling this method on objects whose canUpdate method returns false are undefined (but will generally result in a UnimplementedError being thrown).
update
in interface IServerResource
update
in interface IUser
update
in class ServerResource
force
- if true, force the update of the object on the server.ConnectionException
- if the Perforce server is unreachable or is not
connected.RequestException
- if the Perforce server encounters an error during
its processing of the requestAccessException
- if the Perforce server denies access to the callerIServerResource.update(boolean)