Interface IStaffService
Namespace: Cmc.Nexus.Common.Services
Assembly: Cmc.Nexus.Common.Contracts.dll
Syntax
public interface IStaffService : IEntityService<StaffEntity>, IServiceMethods
AuthenticateUserLogin(AuthenticationRequest)
This method is used to authenticate user login screen
Declaration
AuthenticationResponse AuthenticateUserLogin(AuthenticationRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| Cmc.Core.Security.UserAccount.AuthenticationRequest | request |
Returns
| Type | Description |
|---|---|
| Cmc.Core.Security.UserAccount.AuthenticationResponse |
ClearUserCache(Int32)
Clear Staff cache items
Declaration
void ClearUserCache(int userId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | userId |
Get(String)
Gets the specified staff by code.
Declaration
StaffEntity Get(string code)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | code | The staff code. |
Returns
| Type | Description |
|---|---|
| StaffEntity | Staff Entity |
GetCurrentUser()
Gets the Staff entity for the current user
Declaration
StaffEntity GetCurrentUser()Returns
| Type | Description |
|---|---|
| StaffEntity | Staff entity |
GetCurrentUserCampuses()
Gets the list of campuses for the current user
Declaration
IEnumerable<int> GetCurrentUserCampuses()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.Int32> | list of campus Ids |
GetStaffByEmployeeNumber(String)
Get Staff Entity by Employee Number (This operation will not be exposed externally meant for internal use only)
Declaration
StaffEntity GetStaffByEmployeeNumber(string employeeNumber)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | employeeNumber |
Returns
| Type | Description |
|---|---|
| StaffEntity |
LookupCrmUserAccount(LookupUserAccountRequest)
This method is used to lookup user account in campus nexus crm environment to find duplicate staff that are existing already.
Declaration
LookupUserAccountResponse LookupCrmUserAccount(LookupUserAccountRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| Cmc.Core.Security.UserAccount.LookupUserAccountRequest | request |
Returns
| Type | Description |
|---|---|
| Cmc.Core.Security.UserAccount.LookupUserAccountResponse |
PublishStaffGroupMembershipChangeEvent(StaffEntity, ICollection<Int32>)
PublishStaffGroupMembershipChangeEvent (This operation will not be exposed externally meant for internal use only)
Declaration
void PublishStaffGroupMembershipChangeEvent(StaffEntity entity, ICollection<int> existingStaffGroupMembershipList)Parameters
| Type | Name | Description |
|---|---|---|
| StaffEntity | entity | StaffEntity |
| System.Collections.Generic.ICollection<System.Int32> | existingStaffGroupMembershipList | Collection of existing Staff groups associated with staff |
SaveSearchProperties(SaveSearchPropertiesRequest)
Sets the SearchResult/Properties for the global search to Staff.
Declaration
SaveSearchPropertiesResponse SaveSearchProperties(SaveSearchPropertiesRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| SaveSearchPropertiesRequest | request | SaveSearchPropertiesRequest |
Returns
| Type | Description |
|---|---|
| SaveSearchPropertiesResponse | SaveSearchPropertiesResponse |
SaveStaffPassword(SaveStaffPasswordRequest)
This method is used to update the password of staffs
Declaration
SaveStaffPasswordResponse SaveStaffPassword(SaveStaffPasswordRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| SaveStaffPasswordRequest | request |
Returns
| Type | Description |
|---|---|
| SaveStaffPasswordResponse |
SaveStaffPolicies(SaveStaffPoliciesRequest)
Sets the Document/Task Policies to Staff.
Declaration
SaveStaffPoliciesResponse SaveStaffPolicies(SaveStaffPoliciesRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| SaveStaffPoliciesRequest | request | SaveStaffPolicies |
Returns
| Type | Description |
|---|---|
| SaveStaffPoliciesResponse | SaveStaffPoliciesResponse |
SetDefaultSetting(SetDefaultSettingRequest)
Sets the default settings for the staff user.
Declaration
SetDefaultSettingResponse SetDefaultSetting(SetDefaultSettingRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| SetDefaultSettingRequest | request | The default settings. |
Returns
| Type | Description |
|---|---|
| SetDefaultSettingResponse | SetDefaultSettingResponse |