[This is preliminary documentation and is subject to change.]

Gets all the inbox and outbox items for both the time and expenses.

Namespace:  OfficeClip.DBLayer.TE
Assembly:  OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0

Syntax

C#
public DataSet GetInBoxOutBoxList(
	bool allGroups,
	string inboxOutbox,
	TESortType teSortBy,
	OCSortDirection sortDir,
	bool showArchived,
	int currentGroupId,
	int currentUserId,
	Constants..::.ApplicationType aType,
	int maximumRows
)
Visual Basic (Declaration)
Public Function GetInBoxOutBoxList ( _
	allGroups As Boolean, _
	inboxOutbox As String, _
	teSortBy As TESortType, _
	sortDir As OCSortDirection, _
	showArchived As Boolean, _
	currentGroupId As Integer, _
	currentUserId As Integer, _
	aType As Constants..::.ApplicationType, _
	maximumRows As Integer _
) As DataSet
Visual C++
public:
DataSet^ GetInBoxOutBoxList(
	bool allGroups, 
	String^ inboxOutbox, 
	TESortType teSortBy, 
	OCSortDirection sortDir, 
	bool showArchived, 
	int currentGroupId, 
	int currentUserId, 
	Constants..::.ApplicationType aType, 
	int maximumRows
)

Parameters

allGroups
Type: System..::.Boolean
Flag (True/False) indicating whether items corresponding to all groups where the currently logged in user is a member of should be returned or only the currently selected group's items should be returned.
inboxOutbox
Type: System..::.String
The type of the box
teSortBy
Type: OfficeClip.Utils..::.TESortType
The field on which to sort the result. TESortType
sortDir
Type: OfficeClip.Utils..::.OCSortDirection
The Direction in which the results should be sorted. OCSortDirection
showArchived
Type: System..::.Boolean
Flag (True/False) indicating whether to show archived items or not.
currentGroupId
Type: System..::.Int32
The id of the current organization
currentUserId
Type: System..::.Int32
The unique id of the current user
aType
Type: OfficeClip.BusinessLayer.Framework..::.Constants..::.ApplicationType
The application type
maximumRows
Type: System..::.Int32

Return Value

DataSet containing all the information related inbox and outbox items for Time and Expenses. This DataSet consists of a single DataTable with the following columns.
  • itemId (System.Int32)Id of either the timesheet or the expense.
  • itemType (System.String)Flag (T/E) indicating whether the item is corresponding to a timesheet or an expense.
  • StatusId (System.Int32)Id of the Current status of the particular timesheet or expense.
  • status (System.String)Name of the status of the Current
  • isModifiable (System.String)Flag (Y/N) indicating whether a particular item (timesheet or expense) is modifiable by the currently logged in user.
  • cellBgcolor (System.String)Background color of the cell which distinguishes whether an item is a timesheet or an expense.
  • WorkflowTypeId (System.Int32)Id of the workflow type with which the particular item (timesheet or expense) was created.
  • StageId (System.Int32)Id of the stage in which the particular item is present i.e. first stage, second stage etc. (if it is a part of multi stage workflow.)
  • name (System.String)Name of the user to which this particular item belongs.
  • IsNew (System.Int32)Flag (1/0) indicating whether this particular item is newly created and the Current user is looking at it for the first time.
  • weekStarting (System.DateTime)Starting Date of the time period for which this particular item was created.
  • groupName (System.String)Name of the group for which this particular item is created.
  • totalValue (System.Decimal)Total Amount or the total number of hours for this expense or timesheet respectively.
  • applicationId (System.Int32)Id of the application for which this particular item was created.
  • isPending (System.Int32)Flag (0 or > 0) indicating whether there are other items pending related to this particular timesheet or expense in some other user's inbox.
  • Comments (System.String)Comments text of the last user who updated this particular item in the workflow.

See Also