Project: stp

com.ibm.rational.wvcm.stp.cq
Interface CqGroup

All Superinterfaces:
CqResource, Resource, StpPrincipal, StpResource

public interface CqGroup
extends CqResource, StpPrincipal

Interface for ClearQuest group resources.

Changes you make to a group are immediately reflected in the db-set (schema repository, master database) but not the associated user databases. To update the user databases, apply CqUserDb.doUpgradeUsersAndGroups(Feedback) on each database individually.

The user-friendly specification for the location of a group has the form

  cq.group:<group-name>@<db-set>
 


Nested Class Summary
 
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
 
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<ResourceList<CqUserDb>> ALL_DATABASES
          Returns the databases to which this group may subscribe, including databases to which it is already described.
static PropertyNameList.PropertyName<CqReplica> CQ_MASTER_REPLICA
          The replica that masters this group
static PropertyNameList.PropertyName<CqDbSet> DB_SET
          The database set that contains this resource
static PropertyNameList.PropertyName<ResourceList<CqGroup>> GROUPS
          The groups that belong to this group
static PropertyNameList.PropertyName<Boolean> IS_ACTIVE
          Indicates whether or not the group is active.
static PropertyNameList.PropertyName<Boolean> IS_SUBSCRIBED_TO_ALL_DATABASES
          Indicates whether this Group is subscribed to all databases in a Db-set (schema repository, master database).
static PropertyNameList.PropertyName<ResourceList<CqUserDb>> SUBSCRIBED_DATABASES
          The user databases to which this group is subscribed.
static PropertyNameList.PropertyName<ResourceList<CqUser>> USERS
          The users that belong to this group
 
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
 
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
 CqGroup doCreateGroup(Feedback feedback)
          Creates a new group and associates it with the DbSet named by the proxy location.
 ResourceList<CqUserDb> getAllDatabases()
          Returns the value of the ALL_DATABASES 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.
 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 getIsSubscribedToAllDatabases()
          Returns the value of the IS_SUBSCRIBED_TO_ALL_DATABASES property as defined by this proxy.
 ResourceList<CqUserDb> getSubscribedDatabases()
          Returns the value of the SUBSCRIBED_DATABASES property as defined by this proxy.
 ResourceList<CqUser> getUsers()
          Returns the value of the USERS property as defined by this proxy.
 void setCqMasterReplica(CqReplica value)
          Defines a new value for the CQ_MASTER_REPLICA property of this proxy.
 void setGroups(ResourceList<CqGroup> value)
          Defines a new value for the GROUPS property of this proxy.
 void setGroups(ResourceList<CqGroup> additions, ResourceList<CqGroup> deletions)
          Establishes the values to be added to and/or deleted from the GROUPS property when that property is updated from this proxy (via doWriteProperties or any other "do" method of this interface).
 void setIsActive(boolean value)
          Defines a new value for the IS_ACTIVE property of this proxy.
 void setIsSubscribedToAllDatabases(boolean value)
          Defines a new value for the IS_SUBSCRIBED_TO_ALL_DATABASES 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).
 void setUsers(ResourceList<CqUser> value)
          Defines a new value for the USERS property of this proxy.
 void setUsers(ResourceList<CqUser> additions, ResourceList<CqUser> deletions)
          Establishes the values to be added to and/or deleted from the USERS property when that property is updated from this proxy (via doWriteProperties or any other "do" method of this interface).
 
Methods inherited from interface CqResource
cqProvider, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getCreatorGroupName, getCreatorLoginName, getIsExecutable, getLastModified, getProviderList, getWorkspaceFolderList, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setIsExecutable
 
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, 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 com.ibm.rational.wvcm.stp.StpResource
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, 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
 

Field Detail

ALL_DATABASES

static final PropertyNameList.PropertyName<ResourceList<CqUserDb>> ALL_DATABASES
Returns the databases to which this group may subscribe, including databases to which it is already described.


CQ_MASTER_REPLICA

static final PropertyNameList.PropertyName<CqReplica> CQ_MASTER_REPLICA
The replica that masters this group


DB_SET

static final PropertyNameList.PropertyName<CqDbSet> DB_SET
The database set that contains this resource


GROUPS

static final PropertyNameList.PropertyName<ResourceList<CqGroup>> GROUPS
The groups that belong to this group


IS_ACTIVE

static final PropertyNameList.PropertyName<Boolean> IS_ACTIVE
Indicates whether or not the group is active. This property can be retrieved or set. Members of an inactive group are not allowed to access any databases using the group’s attributes. Access to a database is permitted if the user belongs to another group that has access or if the user’s account is specifically subscribed to the database.


IS_SUBSCRIBED_TO_ALL_DATABASES

static final PropertyNameList.PropertyName<Boolean> IS_SUBSCRIBED_TO_ALL_DATABASES
Indicates whether this Group is subscribed to all databases in a Db-set (schema repository, master database).


SUBSCRIBED_DATABASES

static final PropertyNameList.PropertyName<ResourceList<CqUserDb>> SUBSCRIBED_DATABASES
The user databases to which this group is subscribed. If getIsSubscribedToAllDatabases() is true, then this list will include all databases.


USERS

static final PropertyNameList.PropertyName<ResourceList<CqUser>> USERS
The users that belong to this group

Method Detail

doCreateGroup

CqGroup doCreateGroup(Feedback feedback)
                      throws WvcmException
Creates a new group and associates it with the DbSet named by the proxy location. The location is of the form
 cq.group:<group-name>@<db-set-name>
 
The new group is subscribed to all databases by default. When you use the methods of the Group object to add users and subscribe the group to one or more databases, the groups or users are subscribed only to those you specify.

Parameters:
feedback - Specifies optional feedback to the caller.
Returns:
A proxy for this new resource, whose properties are specified by feedback.
Throws:
WvcmException - ReasonCode:
  • CANNOT_CREATE_AT_THIS_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 DbSet

  • getAllDatabases

    ResourceList<CqUserDb> getAllDatabases()
                                           throws WvcmException
    Returns the value of the ALL_DATABASES property as defined by this proxy.

    Returns:
    A ResourceList containing a CqUserDb proxy for each database to which this group may subscribe. Will never be null.
    Throws:
    WvcmException - if this proxy does not define a value for the ALL_DATABASES property.

    getCqMasterReplica

    CqReplica getCqMasterReplica()
                                 throws WvcmException
    Returns the value of the CQ_MASTER_REPLICA property as defined by this proxy.

    Returns:
    A CqReplica proxy for the replica that masters this group resource. Will never be null.
    Throws:
    WvcmException - if this proxy does not define a value for the CQ_MASTER_REPLICA property.

    getDbSet

    CqDbSet getDbSet()
                     throws WvcmException
    Returns the value of the DB_SET property as defined by this proxy.

    Returns:
    A CqDbSet proxy for the database set that contains this resource.
    Throws:
    WvcmException - if this proxy does not define a value for the DB_SET property.

    getGroups

    ResourceList<CqGroup> getGroups()
                                    throws WvcmException
    Returns the value of the GROUPS property as defined by this proxy. If this property was set via setSubscribedDatabases(ResourceList, ResourceList) this method returns only the list of additions.

    Returns:
    A ResourceList containing a CqGroup proxy for each group that is the member of this group. Will never be null.
    Throws:
    WvcmException - if this proxy does not define a value for the GROUPS property.

    getIsActive

    boolean getIsActive()
                        throws WvcmException
    Returns the value of the IS_ACTIVE property as defined by this proxy.

    Returns:
    true if the group is active; false otherwise.
    Throws:
    WvcmException - if this proxy does not define a value for the IS_ACTIVE property.

    getIsSubscribedToAllDatabases

    boolean getIsSubscribedToAllDatabases()
                                          throws WvcmException
    Returns the value of the IS_SUBSCRIBED_TO_ALL_DATABASES property as defined by this proxy.

    Returns:
    true if the Group is subscribed to all databases in the d, false otherwise.
    Throws:
    WvcmException - if this proxy does not define a value for the IS_SUBSCRIBED_TO_ALL_DATABASES property.

    getSubscribedDatabases

    ResourceList<CqUserDb> getSubscribedDatabases()
                                                  throws WvcmException
    Returns the value of the SUBSCRIBED_DATABASES property as defined by this proxy.

    Returns:
    A ResourceList containing a CqUserDb resource for each user database to which this group is explicitly or implicitly subscribed. Will never be null.
    Throws:
    WvcmException - if this proxy does not define a value for the SUBSCRIBED_DATABASES property.

    getUsers

    ResourceList<CqUser> getUsers()
                                  throws WvcmException
    Returns the value of the USERS property as defined by this proxy. If this property was set via setSubscribedDatabases(ResourceList, ResourceList) this method returns only the list of additions.

    Returns:
    A ResourceList containing a CqUser proxy for each user that is the member of this group. Will never be null.
    Throws:
    WvcmException - if this proxy does not define a value for the USERS property.

    setCqMasterReplica

    void setCqMasterReplica(CqReplica value)
    Defines a new value for the CQ_MASTER_REPLICA property of this proxy.

    Parameters:
    value - A CqReplica proxy for the replica that is to assume mastership of this group.

    setGroups

    void setGroups(ResourceList<CqGroup> value)
    Defines a new value for the GROUPS property of this proxy.

    Parameters:
    value - A ResourceList containing a CqGroup proxy for each group that is to be a member of this group.

    setGroups

    void setGroups(ResourceList<CqGroup> additions,
                   ResourceList<CqGroup> deletions)
    Establishes the values to be added to and/or deleted from the GROUPS property when that property is updated from this proxy (via doWriteProperties or any other "do" method of this interface).

    Parameters:
    additions - The list of CqGroup proxies that must be in the GROUPS 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 CqGroup proxies that must not be in the GROUPS 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.

    setIsActive

    void setIsActive(boolean value)
    Defines a new value for the IS_ACTIVE property of this proxy.

    Parameters:
    value - true to make the group active; false to make it inactive.

    setIsSubscribedToAllDatabases

    void setIsSubscribedToAllDatabases(boolean value)
    Defines a new value for the IS_SUBSCRIBED_TO_ALL_DATABASES property of this proxy.

    Parameters:
    value - true if this group is henceforth to be subscribed to all db-set databases; false if it is to be subscribed only to the databases on its SUBCRIBED_DATABASES list.

    setSubscribedDatabases

    void setSubscribedDatabases(ResourceList<CqUserDb> value)
    Defines a new value for the SUBSCRIBED_DATABASES property of this proxy.

    Parameters:
    value - A ResourceList containing a CqUserDb proxy for each user database to which this group is now subscribed. May be null or empty to unsubscribe the group from all user databases.

    setSubscribedDatabases

    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).

    Parameters:
    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.

    setUsers

    void setUsers(ResourceList<CqUser> value)
    Defines a new value for the USERS property of this proxy.

    Parameters:
    value - A ResourceList containing a CqUser proxy for each user that is to be a member of this group.

    setUsers

    void setUsers(ResourceList<CqUser> additions,
                  ResourceList<CqUser> deletions)
    Establishes the values to be added to and/or deleted from the USERS property when that property is updated from this proxy (via doWriteProperties or any other "do" method of this interface).

    Parameters:
    additions - The list of CqUser proxies that must be in the USERS 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 CqUser proxies that must not be in the USERS 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 Fri 26-Feb-2010 04:01 AM

    Copyright © IBM 2010. All rights reserved.