com.ibm.team.workitem.common.query

Interface IQueryDescriptor

All Superinterfaces:

IAuditable, IAuditableHandle, IItem, IItemHandle, IManagedItem, IManagedItemHandle, IProjectScoped, IQueryDescriptorHandle

public interface IQueryDescriptor
extends IQueryDescriptorHandle, IAuditable, IProjectScoped

Since:

0.5

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ASSOCIATIONS_PROPERTY
static java.lang.String	CREATOR_PROPERTY
static ItemProfile<IQueryDescriptor>	DEFAULT_PROFILE
static java.lang.String	DESCRIPTION_PROPERTY
static java.lang.String	EXPRESSION_PROPERTY
static ItemProfile<IQueryDescriptor>	FULL_PROFILE
static java.lang.String	HAS_PARAMETERS_PROPERTY
static java.lang.String	ID_PROPERTY
static IItemType	ITEM_TYPE
static java.lang.String	NAME_PROPERTY
static java.lang.String	PARAMETER_VALUES_PROPERTY
static java.lang.String	PROJECTAREA_PROPERTY
static ItemProfile<IQueryDescriptor>	SMALL_PROFILE
static java.lang.String	TAGS_PROPERTY
static java.lang.String	TYPE_PROPERTY

Fields inherited from interface com.ibm.team.repository.common.IAuditable

MERGE_PREDECESSOR_STATE_PROPERTY, PREDECESSOR_STATE_PROPERTY

Fields inherited from interface com.ibm.team.repository.common.IItem

CONTEXT_ID_PROPERTY, ITEM_ID_PROPERTY, MAX_LARGE_STRING_BYTES, MAX_MEDIUM_STRING_BYTES, MAX_SMALL_STRING_BYTES, MODIFIED_BY_PROPERTY, MODIFIED_PROPERTY, STATE_ID_PROPERTY

Method Summary

Methods

Modifier and Type	Method and Description
IAssociations	getAssociations()
IContributorHandle	getCreator()
java.lang.String	getDescription()
Expression	getExpression()
java.lang.String	getId()
java.lang.String	getName()
ParameterVariableContext	getParameterValues() Deprecated.
java.util.Map<java.lang.String,VariableAttributeExpression>	getParameterVariables()
IProjectAreaHandle	getProjectArea()
java.lang.String	getQueryType()
Expression	getResolvedExpression() Deprecated.
java.lang.String	getTags()
boolean	hasParameterVariables()
boolean	isShared()
void	reset() Deprecated.
void	setDescription(java.lang.String value)
void	setExpression(Expression value)
void	setExpression(Expression value, java.lang.Boolean isFullTextSearchPrefixAllowed)
void	setId(java.lang.String id)
void	setName(java.lang.String value)
void	setParameterValues(ParameterVariableContext parameterValues) Deprecated.
void	setProjectArea(IProjectAreaHandle projectArea)
void	setQueryType(java.lang.String type)
void	setTags(java.lang.String value)

Methods inherited from interface com.ibm.team.repository.common.IAuditable

getMergePredecessorState, getPredecessorState

Methods inherited from interface com.ibm.team.repository.common.IManagedItem

isNewItem

Methods inherited from interface com.ibm.team.repository.common.IItem

getContextId, getItemHandle, getModifiedBy, getRedactedCopy, getRequestedModified, getRequestedStateId, getStateHandle, getWorkingCopy, hasHistory, isComplete, isPropertySet, isRedactedCopy, isWorkingCopy, modified, setContextId, setRequestedModified, setRequestedStateId

Methods inherited from interface com.ibm.team.repository.common.IItemHandle

equals, getAdapter, getFullState, getItemId, getItemType, getOrigin, getStateId, hasFullState, hasStateId, isAuditable, isConfigurationAware, isImmutable, isSimple, isUnmanaged, makeImmutable, protect, sameItemId, sameStateId, size

Field Detail

ITEM_TYPE

static final IItemType ITEM_TYPE

NAME_PROPERTY

static final java.lang.String NAME_PROPERTY

ID_PROPERTY

static final java.lang.String ID_PROPERTY

DESCRIPTION_PROPERTY

static final java.lang.String DESCRIPTION_PROPERTY

CREATOR_PROPERTY

static final java.lang.String CREATOR_PROPERTY

EXPRESSION_PROPERTY

static final java.lang.String EXPRESSION_PROPERTY

TYPE_PROPERTY

static final java.lang.String TYPE_PROPERTY

TAGS_PROPERTY

static final java.lang.String TAGS_PROPERTY

PROJECTAREA_PROPERTY

static final java.lang.String PROJECTAREA_PROPERTY

ASSOCIATIONS_PROPERTY

static final java.lang.String ASSOCIATIONS_PROPERTY

HAS_PARAMETERS_PROPERTY

static final java.lang.String HAS_PARAMETERS_PROPERTY

PARAMETER_VALUES_PROPERTY

static final java.lang.String PARAMETER_VALUES_PROPERTY

See Also:

Constant Field Values

SMALL_PROFILE

static final ItemProfile<IQueryDescriptor> SMALL_PROFILE

FULL_PROFILE

static final ItemProfile<IQueryDescriptor> FULL_PROFILE

DEFAULT_PROFILE

static final ItemProfile<IQueryDescriptor> DEFAULT_PROFILE

Method Detail

getQueryType

java.lang.String getQueryType()

setQueryType

void setQueryType(java.lang.String type)

getName

java.lang.String getName()

setName

void setName(java.lang.String value)

getDescription

java.lang.String getDescription()

setDescription

void setDescription(java.lang.String value)

getTags

java.lang.String getTags()

setTags

void setTags(java.lang.String value)

getExpression

Expression getExpression()
                         throws SerializationException

Throws:

SerializationException

setExpression

void setExpression(Expression value)
                   throws SerializationException

Throws:

SerializationException

setExpression

void setExpression(Expression value,
                 java.lang.Boolean isFullTextSearchPrefixAllowed)
                   throws SerializationException

Throws:

SerializationException

setProjectArea

void setProjectArea(IProjectAreaHandle projectArea)

getProjectArea

IProjectAreaHandle getProjectArea()

Specified by:

getProjectArea in interface IProjectScoped

getCreator

IContributorHandle getCreator()

getAssociations

IAssociations getAssociations()

getId

java.lang.String getId()

setId

void setId(java.lang.String id)

isShared

boolean isShared()

hasParameterVariables

boolean hasParameterVariables()

getParameterVariables

java.util.Map<java.lang.String,VariableAttributeExpression> getParameterVariables()

reset

@Deprecated
void reset()

Deprecated.

DO NOT USE -- Will be replaced

getParameterValues

@Deprecated
ParameterVariableContext getParameterValues()

Deprecated.

DO NOT USE -- Will be replaced

setParameterValues

@Deprecated
void setParameterValues(ParameterVariableContext parameterValues)

Deprecated.

DO NOT USE -- Will be replaced

getResolvedExpression

@Deprecated
Expression getResolvedExpression()
                                 throws UnboundQueryParameterException

Deprecated.

DO NOT USE -- Will be replaced

Throws:

UnboundQueryParameterException