Project: stp

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

All Superinterfaces:
Resource, StpResource
All Known Subinterfaces:
CqAction, CqAttachment, CqAttachmentFolder, CqContextResource, CqDb, CqDbSet, CqDynamicChoiceList, CqFieldDefinition, CqGroup, CqHook, CqQuery, CqQueryFolder, CqQueryFolderItem, CqRecord, CqRecordType, CqReplica, CqReport, CqReportFormat, CqUser, CqUserDb, CqUserDbMember

public interface CqResource
extends StpResource

Properties and methods common to all ClearQuest resources


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
 
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
 CqProvider cqProvider()
           
 String getComment()
          Most ClearQuest resources do not support the COMMENT property
 String getContentCharacterSet()
          Most ClearQuest resources do not have content and therefore do not support the CONTENT_CHARACTER_SET property
 String getContentIdentifier()
          Most ClearQuest resources do not have content and therefore do not support the CONTENT_IDENTIFIER property
 Locale getContentLanguage()
          Most ClearQuest resources do not have content and therefore do not support the CONTENT_LANGUAGE property
 long getContentLength()
          Most ClearQuest resources do not have content and therefore do not support the CONTENT_LENGTH property
 String getContentType()
          Most ClearQuest resources do not have content and therefore do not support the CONTENT_TYPE property
 Date getCreationDate()
          Most ClearQuest resources do not have content and therefore do not support the CREATION_DATE property
 String getCreatorDisplayName()
          Most ClearQuest resources do not have content and therefore do not support the CREATOR_DISPLAY_NAME property
 String getCreatorGroupName()
          Most ClearQuest resources do not have content and therefore do not support the CREATOR_GROUP_NAME property
 String getCreatorLoginName()
          Most ClearQuest resources do not have content and therefore do not support the CREATOR_LOGIN_NAME property
 Boolean getIsExecutable()
          No ClearQuest resources is executable
 Date getLastModified()
          Most ClearQuest resources do not have content and therefore do not support the LAST_MODIFIED property
 List<String> getProviderList()
          Get the Resource.PROVIDER_LIST property.
 ResourceList<Folder> getWorkspaceFolderList()
          ClearQuest resources do not use workspaces.
 void setComment(String value)
          Most ClearQuest resources do not support the COMMENT property
 void setContentCharacterSet(String value)
          Most ClearQuest resources do not have content and therefore do not support the CONTENT_CHARACTER_SET property
 void setContentLanguage(Locale value)
          Most ClearQuest resources do not have content and therefore do not support the CONTENT_LANGUAGE property
 void setContentType(String value)
          Most ClearQuest resources do not have content and therefore do not support the CONTENT_TYPE property
 void setCreatorDisplayName(String value)
          Most ClearQuest resources do not have content and therefore do not support the CREATOR_DISPLAY_NAME property
 void setIsExecutable(Boolean executable)
          No ClearQuest resource is executable
 
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, doUnbindAll, doWriteContent, doWriteProperties, forgetProperty, getDisplayName, getParentList, getPathnameLocation, getProperty, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setDisplayName, setProperty, setProperty, updatedPropertyNameList
 

Method Detail

cqProvider

CqProvider cqProvider()
Returns:
Returns the CqProvider from which this proxy was obtained.

getComment

String getComment()
                  throws WvcmException
Most ClearQuest resources do not support the COMMENT property

Specified by:
getComment in interface Resource
Returns:
the Resource.COMMENT property.
Throws:
WvcmException - if this property was not set and this Resource was not created with Resource.COMMENT as a wanted property.
See Also:
Resource.getComment()

getContentCharacterSet

String getContentCharacterSet()
                              throws WvcmException
Most ClearQuest resources do not have content and therefore do not support the CONTENT_CHARACTER_SET property

Specified by:
getContentCharacterSet in interface Resource
Returns:
the Resource.CONTENT_CHARACTER_SET property.
Throws:
WvcmException - if this property was not set and this Resource was not created with Resource.CONTENT_CHARACTER_SET as a wanted property.
See Also:
Resource.getContentCharacterSet()()

getContentIdentifier

String getContentIdentifier()
                            throws WvcmException
Most ClearQuest resources do not have content and therefore do not support the CONTENT_IDENTIFIER property

Specified by:
getContentIdentifier in interface Resource
Returns:
the Resource.CONTENT_IDENTIFIER property.
Throws:
WvcmException - if this Resource was not created with Resource.CONTENT_IDENTIFIER as a wanted property.
See Also:
Resource.getContentIdentifier()()

getContentLanguage

Locale getContentLanguage()
                          throws WvcmException
Most ClearQuest resources do not have content and therefore do not support the CONTENT_LANGUAGE property

Specified by:
getContentLanguage in interface Resource
Returns:
the Resource.CONTENT_LANGUAGE property.
Throws:
WvcmException - if this property was not set and this Resource was not created with Resource.CONTENT_LANGUAGE as a wanted property.
See Also:
Resource.getContentLanguage()

getContentLength

long getContentLength()
                      throws WvcmException
Most ClearQuest resources do not have content and therefore do not support the CONTENT_LENGTH property

Specified by:
getContentLength in interface Resource
Returns:
the Resource.CONTENT_LENGTH property.
Throws:
WvcmException - if this Resource was not created with Resource.CONTENT_LENGTH as a wanted property.
See Also:
Resource.getContentLength()()

getContentType

String getContentType()
                      throws WvcmException
Most ClearQuest resources do not have content and therefore do not support the CONTENT_TYPE property

Specified by:
getContentType in interface Resource
Returns:
the Resource.CONTENT_TYPE property.
Throws:
WvcmException - if this property was not set and this Resource was not created with Resource.CONTENT_TYPE as a wanted property.
See Also:
Resource.getContentType()()

getCreationDate

Date getCreationDate()
                     throws WvcmException
Most ClearQuest resources do not have content and therefore do not support the CREATION_DATE property

Specified by:
getCreationDate in interface Resource
Returns:
the Resource.CREATION_DATE property.
Throws:
WvcmException - if this Resource was not created with Resource.CREATION_DATE as a wanted property
See Also:
Resource.getCreationDate()()

getCreatorDisplayName

String getCreatorDisplayName()
                             throws WvcmException
Most ClearQuest resources do not have content and therefore do not support the CREATOR_DISPLAY_NAME property

Specified by:
getCreatorDisplayName in interface Resource
Returns:
the Resource.CREATOR_DISPLAY_NAME property.
Throws:
WvcmException - if this property was not set and this Resource was not created with Resource.CREATOR_DISPLAY_NAME as a wanted property.
See Also:
Resource.getCreatorDisplayName()

getCreatorGroupName

String getCreatorGroupName()
                           throws WvcmException
Most ClearQuest resources do not have content and therefore do not support the CREATOR_GROUP_NAME property

Specified by:
getCreatorGroupName in interface StpResource
Throws:
WvcmException - Thrown if the property was never requested, or is otherwise unavailable (e.g. requested in a client-context only).
See Also:
StpResource.getCreatorGroupName()

getCreatorLoginName

String getCreatorLoginName()
                           throws WvcmException
Most ClearQuest resources do not have content and therefore do not support the CREATOR_LOGIN_NAME property

Specified by:
getCreatorLoginName in interface StpResource
Throws:
WvcmException - Thrown if the property was never requested, or otherwise unavailable (e.g. requested in a client-context only).
See Also:
StpResource.getCreatorLoginName()

getIsExecutable

Boolean getIsExecutable()
                        throws WvcmException
No ClearQuest resources is executable

Specified by:
getIsExecutable in interface Resource
Returns:
the Resource.IS_EXECUTABLE property.
Throws:
WvcmException - if this property was not set and this Resource was not created with Resource.IS_EXECUTABLE as a wanted property.
See Also:
Resource.getIsExecutable()

getLastModified

Date getLastModified()
                     throws WvcmException
Most ClearQuest resources do not have content and therefore do not support the LAST_MODIFIED property

Specified by:
getLastModified in interface Resource
Returns:
the Resource.LAST_MODIFIED property.
Throws:
WvcmException - if this Resource was not created with Resource.LAST_MODIFIED as a wanted property.
See Also:
Resource.getLastModified()

getProviderList

List<String> getProviderList()
                             throws WvcmException
Description copied from interface: Resource
Get the Resource.PROVIDER_LIST property.

Specified by:
getProviderList in interface Resource
Returns:
the Resource.PROVIDER_LIST property.
Throws:
WvcmException - if this Resource was not created with Resource.PROVIDER_LIST as a wanted property.
See Also:
Resource.getWorkspaceFolderList()

getWorkspaceFolderList

ResourceList<Folder> getWorkspaceFolderList()
                                            throws WvcmException
ClearQuest resources do not use workspaces.

Specified by:
getWorkspaceFolderList in interface Resource
Returns:
the Resource.WORKSPACE_FOLDER_LIST property.
Throws:
WvcmException - if this Resource was not created with Resource.WORKSPACE_FOLDER_LIST as a wanted property.
See Also:
Resource.getWorkspaceFolderList()

setComment

void setComment(String value)
Most ClearQuest resources do not support the COMMENT property

Specified by:
setComment in interface Resource
Parameters:
value - the new comment to apply to this Resource.
See Also:
Resource.setComment(java.lang.String)

setContentCharacterSet

void setContentCharacterSet(String value)
Most ClearQuest resources do not have content and therefore do not support the CONTENT_CHARACTER_SET property

Specified by:
setContentCharacterSet in interface Resource
Parameters:
value - the content character set for the resource.
See Also:
Resource.setContentCharacterSet(java.lang.String)

setContentLanguage

void setContentLanguage(Locale value)
Most ClearQuest resources do not have content and therefore do not support the CONTENT_LANGUAGE property

Specified by:
setContentLanguage in interface Resource
Parameters:
value - the content language for the resource.
See Also:
Resource.setContentLanguage(java.util.Locale)

setContentType

void setContentType(String value)
Most ClearQuest resources do not have content and therefore do not support the CONTENT_TYPE property

Specified by:
setContentType in interface Resource
Parameters:
value - the content type for the resource.
See Also:
Resource.setContentType(java.lang.String)

setCreatorDisplayName

void setCreatorDisplayName(String value)
Most ClearQuest resources do not have content and therefore do not support the CREATOR_DISPLAY_NAME property

Specified by:
setCreatorDisplayName in interface Resource
Parameters:
value - the new creator display name to apply to the resource.
See Also:
Resource.setCreatorDisplayName(java.lang.String)

setIsExecutable

void setIsExecutable(Boolean executable)
No ClearQuest resource is executable

Specified by:
setIsExecutable in interface Resource
Parameters:
executable - whether the resource is executable.
See Also:
Resource.getIsExecutable()

Generated Wed 12-Feb-2014 03:12 AM

Copyright © IBM 2014. All rights reserved.