Package com.perforce.p4java.impl.generic.core

Class UserSummary

java.lang.Object

com.perforce.p4java.impl.generic.core.ServerResource

com.perforce.p4java.impl.generic.core.UserSummary

All Implemented Interfaces:

IServerResource, IUserSummary

Direct Known Subclasses:

User

public class UserSummary
extends ServerResource
implements IUserSummary

Default implementation class for IUserSummary interface.

Nested Class Summary

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

IUserSummary.UserType

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Date	passwordChange
protected java.util.Date	ticketExpiration
protected IUserSummary.UserType	type

Fields inherited from class com.perforce.p4java.impl.generic.core.ServerResource

refreshable, server, updateable

Constructor Summary

Constructors

Constructor	Description
UserSummary()	Default constructor; sets all fields to null or zero.
UserSummary(java.lang.String loginName, java.lang.String email, java.lang.String fullName, java.util.Date access, java.util.Date update)	Explicit-value constructor.
UserSummary(java.lang.String loginName, java.lang.String email, java.lang.String fullName, java.util.Date access, java.util.Date update, IUserSummary.UserType type)	Explicit-value constructor.
UserSummary(java.util.Map<java.lang.String,java.lang.Object> map, boolean summaryOnly)	Construct a UserSummary from the passed-in map and summaryOnly values.

Method Summary

Modifier and Type	Method	Description
java.util.Date	getAccess()
java.lang.String	getEmail()
java.lang.String	getFullName()
java.lang.String	getLoginName()
java.util.Date	getPasswordChange()	Get the date the password associated with this summary user expires.
java.util.Date	getTicketExpiration()	Get the date the ticket associated with this summary user expires.
IUserSummary.UserType	getType()	Get the UserType associated with this user.
java.util.Date	getUpdate()
void	setAccess(java.util.Date access)
void	setEmail(java.lang.String email)
void	setFullName(java.lang.String fullName)
void	setLoginName(java.lang.String loginName)
void	setType(IUserSummary.UserType type)	Set the UserType associated with this user.
void	setUpdate(java.util.Date update)

Methods inherited from class com.perforce.p4java.impl.generic.core.ServerResource

canRefresh, canUpdate, clearRawFields, complete, getRawField, getRawFields, hasRawField, parseDate, refresh, setRawField, setRawFields, setRefreshable, setServer, toDateString, update, update, 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.IServerResource

canRefresh, canUpdate, clearRawFields, complete, getRawField, getRawFields, hasRawField, refresh, setRawField, setRawFields, setServer, update, update, update

Field Detail

type

protected IUserSummary.UserType type

ticketExpiration

protected java.util.Date ticketExpiration

passwordChange

protected java.util.Date passwordChange

Constructor Detail

UserSummary

public UserSummary()

Default constructor; sets all fields to null or zero.

UserSummary

public UserSummary(java.lang.String loginName,
                   java.lang.String email,
                   java.lang.String fullName,
                   java.util.Date access,
                   java.util.Date update)

Explicit-value constructor.

Parameters:

loginName - loginName

email - email

fullName - fullName

access - access

update - update

UserSummary

public UserSummary(java.lang.String loginName,
                   java.lang.String email,
                   java.lang.String fullName,
                   java.util.Date access,
                   java.util.Date update,
                   IUserSummary.UserType type)

Explicit-value constructor.

Parameters:

loginName - loginName

email - email

fullName - fullName

access - access

update - update

type - type

UserSummary

public UserSummary(java.util.Map<java.lang.String,java.lang.Object> map,
                   boolean summaryOnly)

Construct a UserSummary from the passed-in map and summaryOnly values. The map must have been returned from the Perforce server in response to a getUsers() or getUser (etc.) call; is summaryOnly is true, this is treated as a map that came from the getUseres method.

If map is null, this is equivalent to calling the default constructor.

Parameters:

map - spec map

summaryOnly - if true

Method Detail

getAccess

public java.util.Date getAccess()

Specified by:

getAccess in interface IUserSummary

See Also:

IUserSummary.getAccess()

getEmail

public java.lang.String getEmail()

Specified by:

getEmail in interface IUserSummary

See Also:

IUserSummary.getEmail()

getFullName

public java.lang.String getFullName()

Specified by:

getFullName in interface IUserSummary

See Also:

IUserSummary.getFullName()

getLoginName

public java.lang.String getLoginName()

Specified by:

getLoginName in interface IUserSummary

See Also:

IUserSummary.getLoginName()

getUpdate

public java.util.Date getUpdate()

Specified by:

getUpdate in interface IUserSummary

See Also:

IUserSummary.getUpdate()

setAccess

public void setAccess(java.util.Date access)

Specified by:

setAccess in interface IUserSummary

See Also:

IUserSummary.setAccess(java.util.Date)

setEmail

public void setEmail(java.lang.String email)

Specified by:

setEmail in interface IUserSummary

See Also:

IUserSummary.setEmail(java.lang.String)

setFullName

public void setFullName(java.lang.String fullName)

Specified by:

setFullName in interface IUserSummary

See Also:

IUserSummary.setFullName(java.lang.String)

setLoginName

public void setLoginName(java.lang.String loginName)

Specified by:

setLoginName in interface IUserSummary

See Also:

IUserSummary.setLoginName(java.lang.String)

setUpdate

public void setUpdate(java.util.Date update)

Specified by:

setUpdate in interface IUserSummary

See Also:

IUserSummary.setUpdate(java.util.Date)

getType

public IUserSummary.UserType getType()

Description copied from interface: IUserSummary

Get the UserType associated with this user. May return null if no type was set.

Specified by:

getType in interface IUserSummary

Returns:

user type

See Also:

IUserSummary.getType()

setType

public void setType(IUserSummary.UserType type)

Description copied from interface: IUserSummary

Set the UserType associated with this user.

Specified by:

setType in interface IUserSummary

Parameters:

type - type

See Also:

IUserSummary.setType(com.perforce.p4java.core.IUserSummary.UserType)

getTicketExpiration

public java.util.Date getTicketExpiration()

Description copied from interface: IUserSummary

Get the date the ticket associated with this summary user expires.

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. In all other cases the value of this field is either null or not reliable.

This is a read-only field synthesized by the Perforce server, and can not be meaningfully set in the client.

Specified by:

getTicketExpiration in interface IUserSummary

Returns:

possibly-null Date object.

See Also:

IUserSummary.getTicketExpiration()

getPasswordChange

public java.util.Date getPasswordChange()

Description copied from interface: IUserSummary

Get the date the password associated with this summary user expires.

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. In all other cases the value of this field is either null or not reliable.

This is a read-only field synthesized by the Perforce server, and can not be meaningfully set in the client.

Specified by:

getPasswordChange in interface IUserSummary

Returns:

possibly-null Date object.

See Also:

IUserSummary.getPasswordChange()