UserDataSource Class

This class is used to retrieve or update user related information.

Inheritance Hierarchy

SystemObject
  ArtDatabanken.WebService.ClientDataSourceBase
    ArtDatabanken.WebService.Client.UserServiceUserDataSourceBase
      ArtDatabanken.WebService.Client.UserServiceUserDataSource

Namespace: ArtDatabanken.WebService.Client.UserService
Assembly: ArtDatabanken.WebService.Client (in ArtDatabanken.WebService.Client.dll) Version: 1.3.0.0 (1.3.0.0)

Syntax

C++

Copy

public class UserDataSource : UserDataSourceBase, 
	IUserDataSource, IDataSource

Public Class UserDataSource
	Inherits UserDataSourceBase
	Implements IUserDataSource, IDataSource

public ref class UserDataSource : public UserDataSourceBase, 
	IUserDataSource, IDataSource

type UserDataSource =  
    class
        inherit UserDataSourceBase
        interface IUserDataSource
        interface IDataSource
    end

The UserDataSource type exposes the following members.

Constructors

	Name	Description
	UserDataSource	Create a UserDataSource instance.

Top

Methods

	Name	Description
	ActivateRoleMembership(IUserContext, Int32)	Activates the role membership of the user. In this case thes user is the user included in the client information.
	ActivateRoleMembership(IUserContext, Int32, Int32)	Administrator activates a role membership for an user.
	ActivateUserAccount	Activates user account.
	AddUserToRole	Adds user to a role
	ApplicationActionExists(IUserContext, String)	Check if application action identifier exists in users current authorities
	ApplicationActionExists(IUserContext, IRole, String)	Check if application action identifier exists in the authorities for a role
	CheckStringIsUnique	Check if a translation string is unique for this object/property and locale.
	CreateAuthority	Create new authority.
	CreateOrganization	Create new organization.
	CreateOrganizationCategory	Create new organization category.
	CreatePerson	Create new person.
	CreateRole	Create new role.
	CreateUser	Create new user.
	DeleteAuthority	Delete an authority.
	DeleteOrganization	Delete an organization.
	DeletePerson	Delete a person.
	DeleteRole	Delete a role.
	DeleteUser	Delete a user.
	GetAddressTypes	Get all address types.
	GetAgreementResponses	Get all agreement responses for specified user.
	GetAgreements	Get all agreements.
	GetApplicationUsers	Get all users of type Application
	GetAuthorities(IUserContext, IRole, IApplication)	Get all authorities within a role that is connected to specified application.
	GetAuthorities(IUserContext, Int32, Int32)	Get all authorities for a user and authority is connected to specified application
	GetAuthorities(IUserContext, IRole, Int32, String)	Get all authorities within a role that is connected to specified application and having specified authority identifier.
	GetAuthoritiesBySearchCriteria	Get roles that matches the search criteria.
	GetAuthority(IUserContext, WebAuthority)	Get Authority from WebAuthority.
	GetAuthority(IUserContext, Int32)	Get authority by id.
	GetAuthorityDataTypes	Get authority data types list.
	GetAuthorityDataTypesByApplicationId	Get authority data types list for specific application.
	GetLockedUserInformation	Get information about users that are currently locked out from ArtDatabankenSOA. Users are locked out if the fail to login a couple of times. All currently locked out users are returned if parameter userSearchString is null.
	GetMessageTypes	Get all Message types.
	GetNonActivatedUsersByRole	Get all users that have been associated with a role, that have not yet activated their role membership.
	GetOrganization(IUserContext, IOrganization)	Get WebOrganization from Organization.
	GetOrganization(IUserContext, WebOrganization)	Get organization from web organization.
	GetOrganization(IUserContext, Int32)	Get organization by id.
	GetOrganizationCategories	GetOrganizationCategories
	GetOrganizationCategory(IUserContext, IOrganizationCategory)	Get WebOrganizationCategory from OrganizationCategory.
	GetOrganizationCategory(IUserContext, WebOrganizationCategory)	Get OrganizationCategory from WebOrganizationCategory.
	GetOrganizationCategory(IUserContext, Int32)	Get organization category by id.
	GetOrganizationRoles	GetOrganizationRoles
	GetOrganizations	Get all organizations
	GetOrganizationsByOrganizationCategory	Get organizations by organization category
	GetOrganizationsBySearchCriteria	Get organizations that matches the search criteria.
	GetPerson(IUserContext, IPerson)	Get web person from person.
	GetPerson(IUserContext, WebPerson)	Get person from web person.
	GetPerson(IUserContext, Int32)	Get person by id.
	GetPersonGender(IUserContext, IPersonGender)	Get web person gender from person gender.
	GetPersonGender(IUserContext, WebPersonGender)	Get person gender from web person gender.
	GetPersonGenders	Get all person genders.
	GetPersonsByModifiedDate	Get persons that have been modified or created between certain dates.
	GetPersonsBySearchCriteria	Get persons that matches the search criteria.
	GetPhoneNumberTypes	Get all phone number types.
	GetRole(IUserContext, WebRole)	Get role from web role.
	GetRole(IUserContext, Int32)	Get role by id.
	GetRoleMembersBySearchCriteria	Get rolemembers that matches the search criteria.
	GetRolesBySearchCriteria	Get roles that matches the search criteria.
	GetRolesByUserGroupAdministrationRoleId	Get all roles where its usergroup is admnistrated by a certain role.
	GetRolesByUserGroupAdministratorUserId	Get all roles where its usergroup is admnistrated by a certain user.
	GetUser(IUserContext, Int32)	Get user by id.
	GetUser(IUserContext, String)	Get user by username.
	GetUserRoles	Get list of user roles
	GetUsersByRole	Get all users that have specified role.
	GetUsersBySearchCriteria	Get users that matches the search criteria.
	IsExistingPerson	Test if a person already exists.
	IsExistingUser	Test if username already exists in the database.
	Login	Login user.
	Logout	Logout user.
	RemoveUserFromRole	Removes user from a role
	ResetPassword	Reset user's password
	SetDataSource	Set UserService as data source in the onion data model. This method must me called before SetDataSource() methods in other data sources are called.
	SupportUpdatePersonUser	Updates a user and its associated person. The function only be used by support users. Only Email and account activation can be changed when the account is inactivated.
	UpdateAgreementResponse(IUserContext, IAgreementResponse)	Update agreement response. Agreement response is created in database if it did not exist before. The agreementResponse instance is updated with latest information.
	UpdateAgreementResponse(IUserContext, IAgreementResponse, WebAgreementResponse)	Update agreement response. Agreement response is created if it did not exist before.
	UpdateAuthority	Update authority.
	UpdateOrganization	Update organization.
	UpdateOrganizationCategory	Update existing organization category.
	UpdatePassword	Update password for logged in user.
	UpdatePerson	Update person.
	UpdateRole	Update role.
	UpdateUser	Update existing user.
	UserAdminSetPassword	Updates a users password without sending the old password. Used by administrator.

Top

Events

	Name	Description
	UserLoggedInEvent	Event handling after user has logged in.
	UserLoggedOutEvent	Event handling after user has logged out.

Top

Extension Methods

	Name	Description
	CheckNotNull	Check that an argument is not null. (Defined by ObjectExtension.)
	CheckNull	Check that an argument is null. (Defined by ObjectExtension.)
	IsNotNull	Test if an object reference is not null. (Defined by ObjectExtension.)
	IsNull	Test if an object reference is null. (Defined by ObjectExtension.)

Top

Reference

ArtDatabanken.WebService.Client.UserService Namespace