public interface CqQueryFolderItem extends CqContextResource
The user-friendly specification for the location of a query folder item has the form
cq.query:<parent-folder-path>/<item-name>@<db-set>/<user-db>
Modifier and Type | Interface and Description |
---|---|
static class |
CqQueryFolderItem.OverwriteMode
An enumeration of the values for specifying what doCopy and/or doMove
should do when a resource already exists at the targeted destination.
|
StpResource.UnsupportedProperty
Resource.CopyFlag
Modifier and Type | Field and Description |
---|---|
static PropertyNameList.PropertyName<Boolean> |
CAN_UPDATE_OR_DELETE
Indicates whether or not this query folder item can be updated and/or
deleted by the user.
|
static PropertyNameList.PropertyName<CqReplica> |
CQ_MASTER_REPLICA
The replica that masters this resource.
|
static PropertyNameList.PropertyName<Boolean> |
IS_SITE_EXTENDED_NAME_REQUIRED
An indication whether or not a site extended name is required to access
this resource unambiguously.
|
static PropertyNameList.PropertyName<CqQueryFolder> |
QUERY_FOLDER
The query folder that contains this folder
|
static PropertyNameList.PropertyName<StpLocation> |
SITE_EXTENDED_NAME
The site-extended name for this folder item.
|
static PropertyNameList.PropertyName<ResourceList<CqQueryFolderItem>> |
SITE_EXTENDED_NAMES
A list of all the items in the query folder hierarchy whose name differs
from the name of this resource only in its site extensions.
|
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
Modifier and Type | Method and Description |
---|---|
CqQueryFolderItem |
doCopy(CqQueryFolder parentFolder,
String childName,
CqQueryFolderItem.OverwriteMode overwrite,
Feedback feedback,
List<CqContextResource> deliveryOrder)
Makes an editable copy of the query folder item named by this proxy at
the location specified in the argument list.
|
CqQueryFolderItem |
doCopy(StpLocation destination,
CqQueryFolderItem.OverwriteMode overwrite,
Feedback feedback,
List<CqContextResource> deliveryOrder)
Makes an editable copy of the query folder item named by this proxy at
the location specified in the argument list.
|
CqQueryFolderItem |
doMove(CqQueryFolder parentFolder,
String childName,
CqQueryFolderItem.OverwriteMode overwrite,
Feedback feedback,
List<CqContextResource> deliveryOrder)
Makes an editable copy of the query folder item named by this proxy in
the query folder specified in the argument list and deletes the query
folder item at the current proxy location.
|
CqQueryFolderItem |
doMove(StpLocation destination,
CqQueryFolderItem.OverwriteMode overwrite,
Feedback feedback,
List<CqContextResource> deliveryOrder)
Makes an editable copy of the query folder item named by this proxy at
the location specified in the argument list and deletes the query folder
item at the current proxy location.
|
CqQueryFolderItem |
doRename(CqQueryFolder parentFolder,
String newName,
Feedback feedback,
List<CqContextResource> deliveryOrder)
Directly rename the query item without change any other property of it.
|
boolean |
getCanUpdateOrDelete()
Returns the value of the
CAN_UPDATE_OR_DELETE property as defined by
this proxy. |
CqReplica |
getCqMasterReplica()
Returns the value of the
CQ_MASTER_REPLICA
property as defined by this proxy. |
boolean |
getIsSiteExtendedNameRequired()
Returns the value of the
IS_SITE_EXTENDED_NAME_REQUIRED
property as defined by this proxy. |
CqQueryFolder |
getQueryFolder()
Returns the value of the
QUERY_FOLDER property as
defined by this proxy. |
StpLocation |
getSiteExtendedName()
Returns the value of the
SITE_EXTENDED_NAME
property as defined by this proxy. |
ResourceList<CqQueryFolderItem> |
getSiteExtendedNames()
Returns the value of the
SITE_EXTENDED_NAMES
property as defined by this proxy. |
void |
setCqMasterReplica(CqReplica newMasterReplica)
Defines a new value for the
CQ_MASTER_REPLICA
property of this proxy. |
doDeliver, doRevert, doUnbindAll, doUnbindAll, doWriteProperties, doWriteProperties, getIsModified
getDbSet, getUserDb
cqProvider, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getCreatorGroupName, getCreatorLoginName, getIsExecutable, getLastModified, getProviderList, getWorkspaceFolderList, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setIsExecutable
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, 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
static final PropertyNameList.PropertyName<Boolean> CAN_UPDATE_OR_DELETE
static final PropertyNameList.PropertyName<CqReplica> CQ_MASTER_REPLICA
static final PropertyNameList.PropertyName<Boolean> IS_SITE_EXTENDED_NAME_REQUIRED
static final PropertyNameList.PropertyName<CqQueryFolder> QUERY_FOLDER
static final PropertyNameList.PropertyName<StpLocation> SITE_EXTENDED_NAME
static final PropertyNameList.PropertyName<ResourceList<CqQueryFolderItem>> SITE_EXTENDED_NAMES
CqQueryFolderItem doCopy(CqQueryFolder parentFolder, String childName, CqQueryFolderItem.OverwriteMode overwrite, Feedback feedback, List<CqContextResource> deliveryOrder) throws WvcmException
This variant of doCopy is provided because in the presence of stable or
fast location formats the client cannot always guarantee that
parentFolder.child(childName)
will be a valid location
specification.
parentFolder
- The folder to which this query folder item is to be
copied. The proxy must name an existing query folder of this
user database.childName
- The name the copy of this resource is to have in the
destination folder.overwrite
- Specifies how a query folder item already at the target
location is to be handled.feedback
- The query properties to be defined by the proxy that is
returned by this method.deliveryOrder
- Same as the version of
doCopy taking an StpLocation
.WvcmException
- if the server is unable to create the copy at the
specified location.CqQueryFolderItem doCopy(StpLocation destination, CqQueryFolderItem.OverwriteMode overwrite, Feedback feedback, List<CqContextResource> deliveryOrder) throws WvcmException
destination
- The location where a new copy of this query folder
item is to be created. The parent folder of this location must
already exist in the query folder hierarchy of the database.overwrite
- Specifies how a query folder item already at the target
location is to be handled.feedback
- A request for the properties to be defined by the proxy
that is returned by this method.deliveryOrder
- If CqProvider.HOLD
, the copied resource is
left in a writable state in the change context--the copied
resource in the change context must be delivered before it
becomes visible to other providers. If not
CqProvider.HOLD
, the modified and moribund resources
specified by this parameter will be delivered to or deleted
from the database in the order indicated. To deliver all
modified and moribund resources in an arbitrary order, use
CqProvider.DELIVER_ALL
. To deliver just this copied
resource, use CqProvider.DELIVER
. Must not be null.WvcmException
- if the server is unable to create the copy at the
specified location.CqQueryFolderItem doMove(CqQueryFolder parentFolder, String childName, CqQueryFolderItem.OverwriteMode overwrite, Feedback feedback, List<CqContextResource> deliveryOrder) throws WvcmException
This variant of doMove is provided because in the presence of stable or
fast location formats the client cannot always guarantee that
parentFolder.child(childName)
is a valid location
specification.
parentFolder
- The folder to which this query folder item is to be
moved. The location must name an existing query folder of this
user database.childName
- The name this resource is to have in the destination
folder.overwrite
- Specifies how a query folder item already at the target
location is to be handled.feedback
- The properties to be defined by the proxy that is
returned by this method.deliveryOrder
- Same as the deliveryOrder parameter of
doCopy
.
But note that use of CqProvider.DELIVER
both
delivers the copy and deletes the original query folder item.WvcmException
- if the server is unable to create the copy at the
specified location.CqQueryFolderItem doMove(StpLocation destination, CqQueryFolderItem.OverwriteMode overwrite, Feedback feedback, List<CqContextResource> deliveryOrder) throws WvcmException
destination
- The location to which this query folder item is to be
moved. The location must be in the QUERY namespace of this
user database.overwrite
- Specifies how a query folder item already at the target
location is to be handled.feedback
- The properties to be defined by the proxy that is
returned by this method.deliveryOrder
- Same as the deliveryOrder parameter of
doCopy
.
But note that use of CqProvider.DELIVER
both delivers
the copy and deletes the original query folder item.WvcmException
- if the server is unable to create the copy at the
specified location.CqQueryFolderItem doRename(CqQueryFolder parentFolder, String newName, Feedback feedback, List<CqContextResource> deliveryOrder) throws WvcmException
parentFolder
- The folder to which this query folder item is belongednewName
- The name this resource will be renamed tofeedback
- The properties to be defined by the proxy that is
returned by this method.deliveryOrder
- Same as the deliveryOrder parameter of
doCopy
.WvcmException
- if the server is unable to rename the resource with the
new name.boolean getCanUpdateOrDelete() throws WvcmException
CAN_UPDATE_OR_DELETE
property as defined by
this proxy.WvcmException
- if this proxy does not define a value for the
CAN_UPDATE_OF_DELETE
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.boolean getIsSiteExtendedNameRequired() throws WvcmException
IS_SITE_EXTENDED_NAME_REQUIRED
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
IS_SITE_EXTENDED_NAME_REQUIRED
property.CqQueryFolder getQueryFolder() throws WvcmException
QUERY_FOLDER
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
QUERY_FOLDER
property.StpLocation getSiteExtendedName() throws WvcmException
SITE_EXTENDED_NAME
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
SITE_EXTENDED_NAME
property.ResourceList<CqQueryFolderItem> getSiteExtendedNames() throws WvcmException
SITE_EXTENDED_NAMES
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
SITE_EXTENDED_NAMES
property.void setCqMasterReplica(CqReplica newMasterReplica)
CQ_MASTER_REPLICA
property of this proxy.newMasterReplica
- A CqReplica proxy identifying the replica that
should assume mastership of this resource.Copyright © IBM 2017. All rights reserved.