IUserSummary (p4java 2023.2.2581742 API)

All Superinterfaces:

IServerResource

All Known Subinterfaces:

IUser

All Known Implementing Classes:

User, UserSummary
```
public interface IUserSummary
extends IServerResource
```
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.
IUserSummary objects are complete and neither refreshable nor updateable.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class IUserSummary.UserType
Describes the type (service or standard) of this user.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IUserSummary.UserType` Describes the type (service or standard) of this user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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 interface com.perforce.p4java.core.IServerResource
canRefresh, canUpdate, clearRawFields, complete, getRawField, getRawFields, hasRawField, refresh, setRawField, setRawFields, setServer, update, update, update

- Method Detail
  - getLoginName
```
java.lang.String getLoginName()
```
  - setLoginName
```
void setLoginName(java.lang.String loginName)
```
  - getUpdate
```
java.util.Date getUpdate()
```
  - setUpdate
```
void setUpdate(java.util.Date update)
```
  - getAccess
```
java.util.Date getAccess()
```
  - setAccess
```
void setAccess(java.util.Date access)
```
  - getFullName
```
java.lang.String getFullName()
```
  - setFullName
```
void setFullName(java.lang.String fullName)
```
  - getEmail
```
java.lang.String getEmail()
```
  - setEmail
```
void setEmail(java.lang.String email)
```
  - getType
```
IUserSummary.UserType getType()
```
    Get the UserType associated with this user. May return null if no type was set.
    
    Returns:
    
    user type
    
    Since:
    
    2011.1
  - setType
```
void setType(IUserSummary.UserType type)
```
    Set the UserType associated with this user.
    
    Parameters:
    
    type - type
    
    Since:
    
    2011.1
  - getTicketExpiration
```
java.util.Date getTicketExpiration()
```
    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.
    
    Returns:
    
    possibly-null Date object.
    
    Since:
    
    2011.1
  - getPasswordChange
```
java.util.Date getPasswordChange()
```
    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.
    
    Returns:
    
    possibly-null Date object.
    
    Since:
    
    2011.1

Interface IUserSummary

Nested Class Summary

Method Summary

Methods inherited from interface com.perforce.p4java.core.IServerResource

Method Detail

getLoginName

setLoginName

getUpdate

setUpdate

getAccess

setAccess

getFullName

setFullName

getEmail

setEmail

getType

setType

getTicketExpiration

getPasswordChange