oracle.ifs.beans

Class EventNotificationSelector

java.lang.Object

oracle.ifs.beans.EventNotificationSelector

public class EventNotificationSelector
extends Object

A EventNotificationSelector is used to select EventNotifications from the repository.

Author:

Oskar Wetterstein

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventNotificationSelector.DummyAuditExecutor

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ALIAS The default search alias.
protected static String	EVENT_NOTIFICATION_COLUMNS The SQL column list for selecting from the notification table.
static String	EVENT_NOTIFICATION_TABLE_NAME The notification table name.

Constructor Summary

Constructors

Constructor and Description
EventNotificationSelector(LibrarySession session) Constructs a EventNotificationSelector.

Method Summary

Modifier and Type	Method and Description
AttributeValue[]	getBindValues() Gets the bind values to use in the select statement.
String	getHint() Gets the SQL hint to use for the main select.
int	getItemCount() Returns the search result count.
int	getMaxItemCount() Returns the maximum number of items that will be returned by getItems.
EventNotification[]	getNotifications() Returns the EventNotification array that reflects the search results.
LibraryObject	getNotifyee() Sets the notifyed user to include in teh search condition.
String	getSearchCondition() Returns the search selection that was set using setSearchCondition()
LibrarySession	getSession() Returns the session being used by this Selector.
String	getSqlStatement() Gets the SQL statement that will be used.
void	setBindValues(AttributeValue[] bindValues) Sets the bind values to use in the select statement.
void	setHint(String hint) Sets the SQL hint to use for the main select.
void	setMaxItemCount(int maxItemCount) Sets the maximum number of items that will be returned by getItems.
void	setNotifyee(LibraryObject notifyee) Sets the notifyed user to include in teh search condition.
void	setSearchCondition(String searchCondition) Sets the search condition.
void	setSortClause(String sort) Sets the Sort clause.

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_NOTIFICATION_TABLE_NAME

public static final String EVENT_NOTIFICATION_TABLE_NAME

The notification table name.

See Also:

Constant Field Values

DEFAULT_ALIAS

public static final String DEFAULT_ALIAS

The default search alias.

See Also:

Constant Field Values

EVENT_NOTIFICATION_COLUMNS

protected static final String EVENT_NOTIFICATION_COLUMNS

The SQL column list for selecting from the notification table.

See Also:

Constant Field Values

Constructor Detail

EventNotificationSelector

public EventNotificationSelector(LibrarySession session)
                          throws IfsException

Constructs a EventNotificationSelector.

Parameters:

session - the current session.

Throws:

IfsException - if the operation fails.

Method Detail

getSession

public LibrarySession getSession()
                          throws IfsException

Returns the session being used by this Selector.

Returns:

the current session

Throws:

IfsException - if the operation fails.

getNotifyee

public LibraryObject getNotifyee()
                          throws IfsException

Sets the notifyed user to include in teh search condition.

Returns:

the notified user (or other object); a null indicates that previous setting should be cleared

Throws:

IfsException - if the operation fails.

getSearchCondition

public String getSearchCondition()
                          throws IfsException

Returns the search selection that was set using setSearchCondition()

Returns:

the search selection.

Throws:

IfsException - if operation fails.

getMaxItemCount

public int getMaxItemCount()
                    throws IfsException

Returns the maximum number of items that will be returned by getItems.

A value of zero indicates that there is no limit on the desired number of items.

Returns:

maximum number of items that will be returned

Throws:

IfsException - if the operation fails.

getHint

public String getHint()
               throws IfsException

Gets the SQL hint to use for the main select.

Returns:

the SQL hint

Throws:

IfsException - if the operation fails.

getBindValues

public AttributeValue[] getBindValues()
                               throws IfsException

Gets the bind values to use in the select statement.

Returns:

the bind values

Throws:

IfsException - if the operation fails.

getSqlStatement

public String getSqlStatement()
                       throws IfsException

Gets the SQL statement that will be used.

Returns:

the SQL statement

Throws:

IfsException - if the operation fails.

setNotifyee

public void setNotifyee(LibraryObject notifyee)
                 throws IfsException

Sets the notifyed user to include in teh search condition.

Parameters:

notifyee - the notified user (or other object); a null indicates that previous setting should be cleared

Throws:

IfsException - if the operation fails.

setSortClause

public void setSortClause(String sort)
                   throws IfsException

Sets the Sort clause.

Parameters:

sort - the sort clause; e.g. "notifydate desc" NOTE: keywords "order by" are added automatically (do not include them in the specified String)

Throws:

IfsException - if the operation fails.

setSearchCondition

public void setSearchCondition(String searchCondition)
                        throws IfsException

Sets the search condition.

Parameters:

searchCondition - the search selection; e.g. "notifydate > ?" NOTE: keyword "where" is added automatically (do not include it in the specified String)

Throws:

IfsException - if operation fails.

setMaxItemCount

public void setMaxItemCount(int maxItemCount)
                     throws IfsException

Sets the maximum number of items that will be returned by getItems.

A value of zero indicates that there is no limit on the desired number of items.

Parameters:

maxItemCount - maximum number of items that will be returned

Throws:

IfsException - if the operation fails.

setHint

public void setHint(String hint)
             throws IfsException

Sets the SQL hint to use for the main select.

Parameters:

hint - the SQL hint

Throws:

IfsException - if the operation fails.

setBindValues

public void setBindValues(AttributeValue[] bindValues)
                   throws IfsException

Sets the bind values to use in the select statement.

Parameters:

bindValues - the bind values

Throws:

IfsException - if the operation fails.

getNotifications

public EventNotification[] getNotifications()
                                     throws IfsException

Returns the EventNotification array that reflects the search results.

Returns:

the search results.

Throws:

IfsException - if operation fails.

getItemCount

public int getItemCount()
                 throws IfsException

Returns the search result count.

Returns:

the search result count.

Throws:

IfsException - if operation fails.