Project: stp

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

All Superinterfaces:
CqContextResource, CqResource, CqUserDbMember, Resource, StpResource

public interface CqDynamicChoiceList
extends CqContextResource

A proxy for a ClearQuest dynamic choice list. *

The user-friendly specification for the location of a dynamic choice list has the form

  cq.choicelist:<choice-list-name>@<db-set>/<user-db>
 


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
 
Field Summary
static PropertyNameList.PropertyName<List<String>> MEMBER_LIST
          The list of choices in this dynamic choice list
 
Fields inherited from interface CqContextResource
IS_MODIFIED
 
Fields inherited from interface CqUserDbMember
DB_SET, USER_DB
 
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
 List<String> getMemberList()
          Returns the value of the MEMBER_LIST property as defined by this proxy.
 void setMemberList(List<String> choices)
          Defines values for the MEMBER_LIST property of this proxy.
 void setMemberList(List<String> additions, List<String> deletions)
          Establishes the values to be added to and/or deleted from the MEMBER_LIST property when that property is updated from this proxy (via doWriteProperties or any other "do" method of this interface).
 
Methods inherited from interface CqContextResource
doDeliver, doRevert, doUnbindAll, doUnbindAll, doWriteProperties, doWriteProperties, getIsModified
 
Methods inherited from interface CqUserDbMember
getDbSet, getUserDb
 
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, doWriteContent, forgetProperty, getDisplayName, getParentList, getPathnameLocation, getProperty, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setDisplayName, setProperty, setProperty, updatedPropertyNameList
 

Field Detail

MEMBER_LIST

static final PropertyNameList.PropertyName<List<String>> MEMBER_LIST
The list of choices in this dynamic choice list

Method Detail

getMemberList

List<String> getMemberList()
                           throws WvcmException
Returns the value of the MEMBER_LIST property as defined by this proxy. If this property was set in the proxy via setMemberList(List, List), only the list of additions will be returned

Returns:
A list of Strings each representing one member of the choice list
Throws:
WvcmException - if this proxy does not define a value for the MEMBER_LIST property.

setMemberList

void setMemberList(List<String> choices)
Defines values for the MEMBER_LIST property of this proxy.

Parameters:
choices - A list of Strings specifying the members of this dynamic choice list. This list becomes the entire new content of the dynamic choice list. In a highly collaborative environment, updating the list in this fashion is discouraged. Use setMemberList(List, List) instead.

setMemberList

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

Parameters:
additions - The list of String values that must be in the MEMBER_LIST 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 String values that must not be in the MEMBER_LIST 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 Mon 2-Mar-2009 11:14 PM

Copyright © IBM 2009. All rights reserved.