uk.ac.ebi.intact.application.commons.business
Interface IntactUserI

All Known Subinterfaces:

EditUserI, IntactUserI, IntactUserIF

All Known Implementing Classes:

EditUser, IntactUser, IntactUserImpl, PredictUser

public interface IntactUserI

This interface defines methods common to all Intact WEB applications. Typically, each WEB application has its own user and that specific user must extend from this class.

Version:

$Id: IntactUserI.java,v 1.2 2003/11/13 15:09:01 skerrien Exp $

Author:

Sugath Mudali (smudali@ebi.ac.uk)

Method Summary

java.lang.String	getDatabaseName() The name of the database connected to.
java.lang.String	getUserName() Returns the Intact user.
java.util.Collection	search(java.lang.String objectType, java.lang.String searchParam, java.lang.String searchValue) This method provides a means of searching intact objects, within the constraints provided by the parameters to the method.

Method Detail

search

public java.util.Collection search(java.lang.String objectType,
                                   java.lang.String searchParam,
                                   java.lang.String searchValue)
                            throws IntactException

This method provides a means of searching intact objects, within the constraints provided by the parameters to the method.

Parameters:

objectType - the object type to be searched

searchParam - the parameter to search on (eg field)

searchValue - the search value to match with the parameter

Returns:

the results of the search (empty if no matches were found).

Throws:

IntactException - thrown if problems are encountered during the search process.

getUserName

public java.lang.String getUserName()

Returns the Intact user.

Returns:

the Intact user currently logged in. This methods could return null if there is no user associated with the current session (e.g., Editor) or for errors in retrieving user information from the database.

getDatabaseName

public java.lang.String getDatabaseName()

The name of the database connected to.

Returns:

the name of the database. Could be null for an error in getting the information from the database.