oracle.calendar.soap.client.query
Class vQuery

java.lang.Object
oracle.calendar.soap.client.query.vQuery

public class vQuery

extends java.lang.Object

The vQuery class provides the ability to identify what data is to be retrieved from the Calendar Server through Web services. The vQuery is modeled after the IETF CAP query, but people familiar with SQL will recognize the components.

• The <Select> clause permits the selection of specific attributes to be returned.
• The <From> clause permits the selection of the user's data store, either events or tasks.
• The <Where> clause is used to provide a query for the Web Services to execute. The grammar is similar to SQL. However, there is no SQL parser in the background; only specific formats of <Where> clauses are implemented.
• The vCall is analogous to a stored procedure call. It is used to refer a complex <Where> clause stored in Web Services. However, unlike stored procedures, there is no way to program them.

The vQuery object must be instantiated and added to a Calendaring Command.

See Also:

CalendaringCommand, SearchCommand

Field Summary

static java.lang.String	k_basicSearch
static java.lang.String	k_overlap
static java.lang.String	k_queryFrom
static java.lang.String	k_queryFromEvent
static java.lang.String	k_queryFromTodo
static java.lang.String	k_queryLimitAttendees
static java.lang.String	k_querySearchHandle
static java.lang.String	k_querySelect
static java.lang.String	k_queryTimeStamp
static java.lang.String	k_queryVquery
static java.lang.String	k_queryWhere

Constructor Summary

vQuery()
Default constructor version 2002-12-16 fix008343

Method Summary

org.w3c.dom.Element	getElement(org.w3c.dom.Document in_document) Returns a new XML DOM structure representing the vQuery XML tree structure.
void	setCall(vCall in_call) Specifies a vCall object to the query.
void	setFrom(java.lang.String in_from) Specifies the <From> clause of the query.
void	setSelect(java.lang.String in_select) Specifies the <Select> clause of the query.
void	setWhere(java.lang.String in_where) Specifies the <Where> clause of the query.
void	setXBasicSearch(java.lang.String in_basicSearch) Specifies the basic search sting.
void	setXLimitAttendees(java.lang.String in_numAttendees) Specifies the maximum number of attendess that will be retrieved from the Calendar store.
void	setXOverlap(boolean in_overlap) Specifies the overlap flag; events that overlap the given date range will be retrieved.
void	setXSearchHandle(java.lang.String in_searchHandle) Sets the search handle.
void	setXTimeStamp(java.lang.String in_timeStamp) Specifies the current timestamp.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

k_queryFromEvent

public static final java.lang.String k_queryFromEvent

See Also:

Constant Field Values

k_queryFromTodo

public static final java.lang.String k_queryFromTodo

See Also:

Constant Field Values

k_queryVquery

public static final java.lang.String k_queryVquery

See Also:

Constant Field Values

k_querySelect

public static final java.lang.String k_querySelect

See Also:

Constant Field Values

k_queryFrom

public static final java.lang.String k_queryFrom

See Also:

Constant Field Values

k_queryWhere

public static final java.lang.String k_queryWhere

See Also:

Constant Field Values

k_querySearchHandle

public static final java.lang.String k_querySearchHandle

See Also:

Constant Field Values

k_queryLimitAttendees

public static final java.lang.String k_queryLimitAttendees

See Also:

Constant Field Values

k_queryTimeStamp

public static final java.lang.String k_queryTimeStamp

See Also:

Constant Field Values

k_overlap

public static final java.lang.String k_overlap

See Also:

Constant Field Values

k_basicSearch

public static final java.lang.String k_basicSearch

See Also:

Constant Field Values

Constructor Detail

vQuery

public vQuery()

Default constructor version 2002-12-16 fix008343

Method Detail

setSelect

public void setSelect(java.lang.String in_select)

Specifies the <Select> clause of the query. version 2002-12-16 fix008343

Parameters:

in_select - Select string

setFrom

public void setFrom(java.lang.String in_from)

Specifies the <From> clause of the query. The parameter should be one of the public static strings k_queryFromEvent or k_queryFromTodo. version 2002-12-16 fix008343

Parameters:

in_from - From string

setWhere

public void setWhere(java.lang.String in_where)

Specifies the <Where> clause of the query. Note: Only very specific queries are supported. All others will cause a SOAP fault. version 2002-12-16 fix008343

Parameters:

in_where - Where string

setCall

public void setCall(vCall in_call)

Specifies a vCall object to the query. This is done in place of specifying a <Where> clause string. version 2002-12-16 fix008343

Parameters:

in_call - vCall object

See Also:

vCall

setXOverlap

public void setXOverlap(boolean in_overlap)

Specifies the overlap flag; events that overlap the given date range will be retrieved. For example, if a search query with a date range of today is sent to Calendar Web services along with this option set, a meeting starting yesterday and finishing tomorow would be retrieved.

By default, this option on the query is set to false.

version 2004-06-02 fix010458

Parameters:

in_overlap - overlap true|false

setXBasicSearch

public void setXBasicSearch(java.lang.String in_basicSearch)

Specifies the basic search sting. The Search method will retrieve events that contain the basic search string in any of the <title>, <location>, or <description&gl; properties. version 2004-06-30 fix010579

Parameters:

in_basicSearch - basic search string

setXSearchHandle

public void setXSearchHandle(java.lang.String in_searchHandle)

Sets the search handle. This will trigger the use of the internal Calender Store search API (Ultra Search). In this implementation, set the search handle to the empty string, "". version 2003-06-18 fix009370

Parameters:

in_searchHandle - search handle

setXTimeStamp

public void setXTimeStamp(java.lang.String in_timeStamp)

Specifies the current timestamp. The date time information must be an xCal UTC string. This timestamp is used in the Ultra Search query when no dtstart information is provided. version 2003-06-25 fix009370

Parameters:

in_timeStamp - a timestamp

setXLimitAttendees

public void setXLimitAttendees(java.lang.String in_numAttendees)

Specifies the maximum number of attendess that will be retrieved from the Calendar store. If no attendee information is required, set this value to "0". Retrieving attendee information is typically a very expensive operation on the Calendar store. If the value is not set, all attendee information will be returned (limited by Web Services configuration and calendar store settings).version 2003-02-05 fix008501

Parameters:

in_numAttendees - limit of number of attendees retrieved

getElement

public org.w3c.dom.Element getElement(org.w3c.dom.Document in_document)

Returns a new XML DOM structure representing the vQuery XML tree structure. This is called internally when a CalendaringCommand is generated to DOM format. version 2004-07-07 fix010579

Returns:

Element - XML DOM element tree