public interface IUserGroup extends IServerResource
The IUserGroup interface and implementation objects are somewhat unusual in the P4Java object menagerie in that they do not have corresponding summary objects due to the way the Perforce server handles and communicates Perforce user groups. This may change in the future, but in general, with caveats noted below and elsewhere, IUserGroup objects are complete, updateable, and refreshable, and (as explained) have no summary versions.
Note that the getSubgroups() method is not guaranteed to return correct values for IUserGroup objects returned from the getUserGroupList; you normally have to get the group definition from getUserGroup to see the list of that group's sub groups (this is a Perforce server limitation). Conversely, the isSubGroup() method only works for a user group object returned by the list version of the get group(s) commands.
Setter methods defined below only have local effect unless an object update is performed.
Modifier and Type | Field and Description |
---|---|
static int |
UNDEFINED
Used as a default value in MaxOpenFiles, for backwards compatibility with old servers.
|
static int |
UNLIMITED
Used to signal that a specific user group max value (eg.
|
static int |
UNSET
Used to signal that a specific user group max value (eg.
|
Modifier and Type | Method and Description |
---|---|
int |
getMaxLockTime()
Get the maximum lock time for queries by members of this group.
|
int |
getMaxMemory()
Get Maximum amount of megabytes of random-access memory that a command can use when
run by any member of the group.
|
int |
getMaxOpenFiles()
Get the maximum files that can be opened by members of this group.
|
int |
getMaxResults()
Get the maximum number of results returned for queries by members
of this group.
|
int |
getMaxScanRows()
Get the maximum number of scan rows returned for queries by members
of this group.
|
java.lang.String |
getName()
Get the group's name.
|
java.util.List<java.lang.String> |
getOwners()
Get a list of owner names for this group.
|
int |
getPasswordTimeout()
Get the password timeout value associated with this user group.
|
java.util.List<java.lang.String> |
getSubgroups()
Get the list of known subgroups of this groups.
|
int |
getTimeout()
Get the timeout value for commands by members of this group.
|
java.util.List<java.lang.String> |
getUsers()
Get a list of user names for this group.
|
boolean |
isSubGroup()
Return true if this group is a sub group of another group on this server.
|
void |
setMaxLockTime(int maxLockTimeOfMilliSeconds)
Set the maximum lock time for queries by members of this group.
|
void |
setMaxMemory(int maxMemory)
Set Maximum amount of megabytes of random-access memory that a command can use when
run by any member of the group.
|
void |
setMaxOpenFiles(int maxOpenFiles)
Set maximum files that can be opened by members of this group.
|
void |
setMaxResults(int maxResults)
Set the maximum number of results returned for queries by members
of this group.
|
void |
setMaxScanRows(int maxScanRows)
Set the maximum number of scan rows returned for queries by members
of this group.
|
void |
setName(java.lang.String name)
Set the group's name.
|
void |
setOwners(java.util.List<java.lang.String> owners)
Set the list of owner names for this group.
|
void |
setPasswordTimeout(int passwordTimeoutOfSeconds)
Set the password timeout value associated with this user group.
|
void |
setSubGroup(boolean subGroup)
Set whether this group is a sub group of another group on this server.
|
void |
setSubgroups(java.util.List<java.lang.String> subgroups)
Set the list of known subgroups of this groups.
|
void |
setTimeout(int timeoutOfSeconds)
Set the timeout value for commands by members of this group.
|
void |
setUsers(java.util.List<java.lang.String> users)
Set the list of user names for this group.
|
canRefresh, canUpdate, clearRawFields, complete, getRawField, getRawFields, hasRawField, refresh, setRawField, setRawFields, setServer, update, update, update
static final int UNSET
static final int UNLIMITED
static final int UNDEFINED
java.lang.String getName()
void setName(java.lang.String name)
name
- nameint getMaxResults()
void setMaxResults(int maxResults)
maxResults
- max resultsint getMaxScanRows()
void setMaxScanRows(int maxScanRows)
maxScanRows
- max rowsint getMaxLockTime()
void setMaxLockTime(int maxLockTimeOfMilliSeconds)
maxLockTimeOfMilliSeconds
- - millisecondsint getMaxOpenFiles()
void setMaxOpenFiles(int maxOpenFiles)
maxOpenFiles
- max open filesint getTimeout()
void setTimeout(int timeoutOfSeconds)
timeoutOfSeconds
- - secondsint getPasswordTimeout()
void setPasswordTimeout(int passwordTimeoutOfSeconds)
passwordTimeoutOfSeconds
- - secondsboolean isSubGroup()
Note that this method will always return false on an IUserGroup object retrieved from the IServer.getUserGroup() method (this is a restriction imposed by the Perforce server).
void setSubGroup(boolean subGroup)
subGroup
- sub groupjava.util.List<java.lang.String> getSubgroups()
void setSubgroups(java.util.List<java.lang.String> subgroups)
subgroups
- list of subgroupsjava.util.List<java.lang.String> getOwners()
void setOwners(java.util.List<java.lang.String> owners)
owners
- list of ownersjava.util.List<java.lang.String> getUsers()
void setUsers(java.util.List<java.lang.String> users)
users
- usersint getMaxMemory()
void setMaxMemory(int maxMemory)
maxMemory
- - in MB