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.impl.generic.core
Class User

java.lang.Object
  extended by com.perforce.p4java.impl.generic.core.ServerResource
      extended by com.perforce.p4java.impl.generic.core.UserSummary
          extended by com.perforce.p4java.impl.generic.core.User
All Implemented Interfaces:
IServerResource, IUser, IUserSummary
public class User
extends UserSummary
implements IUser

Simple default IUser implementation class.

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.perforce.p4java.core.IUserSummary
IUserSummary.UserType
 
Field Summary
 
Fields inherited from class com.perforce.p4java.impl.generic.core.UserSummary
passwordChange, ticketExpiration, type
 
Fields inherited from class com.perforce.p4java.impl.generic.core.ServerResource
refreshable, server, updateable
 
Constructor Summary
User()
          Default constructor -- sets all summary and extended fields to null.
User(Map<String,Object> map, IServer server)
          Constructs a User from the passed-in map.
User(String loginName, String email, String fullName, Date access, Date update, String password, String jobView, IUserSummary.UserType type, ViewMap<IReviewSubscription> reviewSubscriptions)
          Explicit-value constructor.
User(String loginName, String email, String fullName, Date access, Date update, String password, String jobView, ViewMap<IReviewSubscription> reviewSubscriptions)
          Explicit-value constructor.
 
Method Summary
 String getJobView()
           
 String getPassword()
           
 ViewMap<IReviewSubscription> getReviewSubscriptions()
           
static User newUser(String name, String email, String fullName, 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(String jobView)
           
 void setPassword(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.
 
Methods inherited from class com.perforce.p4java.impl.generic.core.UserSummary
getAccess, getEmail, getFullName, getLoginName, getPasswordChange, getTicketExpiration, getType, getUpdate, setAccess, setEmail, setFullName, setLoginName, setType, setUpdate
 
Methods inherited from class com.perforce.p4java.impl.generic.core.ServerResource
canRefresh, canUpdate, complete, setRefreshable, setServer, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
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, setServer, update
 

Constructor Detail

User

public User()
Default constructor -- sets all summary and extended fields to null.

User

public User(String loginName,
            String email,
            String fullName,
            Date access,
            Date update,
            String password,
            String jobView,
            ViewMap<IReviewSubscription> reviewSubscriptions)
Explicit-value constructor.

User

public User(String loginName,
            String email,
            String fullName,
            Date access,
            Date update,
            String password,
            String jobView,
            IUserSummary.UserType type,
            ViewMap<IReviewSubscription> reviewSubscriptions)
Explicit-value constructor.

User

public User(Map<String,Object> map,
            IServer server)
Constructs a User from the passed-in map. The map is assumed to come from a suitable call on IServer; if the map is null this is equivalent to calling the default constructor.

Method Detail

newUser

public static User newUser(String name,
                           String email,
                           String fullName,
                           String password)
Simple convenience factory method to create a new local User object with default (null) jobView and reviewSubscriptions fields.

Parameters:
name - non-null user name.
email - user's email address.
fullName - user's full name.
password - user's password (usually ignored).
Returns:
new local user object.

getPassword

public String getPassword()
Specified by:
getPassword in interface IUser
See Also:
IUser.getPassword()

setPassword

public void setPassword(String password)
Specified by:
setPassword in interface IUser
See Also:
IUser.setPassword(java.lang.String)

getJobView

public String getJobView()
Specified by:
getJobView in interface IUser
See Also:
IUser.getJobView()

setJobView

public void setJobView(String jobView)
Specified by:
setJobView in interface IUser
See Also:
IUser.setJobView(java.lang.String)

getReviewSubscriptions

public ViewMap<IReviewSubscription> getReviewSubscriptions()
Specified by:
getReviewSubscriptions in interface IUser
See Also:
IUser.getReviewSubscriptions()

setReviewSubscriptions

public void setReviewSubscriptions(ViewMap<IReviewSubscription> reviewSubscriptions)
Specified by:
setReviewSubscriptions in interface IUser
See Also:
IUser.setReviewSubscriptions(com.perforce.p4java.core.ViewMap)

refresh

public void refresh()
             throws ConnectionException,
                    RequestException,
                    AccessException
Description copied from interface: IServerResource
Refresh the underlying object from the Perforce server.

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).

Specified by:
refresh in interface IServerResource
Overrides:
refresh in class ServerResource
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
See Also:
ServerResource.refresh()

update

public void update()
            throws ConnectionException,
                   RequestException,
                   AccessException
Description copied from interface: IServerResource
Update the Perforce server object associated with the underlying P4Java object, if possible. The semantics of server updates are generally object-specific and will be spelled out for each participating object.

The results of calling this method on objects whose canUpdate method returns false are undefined (but will generally result in a UnimplementedError being thrown).

Specified by:
update in interface IServerResource
Overrides:
update in class ServerResource
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
See Also:
ServerResource.update()

update

public void update(boolean force)
            throws ConnectionException,
                   RequestException,
                   AccessException
Description copied from interface: IServerResource
Force (if true) update the Perforce server object associated with the underlying P4Java object, if possible. The semantics of server updates are generally object-specific and will be spelled out for each participating object.

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).

Specified by:
update in interface IServerResource
Specified by:
update in interface IUser
Overrides:
update in class ServerResource
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
See Also:
IServerResource.update(boolean)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2015 Perforce Software. All Rights Reserved.