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 modelled 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 will be 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 then in anyway. The vQuery object must be instantiated and added to a Calendaring Command.

See Also:

CalendaringCommand, SearchCommand

Field Summary

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_querySearch
static java.lang.String	k_querySelect
static java.lang.String	k_queryVquery
static java.lang.String	k_queryWhere
private vCall	m_call
private java.lang.String	m_from
private java.lang.String	m_limitAttendees
private java.lang.String	m_searchHandle
private java.lang.String	m_select
private java.lang.String	m_where

Constructor Summary

vQuery()
Default constructor

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) Assigns a vCall object to the query.
void	setFrom(java.lang.String in_from) Sets the from clause for the query.
void	setSearchHandle(java.lang.String in_searchHandle) Sets the search handle.
void	setSelect(java.lang.String in_select) Sets the select clause for the query
void	setWhere(java.lang.String in_where) Sets the where clause for the query.
void	setXLimitAttendees(java.lang.String in_numAttendees) Sets an extended property to limit the number of attendees retrieved from the calendar store.

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

k_queryFromEvent

public static final java.lang.String k_queryFromEvent

k_queryFromTodo

public static final java.lang.String k_queryFromTodo

k_queryVquery

public static final java.lang.String k_queryVquery

k_querySelect

public static final java.lang.String k_querySelect

k_queryFrom

public static final java.lang.String k_queryFrom

k_queryWhere

public static final java.lang.String k_queryWhere

k_querySearch

public static final java.lang.String k_querySearch

k_queryLimitAttendees

public static final java.lang.String k_queryLimitAttendees

m_select

private java.lang.String m_select

m_from

private java.lang.String m_from

m_where

private java.lang.String m_where

m_call

private vCall m_call

m_limitAttendees

private java.lang.String m_limitAttendees

m_searchHandle

private java.lang.String m_searchHandle

Constructor Detail

vQuery

public vQuery()

Default constructor

Method Detail

setSelect

public void setSelect(java.lang.String in_select)

Sets the select clause for the query

Parameters:

in_select - a select string

setFrom

public void setFrom(java.lang.String in_from)

Sets the from clause for the query. The parameter should be one of the public statics k_queryFromEvent or k_queryFromTodo.

Parameters:

in_from - the from string

setWhere

public void setWhere(java.lang.String in_where)

Sets the where clause for the query. It is important to note that only very specific queries are supported. All others with cause a SOAP fault.

Parameters:

in_where - the where string

setCall

public void setCall(vCall in_call)

Assigns a vCall object to the query. This is done in place of setting a where clause string.

Parameters:

in_call - a vCall object

See Also:

vCall

setSearchHandle

public void setSearchHandle(java.lang.String in_searchHandle)

Sets the search handle. This will trigger the use of the internal search API. The first time it's called the search handle must be an empty String. After that the search handle is to be the value returned in the previous search reply.

Parameters:

in_searchHandle - a search handle

setXLimitAttendees

public void setXLimitAttendees(java.lang.String in_numAttendees)

Sets an extended property to limit the number of attendees 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. The Attendee list will always include the logged in user status. All other attendee lists can be assumed to be first come first serve, in no particular order. If the value is not set, all attendee information will be returned (limited by Web Services configuration and calendar store settings).

Parameters:

in_numAttendees - number of attendees required

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 being generated to DOM format.

Returns:

Element an XML DOM element tree