|
Project: stp | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CqUser
The proxy interface for information stored in a DbSet for a single user. A user’s login, access privileges and some other information can be retrieved and specified through this object. You can also subscribe and unsubscribe a user to databases and upgrade user information in all the user databases that the user is currently subscribed to.
Note that CqUser.doWriteProperties(...) writes dirty properties of this proxy
into the DbSet. For the new values to be visible to a user database,
CqUserDb.doUpgradeUsersAndGroups(Feedback)
must be invoked on that
database or doUpgradeDatabases(Feedback)
must be invoked on
this user.
The user-friendly specification for the location of a user has the form
cq.user:<user-name>@<db-set>
Nested Class Summary | |
---|---|
static class |
CqUser.AuthenticationMode
An enumeration of the authentication modes available to a user |
Nested classes/interfaces inherited from interface com.ibm.rational.wvcm.stp.StpResource |
---|
StpResource.UnsupportedProperty |
Nested classes/interfaces inherited from interface javax.wvcm.Resource |
---|
Resource.CopyFlag |
Field Summary | |
---|---|
static PropertyNameList.PropertyName<CqUser.AuthenticationMode> |
AUTHENTICATION_MODE
Whether this user is authenticated via an LDAP login or via ClearQuest login-name and password. |
static PropertyNameList.PropertyName<String> |
AUTHENTICATOR
An encrypted version of the value placed in the AUTHENTICATOR property of this CqUser resource. |
static PropertyNameList.PropertyName<CqReplica> |
CQ_MASTER_REPLICA
The replica that masters this user |
static PropertyNameList.PropertyName<CqDbSet> |
DB_SET
The database set that contains this user resource |
static PropertyNameList.PropertyName<String> |
EMAIL
The user's e-mail address. |
static PropertyNameList.PropertyName<String> |
FULL_NAME
The full name of the user |
static PropertyNameList.PropertyName<ResourceList<CqGroup>> |
GROUPS
A list of active user groups to which the user belongs. |
static PropertyNameList.PropertyName<Boolean> |
IS_ACTIVE
Indication of whether or not this user's account is active |
static PropertyNameList.PropertyName<Boolean> |
IS_ALL_USERS_VISIBLE
Answers whether or not this user can view information about all users and groups in user databases. |
static PropertyNameList.PropertyName<Boolean> |
IS_APP_BUILDER
Answers whether or not this user can create and modify schemas, update existing databases, and create, modify, and save public queries, charts, and reports (but not perform user administrator tasks). |
static PropertyNameList.PropertyName<Boolean> |
IS_DYNAMIC_LIST_ADMIN
Answers whether or not this user can create and manage dynamic lists. |
static PropertyNameList.PropertyName<Boolean> |
IS_MULTI_SITE_ADMIN
Answers whether or not this user has multisite administrator privileges. |
static PropertyNameList.PropertyName<Boolean> |
IS_PUBLIC_FOLDER_ADMIN
Answers whether or not this user can create, delete, or update resources in the public folders heirarcy used for queries, reports, and charts. |
static PropertyNameList.PropertyName<Boolean> |
IS_RAW_SQL_WRITER
Answers whether or not this user can create (either from scratch or through modification of an existing query) a query defined by a raw SQL string. |
static PropertyNameList.PropertyName<Boolean> |
IS_SECURITY_ADMIN
Answers whether or not this user can access and manage secure records and fields as well as edit the context group list field for a security context record and view all records. |
static PropertyNameList.PropertyName<Boolean> |
IS_SUBSCRIBED_TO_ALL_DATABASES
Answers whether or not this user is automatically subscribed to all databases of the DbSet. |
static PropertyNameList.PropertyName<Boolean> |
IS_SUPER_USER
Answers whether or not this user has been granted all privileges and can also create and delete databases and schemas and edit ClearQuest Web settings. |
static PropertyNameList.PropertyName<Boolean> |
IS_USER_MAINTAINER
Answers whether or not this user can create users and user groups and assign and modify their user-access privileges. |
static PropertyNameList.PropertyName<String> |
LOGIN_NAME
The string used by ClearQuest to identify this user. |
static PropertyNameList.PropertyName<String> |
MISCELLANEOUS_INFORMATION
The miscellaneous information field of the user's profile. |
static PropertyNameList.PropertyName<String> |
PHONE
The phone number field from this user's profile. |
static PropertyNameList.PropertyName<ResourceList<CqUserDb>> |
SUBSCRIBED_DATABASES
The databases to which the user is subscribed. |
static PropertyNameList.PropertyName<List<StpProperty<Boolean>>> |
USER_PRIVILEGES
The value of this property is an StpProperty.List containing an StpProperty<Boolean> object for each user privilege defined by ClearQuest. |
Fields inherited from interface com.ibm.rational.wvcm.stp.StpResource |
---|
ALL_PROPERTIES, AUTHENTICATION_REALM, CREATOR_GROUP_NAME, CREATOR_LOGIN_NAME, EFFICIENT_LOCATION, INVALID_PROPERTIES, REPOSITORY, STABLE_LOCATION, USER_FRIENDLY_LOCATION |
Fields inherited from interface javax.wvcm.Resource |
---|
ALL_CUSTOM_PROPERTIES, COMMENT, CONTENT_CHARACTER_SET, CONTENT_IDENTIFIER, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CREATION_DATE, CREATOR_DISPLAY_NAME, DISPLAY_NAME, IS_EXECUTABLE, LAST_MODIFIED, PARENT_LIST, PATHNAME_LOCATION, PROVIDER_LIST, RESOURCE_IDENTIFIER, WORKSPACE_FOLDER_LIST |
Method Summary | |
---|---|
CqUser |
doCreateUser(Feedback feedback)
Creates a new user whose ClearQuest login name will be the same as the Name field of this proxy's location. |
CqUser |
doUpgradeDatabases(Feedback feedback)
Attempts to upgrade the user account information in all the user databases that this user is currently subscribed to. |
CqUser.AuthenticationMode |
getAuthenticationMode()
Returns the value of the AUTHENTICATION_MODE
property as defined by this proxy. |
String |
getAuthenticator()
Returns the value of the AUTHENTICATOR property as
defined by this proxy. |
CqReplica |
getCqMasterReplica()
Returns the value of the CQ_MASTER_REPLICA property
as defined by this proxy. |
CqDbSet |
getDbSet()
Returns the value of the DB_SET property as defined by
this proxy. |
String |
getEmail()
Returns the value of the EMAIL property as defined by this
proxy. |
String |
getFullName()
Returns the value of the FULL_NAME property as defined
by this proxy. |
ResourceList<CqGroup> |
getGroups()
Returns the value of the GROUPS property as defined by
this proxy. |
boolean |
getIsActive()
Returns the value of the IS_ACTIVE property as defined
by this proxy. |
boolean |
getIsAllUsersVisible()
Returns the value of the IS_ALL_USERS_VISIBLE property as defined
by this proxy. |
boolean |
getIsAppBuilder()
Returns the value of the IS_APP_BUILDER property
as defined by this proxy. |
boolean |
getIsDynamicListAdmin()
Returns the value of the IS_DYNAMIC_LIST_ADMIN property as defined
by this proxy. |
boolean |
getIsMultiSiteAdmin()
Returns the value of the IS_MULTI_SITE_ADMIN property as defined by
this proxy. |
boolean |
getIsPublicFolderAdmin()
Returns the value of the IS_PUBLIC_FOLDER_ADMIN property as
defined by this proxy. |
boolean |
getIsRawSqlWriter()
Returns the value of the IS_RAW_SQL_WRITER
property as defined by this proxy. |
boolean |
getIsSecurityAdmin()
Returns the value of the IS_SECURITY_ADMIN
property as defined by this proxy. |
boolean |
getIsSubscribedToAllDatabases()
Returns the value of the IS_SUBSCRIBED_TO_ALL_DATABASES
property as defined by this proxy. |
boolean |
getIsSuperUser()
Returns the value of the IS_SUPER_USER property
as defined by this proxy. |
boolean |
getIsUserMaintainer()
Returns the value of the IS_USER_MAINTAINER
property as defined by this proxy. |
String |
getLoginName()
Returns the value of the LOGIN_NAME property as
defined by this proxy. |
String |
getMiscellaneousInformation()
Returns the value of the MISCELLANEOUS_INFORMATION property as
defined by this proxy. |
String |
getPhone()
Returns the value of the PHONE property as defined by this
proxy. |
ResourceList<CqUserDb> |
getSubscribedDatabases()
Returns the value of the SUBSCRIBED_DATABASES property as defined by
this proxy. |
List<StpProperty<Boolean>> |
getUserPrivileges()
Returns the value of the USER_PRIVILEGES
property as defined by this proxy. |
void |
setAuthenticationMode(CqUser.AuthenticationMode mode)
Defines a new value for the AUTHENTICATION_MODE property of this proxy. |
void |
setAuthenticator(String password)
Defines a new value for the AUTHENTICATOR property
of this proxy. |
void |
setCqMasterReplica(CqReplica value)
Defines a new value for the CQ_MASTER_REPLICA
property of this proxy. |
void |
setEmail(String email)
Defines a new value for the EMAIL property of this proxy. |
void |
setFullName(String fullName)
Defines a new value for the FULL_NAME property of this
proxy. |
void |
setIsActive(boolean active)
Defines a new value for the IS_ACTIVE property of this
proxy. |
void |
setIsAllUsersVisible(boolean permitted)
Defines a new value for the IS_ALL_USERS_VISIBLE property of this
proxy. |
void |
setIsAppBuilder(boolean permitted)
Defines a new value for the IS_APP_BUILDER
property of this proxy. |
void |
setIsDynamicListAdmin(boolean permitted)
Defines a new value for the IS_DYNAMIC_LIST_ADMIN property of this
proxy. |
void |
setIsMultiSiteAdmin(boolean permitted)
Defines a new value for the IS_MULTI_SITE_ADMIN property of this proxy. |
void |
setIsPublicFolderAdmin(boolean permitted)
Defines a new value for the IS_PUBLIC_FOLDER_ADMIN property of this
proxy. |
void |
setIsRawSqlWriter(boolean permitted)
Defines a new value for the IS_RAW_SQL_WRITER
property of this proxy. |
void |
setIsSecurityAdmin(boolean permitted)
Defines a new value for the IS_SECURITY_ADMIN
property of this proxy. |
void |
setIsSubscribedToAllDatabases(boolean permitted)
Defines a new value for the IS_SUBSCRIBED_TO_ALL_DATABASES
property of this proxy. |
void |
setIsSuperUser(boolean permitted)
Defines a new value for the IS_SUPER_USER property of this
proxy. |
void |
setIsUserMaintainer(boolean permitted)
Defines a new value for the IS_USER_MAINTAINER property of this proxy. |
void |
setLoginName(String loginName)
Defines a new value for the LOGIN_NAME property of
this proxy. |
void |
setMiscellaneousInformation(String miscInfo)
Defines a new value for the MISCELLANEOUS_INFORMATION property of
this proxy. |
void |
setPhone(String phone)
Defines a new value for the PHONE property of this proxy. |
void |
setSubscribedDatabases(ResourceList<CqUserDb> value)
Defines a new value for the SUBSCRIBED_DATABASES property of this
proxy. |
void |
setSubscribedDatabases(ResourceList<CqUserDb> additions,
ResourceList<CqUserDb> deletions)
Establishes the values to be added to and/or deleted from the SUBSCRIBED_DATABASES property when that property is updated from this proxy (via doWriteProperties or any other "do" method of this interface). |
Methods inherited from interface com.ibm.rational.wvcm.stp.StpResource |
---|
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, setPropertyClean, stpLocation, stpProvider |
Methods inherited from interface javax.wvcm.Resource |
---|
doCopy, doFind, doFindAll, doGetPropertyNameList, doGetPropertyNameList, doReadContent, doReadProperties, doUnbindAll, doWriteContent, doWriteProperties, forgetProperty, getDisplayName, getParentList, getPathnameLocation, getProperty, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setDisplayName, setProperty, setProperty, updatedPropertyNameList |
Methods inherited from interface CqUserInfo |
---|
getGroupNames |
Field Detail |
---|
static final PropertyNameList.PropertyName<CqUser.AuthenticationMode> AUTHENTICATION_MODE
static final PropertyNameList.PropertyName<String> AUTHENTICATOR
static final PropertyNameList.PropertyName<CqReplica> CQ_MASTER_REPLICA
static final PropertyNameList.PropertyName<CqDbSet> DB_SET
static final PropertyNameList.PropertyName<String> EMAIL
static final PropertyNameList.PropertyName<String> FULL_NAME
static final PropertyNameList.PropertyName<ResourceList<CqGroup>> GROUPS
static final PropertyNameList.PropertyName<Boolean> IS_ACTIVE
static final PropertyNameList.PropertyName<Boolean> IS_ALL_USERS_VISIBLE
static final PropertyNameList.PropertyName<Boolean> IS_APP_BUILDER
static final PropertyNameList.PropertyName<Boolean> IS_DYNAMIC_LIST_ADMIN
static final PropertyNameList.PropertyName<Boolean> IS_MULTI_SITE_ADMIN
static final PropertyNameList.PropertyName<Boolean> IS_PUBLIC_FOLDER_ADMIN
static final PropertyNameList.PropertyName<Boolean> IS_RAW_SQL_WRITER
static final PropertyNameList.PropertyName<Boolean> IS_SECURITY_ADMIN
static final PropertyNameList.PropertyName<Boolean> IS_SUBSCRIBED_TO_ALL_DATABASES
static final PropertyNameList.PropertyName<Boolean> IS_SUPER_USER
static final PropertyNameList.PropertyName<Boolean> IS_USER_MAINTAINER
static final PropertyNameList.PropertyName<String> LOGIN_NAME
static final PropertyNameList.PropertyName<String> MISCELLANEOUS_INFORMATION
static final PropertyNameList.PropertyName<String> PHONE
static final PropertyNameList.PropertyName<ResourceList<CqUserDb>> SUBSCRIBED_DATABASES
static final PropertyNameList.PropertyName<List<StpProperty<Boolean>>> USER_PRIVILEGES
Any of the privileges enumerated in the USER_PRIVILEGES property can be granted or denied to the user by using Resource.setProperty to assign the particular property either Boolean.TRUE or Boolean.FALSE.
Method Detail |
---|
CqUser doCreateUser(Feedback feedback) throws WvcmException
cq.user:<login-name>@<db-set-name>If the LOGIN_NAME property is not set, it will default to the Name field of this proxy's location.
If the AUTHENTICATION_MODE is CLEAR_QUEST, the value of the LOGIN_NAME property of this proxy, if set, is ignored and forced to be the same as the Name field of this proxy's location. The AUTHENTICATOR should be the user's ClearQuest password.
If the AUTHENTICATION_MODE is LDAP, then the AUTHENTICATOR should be set
to the LDAP authentication name that is to correspond to this user. An
LDAP attribute value is copied from the LDAP user account to a ClearQuest
user profile field as specified by the value of
CqDb.LDAP_PROPERTY
. This method first checks the DbSet to ensure
that there is no conflict with another active LDAP-enabled user's
LDAP_PROPERTY value to ensure that the values are unique across active
LDAP enabled users. If the LDAP_PROPERTY is LOGIN_NAME_FIELD, the
login-name must be identical to LOGIN_NAME.
feedback
- Specifies optional feedback to the caller.
WvcmException
- ReasonCode:
RESOURCE_ALREADY_EXISTS_AT_LOCATION
:
If a resource already exists at the location of this
Resource, the request MUST fail.
CANNOT_CREATE_AT_THIS_LOCATION
:
If the location of this Group does not identify a valid
location in which to create a group, the request MUST fail.
Groups must be created in a DbSetCqUser doUpgradeDatabases(Feedback feedback) throws WvcmException
feedback
- Specifies optional feedback to the caller. The databases
being upgraded are considered to be resources modified by this
operation and will generate calls to
DetailedFeedback.notifyIsModified(javax.wvcm.Resource)
if requested.
WvcmException
- if any dirty properties could not be updated.
StpPartialResultsException
- if any of the subscribed databases
could not be upgraded, with the failed updates indicated by
nested exceptions of this exception.CqUser.AuthenticationMode getAuthenticationMode() throws WvcmException
AUTHENTICATION_MODE
property as defined by this proxy.
getAuthenticationMode
in interface CqUserInfo
WvcmException
- if this proxy does not define a value for the
AUTHENTICATION_MODE
property.String getAuthenticator() throws WvcmException
AUTHENTICATOR
property as
defined by this proxy.
getAuthenticator
in interface CqUserInfo
WvcmException
- if this proxy does not define a value for the
AUTHENTICATOR
property.CqReplica getCqMasterReplica() throws WvcmException
CQ_MASTER_REPLICA
property
as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
CQ_MASTER_REPLICA
property.CqDbSet getDbSet() throws WvcmException
DB_SET
property as defined by
this proxy.
WvcmException
- if this proxy does not define a value for the
DB_SET
property.String getEmail() throws WvcmException
EMAIL
property as defined by this
proxy.
getEmail
in interface CqUserInfo
WvcmException
- if this proxy does not define a value for the
EMAIL
property.String getFullName() throws WvcmException
FULL_NAME
property as defined
by this proxy.
getFullName
in interface CqUserInfo
WvcmException
- if this proxy does not define a value for the
FULL_NAME
property.ResourceList<CqGroup> getGroups() throws WvcmException
GROUPS
property as defined by
this proxy.
WvcmException
- if this proxy does not define a value for the
GROUPS
property.boolean getIsActive() throws WvcmException
IS_ACTIVE
property as defined
by this proxy.
WvcmException
- if this proxy does not define a value for the
CQ_MASTER_REPLICA
property.boolean getIsAllUsersVisible() throws WvcmException
IS_ALL_USERS_VISIBLE
property as defined
by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_ALL_USERS_VISIBLE
property.boolean getIsAppBuilder() throws WvcmException
IS_APP_BUILDER
property
as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_APP_BUILDER
property.boolean getIsDynamicListAdmin() throws WvcmException
IS_DYNAMIC_LIST_ADMIN
property as defined
by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_DYNAMIC_LIST_ADMIN
property.boolean getIsMultiSiteAdmin() throws WvcmException
IS_MULTI_SITE_ADMIN
property as defined by
this proxy.
WvcmException
- if this proxy does not define a value for the
IS_MULTI_SITE_ADMIN
property.boolean getIsPublicFolderAdmin() throws WvcmException
IS_PUBLIC_FOLDER_ADMIN
property as
defined by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_PUBLIC_FOLDER_ADMIN
property.boolean getIsRawSqlWriter() throws WvcmException
IS_RAW_SQL_WRITER
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_RAW_SQL_WRITER
property.boolean getIsSecurityAdmin() throws WvcmException
IS_SECURITY_ADMIN
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_SECURITY_ADMIN
property.boolean getIsSubscribedToAllDatabases() throws WvcmException
IS_SUBSCRIBED_TO_ALL_DATABASES
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_SUBSCRIBED_TO_ALL_DATABASES
property.boolean getIsSuperUser() throws WvcmException
IS_SUPER_USER
property
as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_SUPER_USER
property.boolean getIsUserMaintainer() throws WvcmException
IS_USER_MAINTAINER
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
IS_USER_MAINTAINER
property.String getLoginName() throws WvcmException
LOGIN_NAME
property as
defined by this proxy.
getLoginName
in interface CqUserInfo
WvcmException
- if this proxy does not define a value for the
LOGIN_NAME
property.String getMiscellaneousInformation() throws WvcmException
MISCELLANEOUS_INFORMATION
property as
defined by this proxy.
getMiscellaneousInformation
in interface CqUserInfo
WvcmException
- if this proxy does not define a value for the
MISCELLANEOUS_INFORMATION
property.String getPhone() throws WvcmException
PHONE
property as defined by this
proxy.
getPhone
in interface CqUserInfo
WvcmException
- if this proxy does not define a value for the
PHONE
property.ResourceList<CqUserDb> getSubscribedDatabases() throws WvcmException
SUBSCRIBED_DATABASES
property as defined by
this proxy.
WvcmException
- if this proxy does not define a value for the
SUBSCRIBED_DATABASES
property.List<StpProperty<Boolean>> getUserPrivileges() throws WvcmException
USER_PRIVILEGES
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
USER_PRIVILEGES
property.void setAuthenticationMode(CqUser.AuthenticationMode mode)
AUTHENTICATION_MODE
property of this proxy.
When setting the authentication mode to CLEAR_QUEST authentication, the AUTHENTICATOR property specifies the new ClearQuest password.
When setting the authentication mode to LDAP authentication, the AUTHENTICATOR property specifies the LDAP login name (a ClearQuest password is not used for LDAP authentication).
mode
- An AuthenticationMode enumerator specifying the new
authentication mode for this user.setLoginName(String)
,
setAuthenticator(String)
void setAuthenticator(String password)
AUTHENTICATOR
property
of this proxy. In LDAP AUTHENTICATION_MODE, or when changing to LDAP
AUTHENTICATION_MODE, this property specifies the LDAP login name to be
associated with this ClearQuest user. In CLEAR_QUEST AUTHENTICATION_MODE,
or when changing to CLEAR_QUEST AUTHENTICATION_MODE, this property
specifies the new ClearQuest password.
password
- A String containing the new value for the authenticator
associated with this user.void setCqMasterReplica(CqReplica value)
CQ_MASTER_REPLICA
property of this proxy.
value
- A CqReplica proxy specifying the replica that is to assume
mastership of this user resource.void setEmail(String email)
EMAIL
property of this proxy.
email
- A String containing the new value for the email field of
this user's profilevoid setFullName(String fullName) throws WvcmException
FULL_NAME
property of this
proxy.
fullName
- A String containing the new value for the full name field
of this user's profile
WvcmException
void setIsActive(boolean active)
IS_ACTIVE
property of this
proxy.
active
- true to make this user active; false to
make the user inactive.void setIsAllUsersVisible(boolean permitted)
IS_ALL_USERS_VISIBLE
property of this
proxy.
permitted
- true to permit this user to see all users;
false to deny the user this ability.void setIsAppBuilder(boolean permitted)
IS_APP_BUILDER
property of this proxy.
permitted
- true to permit this user to edit schemas;
false to deny the user this ability.void setIsDynamicListAdmin(boolean permitted)
IS_DYNAMIC_LIST_ADMIN
property of this
proxy.
permitted
- true to permit this user to edit dynamic choice
lists; false to deny the user this ability.void setIsMultiSiteAdmin(boolean permitted)
IS_MULTI_SITE_ADMIN
property of this proxy.
permitted
- true to permit this user to edit multi-site
components; false to deny the user this ability.void setIsPublicFolderAdmin(boolean permitted)
IS_PUBLIC_FOLDER_ADMIN
property of this
proxy.
permitted
- true to permit this user to edit public folders;
false to deny the user this ability.void setIsRawSqlWriter(boolean permitted)
IS_RAW_SQL_WRITER
property of this proxy.
permitted
- true to permit this user to edit raw SQL in
queries; false to deny the user this ability.void setIsSecurityAdmin(boolean permitted)
IS_SECURITY_ADMIN
property of this proxy.
permitted
- true to permit this user to edit security
components; false to deny the user this ability.void setIsSubscribedToAllDatabases(boolean permitted)
IS_SUBSCRIBED_TO_ALL_DATABASES
property of this proxy.
permitted
- true to automatically subscribe the user to all
databases current and future; false to require the
user to subscribe to each database individually.void setIsSuperUser(boolean permitted)
IS_SUPER_USER
property of this
proxy.
permitted
- true to permit this user to be super user;
false to deny the user this ability.void setIsUserMaintainer(boolean permitted)
IS_USER_MAINTAINER
property of this proxy.
permitted
- true to permit this user to edit user and group
artifacts; false to deny the user this ability.void setLoginName(String loginName)
LOGIN_NAME
property of
this proxy. Note, changing the login name of a user changes the location
of the CqUser object for that user.
loginName
- A String containing the new value for the login-name
field of this user's profilevoid setMiscellaneousInformation(String miscInfo)
MISCELLANEOUS_INFORMATION
property of
this proxy.
miscInfo
- A String containing the new value for the miscellaneous
information field of this user's profilevoid setPhone(String phone)
PHONE
property of this proxy.
phone
- A String containing the new value for the phone field of
this user's profilevoid setSubscribedDatabases(ResourceList<CqUserDb> value)
SUBSCRIBED_DATABASES
property of this
proxy.
value
- A ResourceList containing a CqUserDb proxy for each user
database to which this user is now subscribed. May be null
or empty to unsubscribe the user from all user databases.void setSubscribedDatabases(ResourceList<CqUserDb> additions, ResourceList<CqUserDb> deletions)
additions
- The list of CqUserDb proxies that must be in the
SUBSCRIBED_DATABASES property after it has been updated from
this proxy. Thus, it is OK for a value in this list to already
be a member of the property value. This list may be empty or
null if no values are to be added to the property. A value may
not appear in both this list and the deletions list.deletions
- The list of CqUserDb proxies that must not be in the
SUBSCRIBED_DATABASES property after it has been updated from
this proxy. Thus, it is OK for a value in this list to not be
a current member of the property value. This list may be empty
or null if no values are to be deleted from the property. A
value may not appear in both this list and the additions list.
|
Generated Tue 29-Aug-2017 12:28 PM | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |