@AccessLevel(value=EXTERNAL) public class UserAccess extends UserAccess
The UserAccess API facilitates the creation, modification and retrieval of internal and external users. It also provides the following generic facilities for internal and external users:
7
All access to external users should be done through this API. Hiding the out-of-the-box external user implementation behind the UserAccess API facilitates custom solutions overriding the necessary functions and providing their own external user implementation.
Modifier and Type | Field and Description |
---|---|
protected NoteFilterHook |
noteFilterHook |
protected static curam.core.struct.SystemUserDtls |
stSystemUserDtls |
Constructor and Description |
---|
UserAccess()
Default constructor for the class.
|
Modifier and Type | Method and Description |
---|---|
curam.core.struct.UserFullname |
getFullName(curam.core.struct.UsersKey key)
Retrieves the full name for a given user.
|
curam.core.struct.SystemUserDtls |
getUserDetails()
Returns the user details for the current program user, or the system user
if there is no current user.
|
curam.core.struct.UserDetails |
getUserDetails(curam.core.struct.UsersKey key)
Retrieves the details for a user.
|
protected java.lang.String |
getUserFullNameWithTitle(java.lang.String titleCode,
java.lang.String firstForename,
java.lang.String otherForename,
java.lang.String surname) |
curam.core.struct.UsersDtls |
readUserDetails(curam.core.struct.UsersKey userKey)
Reads user detail for the specified user.
|
curam.core.struct.UserFullname |
readUserFullName(curam.core.struct.UsersKey usersKey)
Reads user full name for specified user.
|
curam.core.struct.UserLocationDetails |
readUserLocation(curam.core.struct.UsersKey usersKey)
Reads user location details for specified user.
|
curam.core.struct.UserRoleDetails |
readUserRole(curam.core.struct.UsersKey usersKey)
Reads user role details for specified user.
|
cancelExternalUser, cancelInternalUser, checkForDuplicateUsername, countActivityForExternalWorkqueueSubscribers, countActivityForInternalWorkqueueSubscribers, readActivityExternalOwnerDetails, readActivityInternalOwnerDetails, searchExternalApprovalRequests, searchExternalSubscriptionsByWorkQueueID, searchExternalUserSubscriptionsByWorkQueueID, searchExternalUserTasksByDueDate, searchExternalUserTasksByDueDate, searchExternalUserTasksDueInTheNextWeek, searchExternalUserTasksDueInTheNextWeek, searchInternalApprovalRequests, searchInternalSubscriptionsByWorkQueueID, searchInternalUserTasksByDueDate, searchInternalUserTasksByDueDate, searchInternalUserTasksDueInTheNextWeek, searchInternalUserTasksDueInTheNextWeek, validateExternalUserDetails, validateUserPassword
protected static curam.core.struct.SystemUserDtls stSystemUserDtls
@Inject protected NoteFilterHook noteFilterHook
@AccessLevel(value=EXTERNAL) public curam.core.struct.UserFullname getFullName(curam.core.struct.UsersKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- Contains the user whose full name is being retrieved.curam.util.exception.AppException
curam.util.exception.InformationalException
protected java.lang.String getUserFullNameWithTitle(java.lang.String titleCode, java.lang.String firstForename, java.lang.String otherForename, java.lang.String surname)
@AccessLevel(value=EXTERNAL) public curam.core.struct.UserDetails getUserDetails(curam.core.struct.UsersKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- Users entity keycuram.util.exception.AppException
curam.util.exception.InformationalException
@AccessLevel(value=EXTERNAL) public curam.core.struct.SystemUserDtls getUserDetails() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
@AccessLevel(value=EXTERNAL) public curam.core.struct.UsersDtls readUserDetails(curam.core.struct.UsersKey userKey) throws curam.util.exception.AppException, curam.util.exception.InformationalException
usersKey
- User Key information.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.@AccessLevel(value=EXTERNAL) public curam.core.struct.UserFullname readUserFullName(curam.core.struct.UsersKey usersKey) throws curam.util.exception.AppException, curam.util.exception.InformationalException
usersKey
- User Key information.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.@AccessLevel(value=EXTERNAL) public curam.core.struct.UserLocationDetails readUserLocation(curam.core.struct.UsersKey usersKey) throws curam.util.exception.AppException, curam.util.exception.InformationalException
usersKey
- User Key information.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.@AccessLevel(value=EXTERNAL) public curam.core.struct.UserRoleDetails readUserRole(curam.core.struct.UsersKey usersKey) throws curam.util.exception.AppException, curam.util.exception.InformationalException
usersKey
- User Key information.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.