org.jasig.schedassist
Interface IDelegateCalendarAccountDao

public interface IDelegateCalendarAccountDao

Interface that defines operations for locating and searching for IDelegateCalendarAccounts.

Version:

$Id: IDelegateCalendarAccountDao.java 2599 2010-09-16 17:42:21Z npblair $

Author:

Nicholas Blair, nblair@doit.wisc.edu

Method Summary

IDelegateCalendarAccount	getDelegate(String accountName) Return the specified IDelegateCalendarAccount by name, only skip resolution of the owner ICalendarAccount.
IDelegateCalendarAccount	getDelegate(String accountName, ICalendarAccount owner) Return the specified IDelegateCalendarAccount by name if the specified ICalendarAccount argument is the designated account owner.
IDelegateCalendarAccount	getDelegate(String attributeName, String attributeValue) Return a matching IDelegateCalendarAccount with the specified attributeName equal to the specified attributeValue.
IDelegateCalendarAccount	getDelegateByUniqueId(String accountUniqueId) Return the specified IDelegateCalendarAccount by calendar system unique id, only skip resolution of the owner ICalendarAccount.
IDelegateCalendarAccount	getDelegateByUniqueId(String accountUniqueId, ICalendarAccount owner) Return the specified IDelegateCalendarAccount by unique id if the specified ICalendarAccount argument is the designated account owner.
List<IDelegateCalendarAccount>	searchForDelegates(String searchText) Return a List of IDelegateCalendarAccount that correspond to the searchText argument.
List<IDelegateCalendarAccount>	searchForDelegates(String searchText, ICalendarAccount owner) Return a List of IDelegateCalendarAccount that correspond to the searchText argument and are assigned to the ICalendarAccount owner argument.

Method Detail

searchForDelegates

List<IDelegateCalendarAccount> searchForDelegates(String searchText,
                                                  ICalendarAccount owner)

Return a List of IDelegateCalendarAccount that correspond to the searchText argument and are assigned to the ICalendarAccount owner argument. Implementations of this method must never return null; return an empty list if no matches can be found.

Parameters:

searchText -

owner -

Returns:

a never null, but possibly empty List of matching IDelegateCalendarAccounts.

See Also:

searchForDelegates(String)

searchForDelegates

List<IDelegateCalendarAccount> searchForDelegates(String searchText)

Return a List of IDelegateCalendarAccount that correspond to the searchText argument. Implementations may decide internally which account attributes are used to map searchText. searchText will contain the asterisk ('*') character to serve as a wildcard. Implementations of this method must never return null; return an empty list if no matches can be found.

Parameters:

searchText -

Returns:

a never null, but possibly empty List of matching IDelegateCalendarAccounts.

getDelegate

IDelegateCalendarAccount getDelegate(String accountName)

Return the specified IDelegateCalendarAccount by name, only skip resolution of the owner ICalendarAccount.

Parameters:

accountName -

Returns:

the named IDelegateCalendarAccount, only without its ICalendarAccount owner

getDelegate

IDelegateCalendarAccount getDelegate(String accountName,
                                     ICalendarAccount owner)

Return the specified IDelegateCalendarAccount by name if the specified ICalendarAccount argument is the designated account owner.

Parameters:

accountName -

owner -

Returns:

the IDelegateCalendarAccount, or null if not found

getDelegate

IDelegateCalendarAccount getDelegate(String attributeName,
                                     String attributeValue)

Return a matching IDelegateCalendarAccount with the specified attributeName equal to the specified attributeValue.

Parameters:

attributeName - the name of the attribute to use in the lookup

attributeValue - the value of the attribute to use in the lookup

Returns:

the IDelegateCalendarAccount, or null if not found

getDelegateByUniqueId

IDelegateCalendarAccount getDelegateByUniqueId(String accountUniqueId)

Return the specified IDelegateCalendarAccount by calendar system unique id, only skip resolution of the owner ICalendarAccount.

Parameters:

accountUniqueId -

Returns:

the corresponding IDelegateCalendarAccount, only without its ICalendarAccount owner

getDelegateByUniqueId

IDelegateCalendarAccount getDelegateByUniqueId(String accountUniqueId,
                                               ICalendarAccount owner)

Return the specified IDelegateCalendarAccount by unique id if the specified ICalendarAccount argument is the designated account owner.

Parameters:

accountUniqueId -

owner -

Returns:

the IDelegateCalendarAccount, or null if not found