[This is preliminary documentation and is subject to change.]
Get the caselist information to display in the caselist screen of
the tracker for a particular user.
Namespace:
OfficeClip.DBLayer.TrackerAssembly: OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0
Syntax
C# |
---|
public DataSet GetCaseListInfo( int projectId, string sortField, string sortState, int filterValue, ArrayList searchAL, string searchStr, bool isLike, bool showNew, int currentUserId, int currentGroupId ) |
Visual Basic (Declaration) |
---|
Public Function GetCaseListInfo ( _ projectId As Integer, _ sortField As String, _ sortState As String, _ filterValue As Integer, _ searchAL As ArrayList, _ searchStr As String, _ isLike As Boolean, _ showNew As Boolean, _ currentUserId As Integer, _ currentGroupId As Integer _ ) As DataSet |
Visual C++ |
---|
public: DataSet^ GetCaseListInfo( int projectId, String^ sortField, String^ sortState, int filterValue, ArrayList^ searchAL, String^ searchStr, bool isLike, bool showNew, int currentUserId, int currentGroupId ) |
Parameters
- projectId
- Type: System..::.Int32
The database id of the Project.
- sortField
- Type: System..::.String
The field on which the sort is done.
- sortState
- Type: System..::.String
Whether ascending (ASC) or descending (DESC).
- filterValue
- Type: System..::.Int32
The filter id of the filter used in case list.
- searchAL
- Type: System.Collections..::.ArrayList
The search arraylist of all the field ids for which the search is requested, this is mostly used when a search is requested for all the parameters.
- searchStr
- Type: System..::.String
The string which needs to be searched.
- isLike
- Type: System..::.Boolean
true if the search is "Is" false if it is "Is Not"
- showNew
- Type: System..::.Boolean
Whether the new case indicator needs to be shown
- currentUserId
- Type: System..::.Int32
the id of the current user
- currentGroupId
- Type: System..::.Int32
The id of the current organization
Return Value
The dataset consisting of the following information:- filterIdThe unique id of the filter
- filterNameThe name of the filter
- caseNumThe unique number of the case
- titleThe title of the case
- DescriptionThe Description of the case (only the first 100 characters)
- CreatedDateThe created date of the case
- statusThe status of the case
- CriticalityThe Criticality of the case
- categotyThe Category of the case
- kindThe kind of the case
- CreatedByThe user id of the user who created the case
- modifiedByThe user id of the user who last modified the case
- The date when the case was last modified