ManageObjectsServicesManager..::..GetList Method

Gets the list result.

Namespace: ServicePRO.Sdk.Windows.Managers
Assembly: ServicePRO.Sdk.Windows (in ServicePRO.Sdk.Windows.dll)

Syntax

public void GetList(
	string sessionKey,
	string hsObject,
	string hsField,
	string hsMch,
	string strSearch,
	int LngId,
	bool bForEmail,
	int curUserCompanyId,
	bool curPrivIsRep,
	int curPriv,
	string FilterObjectType,
	int FilterObjectId,
	bool bAllocated,
	bool bWksByUserType,
	string prmObjStatus,
	bool Editable,
	string stColumns,
	string strExtraAndCondition,
	int startRow,
	int endRow,
	string whereClause,
	string orderByClause,
	Action<int, List<stcColumnAlias>, IEnumerable<Dictionary<string, Object>>, Exception> callbackAction
)

Public Sub GetList ( _
	sessionKey As String, _
	hsObject As String, _
	hsField As String, _
	hsMch As String, _
	strSearch As String, _
	LngId As Integer, _
	bForEmail As Boolean, _
	curUserCompanyId As Integer, _
	curPrivIsRep As Boolean, _
	curPriv As Integer, _
	FilterObjectType As String, _
	FilterObjectId As Integer, _
	bAllocated As Boolean, _
	bWksByUserType As Boolean, _
	prmObjStatus As String, _
	Editable As Boolean, _
	stColumns As String, _
	strExtraAndCondition As String, _
	startRow As Integer, _
	endRow As Integer, _
	whereClause As String, _
	orderByClause As String, _
	callbackAction As Action(Of Integer, List(Of stcColumnAlias), IEnumerable(Of Dictionary(Of String, Object)), Exception) _
)

Parameters

sessionKey: Type: String
User’s Session Key.
Key property of the User Session Object of type stcSession.
The User Session has to be established by making a call to InitializeSystemAndSession() method in CoreServicesManager class as a first step with using ServicePRO SDK.

hsObject: Type: String
HelpSTAR object type.(clsEnumeration.hsHelpStarObject)

hsField: Type: String
The search field.(clsEnumeration.hsObjectSearchField)

hsMch: Type: String
The match method.(clsEnumeration.hsMatch)

strSearch: Type: String
The string to search.

LngId: Type: Int32
The LNG identifier.(Default:0 hsAssetFindingView)

bForEmail: Type: Boolean
set to true if searching email.

curUserCompanyId: Type: Int32
The current user company identifier.

curPrivIsRep: Type: Boolean
set to true if current privilege is Rep.

curPriv: Type: Int32
The current privilege.

FilterObjectType: Type: String
Type of the filter object.(clsEnumeration.hsmdObject)

FilterObjectId: Type: Int32
The filter object identifier.

bAllocated: Type: Boolean
set to true if already allocated.

bWksByUserType: Type: Boolean
set to False.

prmObjStatus: Type: String
The PRM object status.(clsEnumeration.hsObjectStatus)

Editable: Type: Boolean
set to true [if editable].

stColumns: Type: String
The columns to retrieve.(e.g. "tblCompany.id as [Id], tblCompany.name as [Name]")

strExtraAndCondition: Type: String
The string extra and condition.(default:null)

startRow: Type: Int32
The start row in SQL table.

endRow: Type: Int32
The end row in SQL table.

whereClause: Type: String
The where clause in query string.(Default is empty)

orderByClause: Type: String
The order by clause in query string.(Default is empty)

callbackAction: Type: Action<(Of <(<'Int32, List<(Of <(<'stcColumnAlias>)>)>, IEnumerable<(Of <(<'Dictionary<(Of <(<'String, Object>)>)>>)>)>, Exception>)>)>
The callback action.(MethodName(int:TotalNumberOfReturn, List<stcColumnAlias>, IEnumerable<Dictionary<string, object>>, Exception))

ManageObjectsServicesManager..::..GetList Method

Syntax

Parameters

See Also