Project: stp

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

All Superinterfaces:
CqContextResource, CqQueryFolderItem, CqResource, CqUserDbMember, Folder, Resource, StpAccessControlledResource, StpResource

public interface CqQueryFolder
extends Folder, CqQueryFolderItem, StpAccessControlledResource

A proxy for a query folder.

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

  cq.query:<parent-folder-path>/<folder-name>@<db-set>/<user-db>
 


Nested Class Summary
static class CqQueryFolder.GroupAccessRightsName
          A PropertyName class for requesting the applied or effective access rights for a specific group on this folder and, optionally, its nested folders
static class CqQueryFolder.UserAccessRightsName
          A PropertyName class for requesting the applied or effective access rights for a specific user on this folder and, optionally, its nested folders
 
Nested classes/interfaces inherited from interface javax.wvcm.Folder
Folder.BindFlag, Folder.RebindFlag
 
Nested classes/interfaces inherited from interface CqQueryFolderItem
CqQueryFolderItem.OverwriteMode
 
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<Boolean> IS_READABLE
          A boolean indicating whether or not the effective access rights on this folder allow it to be read by the current user.
static PropertyNameList.PropertyName<Boolean> IS_WRITABLE
          A boolean indicating whether or not the effective access rights on this folder allow it to be written by the current user
static PropertyNameList.PropertyName<Boolean> NEEDS_REFRESH
          A special property used to refresh a folder so that children added after this session started can be found.
static PropertyNameList.PropertyName<ResourceList<CqQueryFolderItem>> QUERY_FOLDER_ITEMS
          The queries, query folders and other items that are immediately contained within this folder.
 
Fields inherited from interface javax.wvcm.Folder
CHILD_LIST, CHILD_MAP
 
Fields inherited from interface CqQueryFolderItem
CAN_UPDATE_OR_DELETE, CQ_MASTER_REPLICA, IS_SITE_EXTENDED_NAME_REQUIRED, QUERY_FOLDER, SITE_EXTENDED_NAME, SITE_EXTENDED_NAMES
 
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
 
Fields inherited from interface com.ibm.rational.wvcm.stp.StpAccessControlledResource
ACCESS_RIGHTS, APPLIED_ACCESS_CONTROL_ENTRIES, CAN_CHANGE_ACCESS_RIGHTS, EFFECTIVE_ACCESS_CONTROL_ENTRIES, POSSIBLE_ACCESS_RIGHTS
 
Method Summary
 CqQueryFolder doCreateFolder(Feedback feedback)
          Creates a new folder at the location specified in this proxy.
 CqQueryFolder doCreateFolder(Feedback feedback, List<CqContextResource> deliveryOrder)
          Creates a new folder at the location specified in this proxy.
 List<StpAccessControlEntry> getGroupAccessRights(String groupName, StpAccessControlEntry.EntryType type, boolean nested)
          Retrieves from this proxy, the StpAccessControlEntry list returned as the value of a requested property named by a GroupAccessRightsName having the same parameters as this method.
 boolean getIsReadable()
          Returns the value of the IS_READABLE property as defined by this proxy.
 boolean getIsWritable()
          Returns the value of the IS_WRITABLE property as defined by this proxy.
 ResourceList<CqQueryFolderItem> getQueryFolderItems()
          Returns the value of the QUERY_FOLDER_ITEMS property as defined by this proxy.
 List<StpAccessControlEntry> getUserAccessRights(String userName, StpAccessControlEntry.EntryType type, boolean nested)
          Retrieves from this proxy, the StpAccessControlEntry list returned as the value of a requested property named by a UserAccessRightsName having the same parameters as this method.
 void setNeedsRefresh()
          Sets the NEEDS_REFRESH property.
 
Methods inherited from interface javax.wvcm.Folder
doBindChild, doReadMemberList, doRebindAll, doRebindChild, doUnbindChild, getChildList, getChildMap
 
Methods inherited from interface CqQueryFolderItem
doCopy, doCopy, doMove, doMove, doRename, getCanUpdateOrDelete, getCqMasterReplica, getIsSiteExtendedNameRequired, getQueryFolder, getSiteExtendedName, getSiteExtendedNames, setCqMasterReplica
 
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, getCreatorGroupName, getCreatorLoginName
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpResource
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, setPropertyClean, 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
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpAccessControlledResource
getAccessRights, getAppliedAccessControlEntries, getCanChangeAccessRights, getEffectiveAccessControlEntries, getPossibleAccessRights, setAppliedAccessControlEntries, setAppliedAccessControlEntries
 

Field Detail

IS_READABLE

static final PropertyNameList.PropertyName<Boolean> IS_READABLE
A boolean indicating whether or not the effective access rights on this folder allow it to be read by the current user.


IS_WRITABLE

static final PropertyNameList.PropertyName<Boolean> IS_WRITABLE
A boolean indicating whether or not the effective access rights on this folder allow it to be written by the current user


NEEDS_REFRESH

static final PropertyNameList.PropertyName<Boolean> NEEDS_REFRESH
A special property used to refresh a folder so that children added after this session started can be found.


QUERY_FOLDER_ITEMS

static final PropertyNameList.PropertyName<ResourceList<CqQueryFolderItem>> QUERY_FOLDER_ITEMS
The queries, query folders and other items that are immediately contained within this folder.

Method Detail

doCreateFolder

CqQueryFolder doCreateFolder(Feedback feedback)
                             throws WvcmException
Creates a new folder at the location specified in this proxy.

Parameters:
feedback - A Feedback object specifying the information desired from the new folder after it has been created.
Returns:
A proxy for the newly-created folder populated with the requested properties. The creation of the new folder will have been delivered to the database before the method returns.
Throws:
WvcmException - If the folder cannot be created at the specified location.

doCreateFolder

CqQueryFolder doCreateFolder(Feedback feedback,
                             List<CqContextResource> deliveryOrder)
                             throws WvcmException
Creates a new folder at the location specified in this proxy.

Parameters:
feedback - A Feedback object specifying the information desired from the new folder after it has been created.
deliveryOrder - A specification of what resources are to be delivered to the database after the folder has been created.
Returns:
A proxy for the newly-created folder populated with the requested properties.
Throws:
WvcmException - If the folder cannot be created at the specified location or if any of the resources to be delivered to the database cannot be delivered.

getGroupAccessRights

List<StpAccessControlEntry> getGroupAccessRights(String groupName,
                                                 StpAccessControlEntry.EntryType type,
                                                 boolean nested)
                                                 throws WvcmException
Retrieves from this proxy, the StpAccessControlEntry list returned as the value of a requested property named by a GroupAccessRightsName having the same parameters as this method.

Parameters:
groupName - The name of the group for which access rights were requested.
type - The EntryType of the access rights requested.
nested - true if the access rights of the specified type and group were also to be returned for the folders nested within this folder; false if just the access rights on this folder were to be included.
Returns:
A list of StpAccessControlEntry objects, each representing an AccessRight of the group as requested.
Throws:
WvcmException - If the implied GroupAccessRights property was not requested or not otherwise available.

getIsReadable

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

Returns:
A boolean indicating whether or not the effective access rights on this folder allow it to be read by the current user
Throws:
WvcmException - if this proxy does not define a value for the IS_READABLE property.

getIsWritable

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

Returns:
A boolean indicating whether or not the effective access rights on this folder allow it to be read by the current user.
Throws:
WvcmException - if this proxy does not define a value for the IS_WRITABLE property.

getQueryFolderItems

ResourceList<CqQueryFolderItem> getQueryFolderItems()
                                                    throws WvcmException
Returns the value of the QUERY_FOLDER_ITEMS property as defined by this proxy.

Returns:
A ResourceList containing a proxy for each immediate member of this query folder.
Throws:
WvcmException - if this proxy does not define a value for the QUERY_FOLDER_ITEMS property.

getUserAccessRights

List<StpAccessControlEntry> getUserAccessRights(String userName,
                                                StpAccessControlEntry.EntryType type,
                                                boolean nested)
                                                throws WvcmException
Retrieves from this proxy, the StpAccessControlEntry list returned as the value of a requested property named by a UserAccessRightsName having the same parameters as this method.

Parameters:
userName - The name of the user for which access rights were requested.
type - The EntryType of the access rights requested.
nested - true if the access rights of the specified type and user were also to be returned for the folders nested within this folder; false if just the access rights on this folder were to be included.
Returns:
A list of StpAccessControlEntry objects, each representing an AccessRight of the type and user as requested.
Throws:
WvcmException - If the implied GroupAccessRights property was not requested or not otherwise available.

setNeedsRefresh

void setNeedsRefresh()
Sets the NEEDS_REFRESH property. Doing this will cause the folder's list of children to be reread.


Generated Thu 18-Aug-2016 11:59 AM

Copyright © IBM 2016. All rights reserved.