Package javax.jdo.annotations

Annotation Type Query

@Target(TYPE)
@Retention(RUNTIME)
@Repeatable(Queries.class)
public @interface Query

Annotation for a named query. Corresponds to the xml element "query".

Since:

2.1

Version:

2.1

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	name	Name of the query (mandatory)
String	value	The query string (mandatory)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Extension[]	extensions	Vendor extensions.
String	fetchPlan	The name of the fetch plan used by this query
String	language	The query language
Class	resultClass	Result class into which to put the results.
String	unique	Whether the query returns a single unique result.
String	unmodifiable	Whether the query is unmodifiable.

Element Detail

name

String name

Name of the query (mandatory)

Returns:

the name of the query

value

String value

The query string (mandatory)

Returns:

the query string

language

String language

The query language

Returns:

the query language

Default:

"JDOQL"

unmodifiable

String unmodifiable

Whether the query is unmodifiable.

Returns:

whether the query is unmodifiable

Default:

""

unique

String unique

Whether the query returns a single unique result.

Returns:

whether the query returns a single unique result

Default:

""

resultClass

Class resultClass

Result class into which to put the results.

Returns:

the class of the result

Default:

void.class

fetchPlan

String fetchPlan

The name of the fetch plan used by this query

Returns:

the fetch plan

Default:

""

extensions

Extension[] extensions

Vendor extensions.

Returns:

the vendor extensions

Default:

{}