org.eclipse.tigerstripe.workbench.queries
Interface IQueryArtifactsByType

All Superinterfaces:

IArtifactQuery

public interface IQueryArtifactsByType
extends IArtifactQuery

This query returns all artifacts of the specified type for a Tigerstripe project.

Author:

Eric Dillon

Method Summary

java.lang.String	getArtifactType() Returns the FQN of the current aryifact type for this query.
java.lang.String[]	getSupportedTypes() Returns an array of the valid artifact type FQNs for the query.
void	setArtifactType(java.lang.String type) Used to identify the types of artifact that should be returned.

Methods inherited from interface org.eclipse.tigerstripe.workbench.queries.IArtifactQuery

includeDependencies, setIncludeDependencies

Method Detail

setArtifactType

void setArtifactType(java.lang.String type)

Used to identify the types of artifact that should be returned. The type argument should be the FQN of the class for the artifacts to be returned. Use getSupportedTypes() to obtain a list of valid Strings to be passed. Only one artifact type can be specified for a given query instance.

Parameters:

FQN - of the artifact types that should be returned

getArtifactType

java.lang.String getArtifactType()

Returns the FQN of the current aryifact type for this query.

Returns:

FQN of the artifact types that should be returned

getSupportedTypes

java.lang.String[] getSupportedTypes()

Returns an array of the valid artifact type FQNs for the query. There will be one entry per artifact type in the model.

Returns:

an array of valid FQNs