public interface CqQueryFolder extends Folder, CqQueryFolderItem, StpAccessControlledResource
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>
Modifier and Type | Interface and Description |
---|---|
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
|
Folder.BindFlag, Folder.RebindFlag
CqQueryFolderItem.OverwriteMode
StpResource.UnsupportedProperty
Resource.CopyFlag
Modifier and Type | Field and Description |
---|---|
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.
|
CHILD_LIST, CHILD_MAP
CAN_UPDATE_OR_DELETE, CQ_MASTER_REPLICA, IS_SITE_EXTENDED_NAME_REQUIRED, QUERY_FOLDER, SITE_EXTENDED_NAME, SITE_EXTENDED_NAMES
IS_MODIFIED
DB_SET, USER_DB
ALL_PROPERTIES, AUTHENTICATION_REALM, CREATOR_GROUP_NAME, CREATOR_LOGIN_NAME, EFFICIENT_LOCATION, INVALID_PROPERTIES, REPOSITORY, STABLE_LOCATION, USER_FRIENDLY_LOCATION
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
ACCESS_RIGHTS, APPLIED_ACCESS_CONTROL_ENTRIES, CAN_CHANGE_ACCESS_RIGHTS, EFFECTIVE_ACCESS_CONTROL_ENTRIES, POSSIBLE_ACCESS_RIGHTS
Modifier and Type | Method and Description |
---|---|
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.
|
doBindChild, doReadMemberList, doRebindAll, doRebindChild, doUnbindChild, getChildList, getChildMap
doCopy, doCopy, doMove, doMove, doRename, getCanUpdateOrDelete, getCqMasterReplica, getIsSiteExtendedNameRequired, getQueryFolder, getSiteExtendedName, getSiteExtendedNames, setCqMasterReplica
doDeliver, doRevert, doUnbindAll, doUnbindAll, doWriteProperties, doWriteProperties, getIsModified
getDbSet, getUserDb
cqProvider, getCreatorGroupName, getCreatorLoginName
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, setPropertyClean, stpLocation, stpProvider
doCopy, doFind, doFindAll, doGetPropertyNameList, doGetPropertyNameList, doReadContent, doReadProperties, doWriteContent, forgetProperty, getDisplayName, getParentList, getPathnameLocation, getProperty, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setDisplayName, setProperty, setProperty, updatedPropertyNameList
getAccessRights, getAppliedAccessControlEntries, getCanChangeAccessRights, getEffectiveAccessControlEntries, getPossibleAccessRights, setAppliedAccessControlEntries, setAppliedAccessControlEntries
static final PropertyNameList.PropertyName<Boolean> IS_READABLE
static final PropertyNameList.PropertyName<Boolean> IS_WRITABLE
static final PropertyNameList.PropertyName<Boolean> NEEDS_REFRESH
static final PropertyNameList.PropertyName<ResourceList<CqQueryFolderItem>> QUERY_FOLDER_ITEMS
CqQueryFolder doCreateFolder(Feedback feedback) throws WvcmException
feedback
- A Feedback object specifying the information desired from
the new folder after it has been created.WvcmException
- If the folder cannot be created at the specified
location.CqQueryFolder doCreateFolder(Feedback feedback, List<CqContextResource> deliveryOrder) throws WvcmException
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.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.List<StpAccessControlEntry> getGroupAccessRights(String groupName, StpAccessControlEntry.EntryType type, boolean nested) throws WvcmException
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.WvcmException
- If the implied GroupAccessRights property was not
requested or not otherwise available.boolean getIsReadable() throws WvcmException
IS_READABLE
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
IS_READABLE
property.boolean getIsWritable() throws WvcmException
IS_WRITABLE
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
IS_WRITABLE
property.ResourceList<CqQueryFolderItem> getQueryFolderItems() throws WvcmException
QUERY_FOLDER_ITEMS
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
QUERY_FOLDER_ITEMS
property.List<StpAccessControlEntry> getUserAccessRights(String userName, StpAccessControlEntry.EntryType type, boolean nested) throws WvcmException
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.WvcmException
- If the implied GroupAccessRights property was not
requested or not otherwise available.void setNeedsRefresh()
Copyright © IBM 2016. All rights reserved.