/* * Copyright 2009 Perforce Software Inc., All Rights Reserved. */ package com.perforce.p4java.core; import java.util.Date; import com.perforce.p4java.Log; /** * Defines a Perforce user summary as returned from an IServer * getUsers method and similar. IUserSummary objects contain * only the summary information returned by the p4 users * command; to get the full user information from the server, * use the IUser interface returned from getUser, etc. * * Fields and methods below are basically self-explanatory * and more detailed documentation can be found in the main * p4 documentation. Note that any or all of these methods * are allowed to return null.<p> * * IUserSummary objects are complete and neither refreshable nor updateable.<p> */ public interface IUserSummary extends IServerResource { /** * Describes the type (service or standard) of this user. * * @since 2011.1 */ public enum UserType { STANDARD, OPERATOR, SERVICE, UNKNOWN; /** * Return a suitable User type as inferred from the passed-in * string, which is assumed to be the string form of a User type. * Otherwise return the UNKNOWN type */ public static UserType fromString(String str) { if (str == null) { return null; } try { return UserType.valueOf(str.toUpperCase()); } catch (IllegalArgumentException iae) { Log.error("Bad conversion attempt in UserType.fromString; string: " + str + "; message: " + iae.getMessage()); Log.exception(iae); return UNKNOWN; } } }; String getLoginName(); void setLoginName(String loginName); Date getUpdate(); void setUpdate(Date update); Date getAccess(); void setAccess(Date access); String getFullName(); void setFullName(String fullName); String getEmail(); void setEmail(String email); /** * Get the UserType associated with this user. May return * null if no type was set. * * @since 2011.1 */ UserType getType(); /** * Set the UserType associated with this user. * * @since 2011.1 */ void setType(UserType type); /** * Get the date the ticket associated with this summary user expires.<p> * * This field will only be non-null if a) the user summary object * it's a part of was retrieved using the IOptionsServer.getUsers method * with the GetUsersOptions().setExtendedOutput option set to true; * b) the caller was a super-user or admin; and, c) the Perforce * server was 2011.1 or above. <b>In all other cases the value * of this field is either null or not reliable</b>. * * This is a read-only field synthesized by the Perforce server, and * can not be meaningfully set in the client. * * @since 2011.1 * @return possibly-null Date object. */ Date getTicketExpiration(); /** * Get the date the password associated with this summary user expires.<p> * * This field will only be non-null if a) the user summary object * it's a part of was retrieved using the IOptionsServer.getUsers method * with the GetUsersOptions().setExtendedOutput option set to true; * b) the caller was a super-user or admin; and, c) the Perforce * server was 2011.1 or above. <b>In all other cases the value * of this field is either null or not reliable</b>. * * This is a read-only field synthesized by the Perforce server, and * can not be meaningfully set in the client. * * @since 2011.1 * @return possibly-null Date object. */ Date getPasswordChange(); }
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 19903 | stuartrowe |
Branching //guest/perforce_software/p4java/... to //guest/stuartrowe/p4java/... |
||
//guest/perforce_software/p4java/r14.1/src/main/java/com/perforce/p4java/core/IUserSummary.java | |||||
#1 | 12541 | Matt Attaway | Initial add of the 14.1 p4java source code |