|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectca.bc.gov.webade.WebADEDatabaseDatastore
| Field Summary |
| Fields inherited from interface ca.bc.gov.webade.WebADEDatastore |
ID_BUSINESS_PARTNER_TYPE, ID_CITIZEN_TYPE, ID_GOVERNMENT_TYPE |
| Constructor Summary | |
WebADEDatabaseDatastore()
Default Constructor. |
|
| Method Summary | |
UserSearchQuery |
createUserSearchQuery(UserTypeCode userType)
Returns the UserSearchQuery metadata object to perform user searching for this application on the provided user type. |
java.util.List |
findGroups(GroupSearchObject searchObject)
Finds the set of Group objects that match the provided search criteria. |
java.util.List |
findUsers(UserSearchObject searchObject)
Finds the set of User objects that match the provided search criteria. |
WebADEUserInfo[] |
findUsers(UserSearchQuery searchQuery)
Finds the set of WebADEUserInfo objects that match the provided search criteria. |
WebADEUserInfo[] |
findWebADEUsers(UserSearchObject searchObject)
Finds the set of WebADEUserInfo objects that match the provided search criteria. |
Action[] |
getApplicationActions()
Returns the set of actions defined for the given application code, regardless of role assignment. |
java.lang.String |
getApplicationCode()
Returns the current application code set for the WebADE datastore. |
Preferences |
getApplicationPreferences()
Returns the application preferences defined for the current WebADE application. |
Role[] |
getApplicationRoles()
Returns the set of roles for the given application code. |
UserCredentials[] |
getAuthorizedUsers(Role role,
Organization organization,
boolean ignoreIndeterminateAuthorizationsErrors)
Loads all users from the datastore that are members the given roles via an authorization associated with the given organization. |
ADEConnectionProxy |
getConnectionProxy()
Returns the ADEConnectionProxy used to connect to the datastore. |
java.lang.String |
getDatastoreEnvironment()
Returns the environment code value for the datastore (DEV, TEST, or PROD). |
ElectronicAgreement |
getElectronicAgreement(java.lang.String agreementName)
Returns the target agreement, based on the given agreement name. |
Preferences |
getGlobalPreferences()
Returns the global preferences defined for all of WebADE. |
Group |
getGroupByGUID(java.lang.String guid)
Returns the group identified by the given guid. |
java.util.List |
getGroupSearchMetadata()
Returns a List of GroupSearchObject metadata objects for all configured directories for this application. |
java.lang.String |
getJavaEnvironment()
Returns the environment code value for the Java API (DEV, TEST, or PROD). |
java.util.Properties |
getPooledResourceProperties(java.lang.String roleName)
Retrieves the set of configuration properties for a pooled resource. |
WebADEUserPermissions |
getPublicWebADEPermissions()
Returns the public permissions from the datastore. |
java.lang.String |
getSourceDirectoryForUserType(UserTypeCode userType)
Returns the source directory for the given user type if it is supported by this provider. |
java.lang.String[] |
getSupportedSourceDirectories()
|
UserTypeCode[] |
getSupportedUserTypes()
|
User |
getUserByEUserId(long euserId)
Deprecated. |
User |
getUserByGUID(java.lang.String guid)
Returns the user identified by the given guid. |
User |
getUserById(java.lang.String userId)
Returns the user identified by the given userid. |
Organization |
getUserDefaultOrganization(User user)
Gets the user's default organization. |
Organization |
getUserDefaultOrganization(UserCredentials userCredentials)
Gets the user's default organization. |
Preferences |
getUserPreferences(long euserId)
Returns the user preferences for the given EUser id. |
Preferences |
getUserPreferences(UserCredentials userCredentials)
Returns the set of user preferences for this user and this application. |
User[] |
getUsersByOrganization(long organizationId)
Returns the set of users associated with this organization. |
User[] |
getUsersByRole(java.lang.String roleName)
Returns the set of users associated with this role. |
User[] |
getUsersByRoleAndOrganization(java.lang.String roleName,
long organizationId)
Returns the set of users associated with the given role and organization. |
java.util.List |
getUserSearchMetadata()
Returns a List of UserSearchObject metadata objects for all configured directories for this application. |
UserTypeCode |
getUserTypeForSourceDirectory(java.lang.String sourceDirectory)
Returns the user type for the given source directory if it is supported by this provider. |
WebADEPreferences |
getWebADEApplicationPreferences()
Returns the application preferences defined for the current WebADE application. |
WebADEPreferences |
getWebADEExtensionPreferences()
Returns the application's WebADE extensions preferences defined for the current WebADE application. |
WebADEPreferences |
getWebADEGlobalPreferences()
Returns the global preferences defined for all of WebADE. |
WebADEUserInfo |
getWebADEUserInfo(UserCredentials givenCredentials)
Loads the target user's personal information from the datastore, or returns null if the user is not found. |
WebADEUserInfo |
getWebADEUserInfo(UserCredentials givenCredentials,
boolean ignoreSessionCache)
Loads the target user's personal information from the datastore, or returns null if the user is not found. |
WebADEUserPermissions |
getWebADEUserPermissions(UserCredentials givenCredentials)
Loads the target user's permissions from the datastore, or returns null if the user is not found. |
WebADEUserPermissions |
getWebADEUserPermissions(UserCredentials givenCredentials,
boolean ignoreSessionCache)
Loads the target user's permissions from the datastore, or returns null if the user is not found. |
WebADEPreferences |
getWebADEUserPreferences(UserCredentials userCredentials)
Returns the set of user preferences for this user and this application. |
boolean |
handlesSourceDirectory(java.lang.String sourceDirectory)
Returns true if the given sourceDirectory is one of the ones supported by this provider. |
boolean |
handlesUserType(UserTypeCode userType)
Returns true if the given user type is one of the ones supported by this provider. |
boolean |
hasIndeterminateAuthorizations(Role role,
Organization organization)
Checks to see if a call to getUsersByRole() will throw a IndeterminateAuthorizationsException for the given role and organization. |
boolean |
hasUserAcceptedAgreement(UserCredentials userCredentials,
java.lang.String agreementName)
Returns a flag indicating whether the user has previously agreed to the given agreement. |
boolean |
hasUserAcceptedAgreement(User user,
java.lang.String agreementName)
Returns a flag indicating whether the user has previously agreed to the given agreement. |
void |
init(java.lang.String appCode,
ADEConnectionProxy proxy)
Initializes the datastore with an externally provided connection proxy to the WebADE database. |
boolean |
isApplicationEnabled()
Checks the enabled flag for the application. |
GUID[] |
isUserInGroups(UserCredentials userCredentials,
GUID[] groupGuids)
Checks to see if the user is a member of the groups identified by the given array of GUID values. |
java.lang.String[] |
isUserInGroups(User user,
java.lang.String[] groupGuids)
Checks to see if the user is a member of the groups identified by the given array of GUID values. |
ApplicationConfig |
loadApplicationConfig()
Takes the given application code and retrieves the configuration settings, roles, actions, and pooled resource settings. |
void |
loadExtension(java.lang.String extensionName,
Application app)
Loads the given Extension by loading the extensions preferences, loads an instance of the extension class, using the given class loader, and initializing the extension using the loaded preferences. |
WebADEPreferences |
saveWebADEUserPreferences(UserCredentials userCredentials,
WebADEPreferences preferences)
Saves the given user preferences for this user and this application. |
void |
setApplicationCode(java.lang.String appCode)
Sets the current application code set for the WebADE datastore. |
void |
setApplicationEnabled(boolean enabled)
Sets the application's enabled flag to the given value. |
void |
setUserAcceptedAgreement(UserCredentials userCredentials,
java.lang.String agreementName,
boolean agreeFlag)
Sets the user's "accepted" flag on the given agreement to the given flag value. |
void |
setUserAcceptedAgreement(User user,
java.lang.String agreementName,
boolean agreeFlag)
Sets the user's "accepted" flag on the given agreement to the given flag value. |
void |
setUserDefaultOrganization(UserCredentials userCredentials,
Organization organization)
Sets the user's default organization to the given organization. |
void |
setUserDefaultOrganization(User user,
Organization organization)
Sets the user's default organization to the given organization. |
void |
shutdown()
Shuts down the datastore. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface ca.bc.gov.webade.WebADEDatastore |
findOrganizations, getOrganizationSearchMetadata, loadOrganization |
| Constructor Detail |
public WebADEDatabaseDatastore()
| Method Detail |
public final void init(java.lang.String appCode,
ADEConnectionProxy proxy)
throws WebADEException
appCode - The code of the application this datastore is associated with.proxy - The externally-provided connection proxy.
WebADEException - Thrown if the application code value is not valid.
public final void setApplicationCode(java.lang.String appCode)
throws WebADEException
WebADEDatastore
setApplicationCode in interface WebADEDatastoreappCode - The application code value.
WebADEException - Thrown if the appCode value is null or empty string.WebADEDatastore.setApplicationCode(java.lang.String)public final java.lang.String getApplicationCode()
WebADEDatastore
getApplicationCode in interface WebADEDatastoreWebADEDatastore.getApplicationCode()
public final Preferences getGlobalPreferences()
throws WebADEException
WebADEDatastore
getGlobalPreferences in interface WebADEDatastoreWebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.getGlobalPreferences()
public WebADEPreferences getWebADEGlobalPreferences()
throws WebADEException
WebADEDatastore
getWebADEGlobalPreferences in interface WebADEDatastoreWebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.getWebADEGlobalPreferences()
public final Preferences getApplicationPreferences()
throws WebADEException
WebADEDatastore
getApplicationPreferences in interface WebADEDatastoreWebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.getApplicationPreferences()
public WebADEPreferences getWebADEApplicationPreferences()
throws WebADEException
WebADEDatastore
getWebADEApplicationPreferences in interface WebADEDatastoreWebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.getWebADEApplicationPreferences()
public final WebADEPreferences getWebADEExtensionPreferences()
throws WebADEException
WebADEDatastore
getWebADEExtensionPreferences in interface WebADEDatastoreWebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.getWebADEExtensionPreferences()
public final Preferences getUserPreferences(UserCredentials userCredentials)
throws WebADEException
WebADEDatastore
getUserPreferences in interface WebADEDatastoreuserCredentials - The user's identifying credentials.
WebADEException - Thrown when a WebADE error occurs.WebADEDatastore.getUserPreferences(ca.bc.gov.webade.user.UserCredentials)
public WebADEPreferences getWebADEUserPreferences(UserCredentials userCredentials)
throws WebADEException
WebADEDatastore
getWebADEUserPreferences in interface WebADEDatastoreuserCredentials - The user's identifying credentials.
WebADEException - Thrown when a WebADE error occurs.WebADEDatastore.getWebADEUserPreferences(ca.bc.gov.webade.user.UserCredentials)
public WebADEPreferences saveWebADEUserPreferences(UserCredentials userCredentials,
WebADEPreferences preferences)
throws WebADEException
WebADEDatastore
saveWebADEUserPreferences in interface WebADEDatastoreuserCredentials - The user's identifying credentials.preferences - The user's User preferences.
WebADEException - Thrown when a WebADE error occurs.WebADEDatastore.saveWebADEUserPreferences(ca.bc.gov.webade.user.UserCredentials,
ca.bc.gov.webade.preferences.WebADEPreferences)public final java.lang.String getJavaEnvironment()
WebADEDatastore
getJavaEnvironment in interface WebADEDatastoreWebADEDatastore.getJavaEnvironment()
public final java.lang.String getDatastoreEnvironment()
throws WebADEException
WebADEDatastore
getDatastoreEnvironment in interface WebADEDatastoreWebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.getDatastoreEnvironment()
public final ApplicationConfig loadApplicationConfig()
throws WebADEException
WebADEDatastore
loadApplicationConfig in interface WebADEDatastoreWebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.loadApplicationConfig()
public final void loadExtension(java.lang.String extensionName,
Application app)
throws WebADEException,
WebADEExtensionException
WebADEDatastore
loadExtension in interface WebADEDatastoreextensionName - The unique code of the extension.app - The application owner to register the extension to.
WebADEExtensionException - Thrown when an error occurs while trying to initialize the
extension.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.loadExtension(java.lang.String,
ca.bc.gov.webade.Application)
public final boolean isApplicationEnabled()
throws WebADEException
WebADEDatastore
isApplicationEnabled in interface WebADEDatastoreWebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.isApplicationEnabled()
public final void setApplicationEnabled(boolean enabled)
throws WebADEException
WebADEDatastore
setApplicationEnabled in interface WebADEDatastoreenabled - Enabled flag.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.setApplicationEnabled(boolean)
public final Role[] getApplicationRoles()
throws WebADEException
WebADEDatastore
getApplicationRoles in interface WebADEDatastoreWebADEExceptionWebADEDatastore.getApplicationRoles()
public final java.util.Properties getPooledResourceProperties(java.lang.String roleName)
throws WebADEException
WebADEDatastore
getPooledResourceProperties in interface WebADEDatastoreroleName - The role that the resource is assigned to.
WebADEExceptionWebADEDatastore.getPooledResourceProperties(java.lang.String)
public final Action[] getApplicationActions()
throws WebADEException
WebADEDatastore
getApplicationActions in interface WebADEDatastoreWebADEExceptionWebADEDatastore.getApplicationActions()
public UserSearchQuery createUserSearchQuery(UserTypeCode userType)
throws WebADEException
WebADEDatastore
createUserSearchQuery in interface WebADEDatastoreuserType - The user type to perform searching for.
WebADEException - Thrown when an error occurs while trying to create the search
query from the user provider for the given user type.WebADEDatastore.createUserSearchQuery(ca.bc.gov.webade.user.UserTypeCode)
public WebADEUserInfo[] findUsers(UserSearchQuery searchQuery)
throws WebADEException
WebADEDatastore
findUsers in interface WebADEDatastoresearchQuery - The search query.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.findUsers(ca.bc.gov.webade.user.search.UserSearchQuery)public final java.util.List getUserSearchMetadata()
WebADEDatastore
getUserSearchMetadata in interface WebADEDatastoreWebADEDatastore.getUserSearchMetadata()
public final WebADEUserInfo[] findWebADEUsers(UserSearchObject searchObject)
throws WebADEException
WebADEDatastore
findWebADEUsers in interface WebADEDatastoresearchObject - The search object.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.findWebADEUsers(ca.bc.gov.webade.UserSearchObject)
public final boolean hasUserAcceptedAgreement(UserCredentials userCredentials,
java.lang.String agreementName)
throws WebADEException
WebADEDatastore
hasUserAcceptedAgreement in interface WebADEDatastoreuserCredentials - The user's credentials.agreementName - The unique name of the target agreement.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.hasUserAcceptedAgreement(ca.bc.gov.webade.user.UserCredentials,
java.lang.String)
public final void setUserAcceptedAgreement(UserCredentials userCredentials,
java.lang.String agreementName,
boolean agreeFlag)
throws WebADEException
WebADEDatastore
setUserAcceptedAgreement in interface WebADEDatastoreuserCredentials - The user's credentials.agreementName - The unique name of the target agreement.agreeFlag - A flag indicating whether the user accepts or refuses the
given agreement.
WebADEException - Thrown when an error occurs while trying to save the flag to
the datastore.WebADEDatastore.setUserAcceptedAgreement(ca.bc.gov.webade.user.UserCredentials,
java.lang.String, boolean)
public final GUID[] isUserInGroups(UserCredentials userCredentials,
GUID[] groupGuids)
throws WebADEException
WebADEDatastore
isUserInGroups in interface WebADEDatastoreuserCredentials - The user's credentials.groupGuids - The unique GUID values of the target groups.
WebADEException - Thrown if an error occurs while processing the request.WebADEDatastore.isUserInGroups(ca.bc.gov.webade.user.UserCredentials,
ca.bc.gov.webade.user.GUID[])
public final WebADEUserPermissions getPublicWebADEPermissions()
throws WebADEException
WebADEDatastore
getPublicWebADEPermissions in interface WebADEDatastoreWebADEExceptionWebADEDatastore.getPublicWebADEPermissions()
public final Organization getUserDefaultOrganization(UserCredentials userCredentials)
throws WebADEException
WebADEDatastore
getUserDefaultOrganization in interface WebADEDatastoreuserCredentials - The credentials of the user to load.
WebADEException - Thrown if an error occurs while getting the default
organization.WebADEDatastore.getUserDefaultOrganization(ca.bc.gov.webade.user.UserCredentials)
public final void setUserDefaultOrganization(UserCredentials userCredentials,
Organization organization)
throws WebADEException
WebADEDatastore
setUserDefaultOrganization in interface WebADEDatastoreuserCredentials - The credentials of the user to load.organization - The selected organization.
WebADEException - Thrown if an error occurs while setting the default
organization.WebADEDatastore.setUserDefaultOrganization(ca.bc.gov.webade.user.UserCredentials,
ca.bc.gov.webade.Organization)
public final WebADEUserPermissions getWebADEUserPermissions(UserCredentials givenCredentials)
throws WebADEException
WebADEDatastore
getWebADEUserPermissions in interface WebADEDatastoregivenCredentials - The user's identifying credentials.
WebADEExceptionWebADEDatastore.getWebADEUserPermissions(ca.bc.gov.webade.user.UserCredentials)
public WebADEUserPermissions getWebADEUserPermissions(UserCredentials givenCredentials,
boolean ignoreSessionCache)
throws WebADEException
WebADEDatastore
getWebADEUserPermissions in interface WebADEDatastoregivenCredentials - The user's identifying credentials.ignoreSessionCache - A flag indicating whether to ignore the session user permissions
object, should it match the given user credentials.
WebADEExceptionWebADEDatastore.getWebADEUserPermissions(ca.bc.gov.webade.user.UserCredentials, boolean)
public final WebADEUserInfo getWebADEUserInfo(UserCredentials givenCredentials)
throws WebADEException
WebADEDatastore
getWebADEUserInfo in interface WebADEDatastoregivenCredentials - The user's identifying credentials.
WebADEExceptionWebADEDatastore.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials)
public final WebADEUserInfo getWebADEUserInfo(UserCredentials givenCredentials,
boolean ignoreSessionCache)
throws WebADEException
WebADEDatastore
getWebADEUserInfo in interface WebADEDatastoregivenCredentials - The user's identifying credentials.ignoreSessionCache - A flag indicating whether to ignore the session user info
object, should it match the given user credentials.
WebADEExceptionWebADEDatastore.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials, boolean)
public final ElectronicAgreement getElectronicAgreement(java.lang.String agreementName)
throws WebADEException
WebADEDatastore
getElectronicAgreement in interface WebADEDatastoreagreementName - The name of the target agreement.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.getElectronicAgreement(java.lang.String)public final ADEConnectionProxy getConnectionProxy()
public boolean hasIndeterminateAuthorizations(Role role,
Organization organization)
throws WebADEException
WebADEDatastore
hasIndeterminateAuthorizations in interface WebADEDatastorerole - The WebADE role in this application (optional).organization - The organization to load users of this application for
(optional).
WebADEException - Thrown if an error occurs while performing this query.WebADEDatastore.hasIndeterminateAuthorizations(ca.bc.gov.webade.Role,
ca.bc.gov.webade.Organization)
public UserCredentials[] getAuthorizedUsers(Role role,
Organization organization,
boolean ignoreIndeterminateAuthorizationsErrors)
throws IndeterminateAuthorizationsException,
WebADEException
WebADEDatastore
getAuthorizedUsers in interface WebADEDatastorerole - The role to load users for (optional).organization - The organization to load users for (optional).ignoreIndeterminateAuthorizationsErrors - If set to true, prevents the
IndeterminateAuthorizationsException from being thrown, if it
occurs.
WebADEException - Throws a base WebADEException if an error occurs while
performing this query.
IndeterminateAuthorizationsException - Throws IndeterminateAuthorizationsException if the list of
users cannot be completely loaded.WebADEDatastore.getAuthorizedUsers(ca.bc.gov.webade.Role,
ca.bc.gov.webade.Organization, boolean)
public boolean handlesSourceDirectory(java.lang.String sourceDirectory)
throws WebADEException
handlesSourceDirectory in interface WebADEDatastoresourceDirectory - The target sourceDirectory name.
WebADEException
public boolean handlesUserType(UserTypeCode userType)
throws WebADEException
handlesUserType in interface WebADEDatastoreuserType - The target user type.
WebADEException
public java.lang.String getSourceDirectoryForUserType(UserTypeCode userType)
throws WebADEException
getSourceDirectoryForUserType in interface WebADEDatastoreuserType - The target user type.
WebADEException
public UserTypeCode getUserTypeForSourceDirectory(java.lang.String sourceDirectory)
throws WebADEException
getUserTypeForSourceDirectory in interface WebADEDatastoresourceDirectory - The target sourceDirectory name.
WebADEException
public java.lang.String[] getSupportedSourceDirectories()
throws WebADEException
getSupportedSourceDirectories in interface WebADEDatastoreWebADEException
public UserTypeCode[] getSupportedUserTypes()
throws WebADEException
getSupportedUserTypes in interface WebADEDatastoreWebADEException
public final void shutdown()
throws java.lang.SecurityException
WebADEDatastore
shutdown in interface WebADEDatastorejava.lang.SecurityException - Thrown if an unauthorized class calls this method.WebADEDatastore.shutdown()
public java.util.List findGroups(GroupSearchObject searchObject)
throws WebADEException
WebADEDatastore
findGroups in interface WebADEDatastoresearchObject - The search object.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.findGroups(ca.bc.gov.webade.GroupSearchObject)
public java.util.List findUsers(UserSearchObject searchObject)
throws WebADEException
WebADEDatastore
findUsers in interface WebADEDatastoresearchObject - The search object.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.findUsers(ca.bc.gov.webade.UserSearchObject)
public Group getGroupByGUID(java.lang.String guid)
throws WebADEException
WebADEDatastore
getGroupByGUID in interface WebADEDatastoreguid - The unique guid identifying the group.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.getGroupByGUID(java.lang.String)public java.util.List getGroupSearchMetadata()
WebADEDatastore
getGroupSearchMetadata in interface WebADEDatastoreWebADEDatastore.getGroupSearchMetadata()
public User getUserByGUID(java.lang.String guid)
throws WebADEException
WebADEDatastore
getUserByGUID in interface WebADEDatastoreguid - The unique guid identifying the user.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.getUserByGUID(java.lang.String)
public User getUserById(java.lang.String userId)
throws WebADEException
WebADEDatastore
getUserById in interface WebADEDatastoreuserId - The full userid, including domain.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.getUserById(java.lang.String)
public User getUserByEUserId(long euserId)
throws WebADEException
euserId - The target euser database id.
WebADEException - Thrown if an error occurs while loading the user.
public Organization getUserDefaultOrganization(User user)
throws WebADEException
WebADEDatastore
getUserDefaultOrganization in interface WebADEDatastoreuser - The target user.
WebADEException - Thrown if an error occurs while getting the default
organization.WebADEDatastore.getUserDefaultOrganization(ca.bc.gov.webade.User)
public Preferences getUserPreferences(long euserId)
throws WebADEException
WebADEDatastore
getUserPreferences in interface WebADEDatastoreeuserId - The unique id of the target user.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.getUserPreferences(long)
public User[] getUsersByOrganization(long organizationId)
throws WebADEException
WebADEDatastore
getUsersByOrganization in interface WebADEDatastoreorganizationId - The target organizationId.
WebADEExceptionWebADEDatastore.getUsersByOrganization(long)
public User[] getUsersByRole(java.lang.String roleName)
throws WebADEException
WebADEDatastore
getUsersByRole in interface WebADEDatastoreroleName - The target role name.
WebADEExceptionWebADEDatastore.getUsersByRole(java.lang.String)
public User[] getUsersByRoleAndOrganization(java.lang.String roleName,
long organizationId)
throws WebADEException
WebADEDatastore
getUsersByRoleAndOrganization in interface WebADEDatastoreroleName - The target role name.organizationId - The target organizationId.
WebADEExceptionWebADEDatastore.getUsersByRoleAndOrganization(java.lang.String,
long)
public boolean hasUserAcceptedAgreement(User user,
java.lang.String agreementName)
throws WebADEException
WebADEDatastore
hasUserAcceptedAgreement in interface WebADEDatastoreuser - The user.agreementName - The unique name of the target agreement.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.WebADEDatastore.hasUserAcceptedAgreement(ca.bc.gov.webade.User,
java.lang.String)
public java.lang.String[] isUserInGroups(User user,
java.lang.String[] groupGuids)
throws WebADEException
WebADEDatastore
isUserInGroups in interface WebADEDatastoreuser - The target user object.groupGuids - The unique GUID values of the target groups.
WebADEException - Thrown if ant of the groups are not found or an error occurs
while processing the request.WebADEDatastore.isUserInGroups(ca.bc.gov.webade.User,
java.lang.String[])
public void setUserAcceptedAgreement(User user,
java.lang.String agreementName,
boolean agreeFlag)
throws WebADEException
WebADEDatastore
setUserAcceptedAgreement in interface WebADEDatastoreuser - The user.agreementName - The unique name of the target agreement.agreeFlag - A flag indicating whether the user accepts or refuses the
given agreement.
WebADEException - Thrown when an error occurs while trying to save the flag to
the datastore.WebADEDatastore.setUserAcceptedAgreement(ca.bc.gov.webade.User,
java.lang.String, boolean)
public void setUserDefaultOrganization(User user,
Organization organization)
throws WebADEException
WebADEDatastore
setUserDefaultOrganization in interface WebADEDatastoreuser - The target user.organization - The selected organization.
WebADEException - Thrown if an error occurs while setting the default
organization.WebADEDatastore.setUserDefaultOrganization(ca.bc.gov.webade.User,
ca.bc.gov.webade.Organization)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||