Project: stp

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

All Superinterfaces:
CqContextResource, CqResource, CqUserDbMember, Resource, StpResource
All Known Subinterfaces:
CqQuery, CqQueryFolder, CqReport, CqReportFormat

public interface CqQueryFolderItem
extends CqContextResource

A specification for an item in a query folder, which may be a query, chart, report, report format, or a nested query folder.

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>
 


Nested Class Summary
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.
 
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> 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.
 
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
 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.
 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.
 
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

CAN_UPDATE_OR_DELETE

static final PropertyNameList.PropertyName<Boolean> CAN_UPDATE_OR_DELETE
Indicates whether or not this query folder item can be updated and/or deleted by the user.


CQ_MASTER_REPLICA

static final PropertyNameList.PropertyName<CqReplica> CQ_MASTER_REPLICA
The replica that masters this resource. A resource can be modified only in the replica that masters (has mastership of) it.


IS_SITE_EXTENDED_NAME_REQUIRED

static final PropertyNameList.PropertyName<Boolean> IS_SITE_EXTENDED_NAME_REQUIRED
An indication whether or not a site extended name is required to access this resource unambiguously.


QUERY_FOLDER

static final PropertyNameList.PropertyName<CqQueryFolder> QUERY_FOLDER
The query folder that contains this folder


SITE_EXTENDED_NAME

static final PropertyNameList.PropertyName<StpLocation> SITE_EXTENDED_NAME
The site-extended name for this folder item.


SITE_EXTENDED_NAMES

static final 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.

Method Detail

doCopy

CqQueryFolderItem doCopy(CqQueryFolder parentFolder,
                         String childName,
                         CqQueryFolderItem.OverwriteMode overwrite,
                         Feedback feedback,
                         List<CqContextResource> deliveryOrder)
                         throws WvcmException
Makes an editable copy of the query folder item named by this proxy at the location specified in the argument list. Any dirty properties are written to the new copy after it is created, not to the resource addressed by this proxy.

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.

Parameters:
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.
Returns:
A CqQueryFolderItem proxy for the new copy of this query folder item. Unless the deliver option was specified, this query definition will be editable.
Throws:
WvcmException - if the server is unable to create the copy at the specified location.

doCopy

CqQueryFolderItem doCopy(StpLocation destination,
                         CqQueryFolderItem.OverwriteMode overwrite,
                         Feedback feedback,
                         List<CqContextResource> deliveryOrder)
                         throws WvcmException
Makes an editable copy of the query folder item named by this proxy at the location specified in the argument list. Any dirty properties in this proxy are written to the new copy after it is created, not to the resource referenced by this proxy. This item is not modified by this operation.

Parameters:
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.
Returns:
A CqQueryFolderItem proxy for the new copy of this item. Unless the deliver option was specified, the copied query item will be editable.
Throws:
WvcmException - if the server is unable to create the copy at the specified location.

doMove

CqQueryFolderItem doMove(CqQueryFolder parentFolder,
                         String childName,
                         CqQueryFolderItem.OverwriteMode overwrite,
                         Feedback feedback,
                         List<CqContextResource> deliveryOrder)
                         throws WvcmException
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. Any dirty properties are written to the new copy after it is created.

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.

Parameters:
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.
Returns:
A proxy for the new copy of this resource. Unless the deliver option was specified, this resource will be editable.
Throws:
WvcmException - if the server is unable to create the copy at the specified location.

doMove

CqQueryFolderItem doMove(StpLocation destination,
                         CqQueryFolderItem.OverwriteMode overwrite,
                         Feedback feedback,
                         List<CqContextResource> deliveryOrder)
                         throws WvcmException
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. Any dirty properties are written to the new copy after it is created.

Parameters:
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.
Returns:
A proxy for the new copy of this resource. Unless the deliver option was specified, the resource at the proxy location will be editable.
Throws:
WvcmException - if the server is unable to create the copy at the specified location.

getCanUpdateOrDelete

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

Returns:
true if this query folder item can be updated or deleted by the current user.
Throws:
WvcmException - if this proxy does not define a value for the CAN_UPDATE_OF_DELETE 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 has mastership of this resource.
Throws:
WvcmException - if this proxy does not define a value for the CQ_MASTER_REPLICA property.

getIsSiteExtendedNameRequired

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

Returns:
true if the name of this resource requires a site extension field to be unambiguous; false if no site extension field is needed
Throws:
WvcmException - if this proxy does not define a value for the IS_SITE_EXTENDED_NAME_REQUIRED property.

getQueryFolder

CqQueryFolder getQueryFolder()
                             throws WvcmException
Returns the value of the QUERY_FOLDER property as defined by this proxy.

Returns:
A CqQueryFolder proxy for the query folder that contains this folder. Will be null if there is no containing query folder.
Throws:
WvcmException - if this proxy does not define a value for the QUERY_FOLDER property.

getSiteExtendedName

StpLocation getSiteExtendedName()
                                throws WvcmException
Returns the value of the SITE_EXTENDED_NAME property as defined by this proxy.

Returns:
An StpLocation containing the site-extended name for this resource.
Throws:
WvcmException - if this proxy does not define a value for the SITE_EXTENDED_NAME property.

getSiteExtendedNames

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

Returns:
A ResourceList containing a proxy for each CqQueryFolderItem resource whose name differs from the name of this resource only in the site extensions used.
Throws:
WvcmException - if this proxy does not define a value for the SITE_EXTENDED_NAMES property.

setCqMasterReplica

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

Parameters:
newMasterReplica - A CqReplica proxy identifying the replica that should assume mastership of this resource.

Generated Wed 29-Feb-2012 11:58 AM

Copyright © IBM 2012. All rights reserved.