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

Archives either a particular timesheet or an expense based on the application id provided.

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

Syntax

C#
public int ArchiveItem(
	int id,
	Constants..::.ApplicationType aType,
	bool isRestore,
	int currentUserId
)
Visual Basic (Declaration)
Public Function ArchiveItem ( _
	id As Integer, _
	aType As Constants..::.ApplicationType, _
	isRestore As Boolean, _
	currentUserId As Integer _
) As Integer
Visual C++
public:
int ArchiveItem(
	int id, 
	Constants..::.ApplicationType aType, 
	bool isRestore, 
	int currentUserId
)

Parameters

id
Type: System..::.Int32
Id of a particular timesheet or expense.
aType
Type: OfficeClip.BusinessLayer.Framework..::.Constants..::.ApplicationType
The application type
isRestore
Type: System..::.Boolean
true if it is really a restore operation and not archive operation
currentUserId
Type: System..::.Int32
The unique id of the current user

Return Value

0 when successful, -1 in case of a general error, -2 when this timesheet or expense can not be archived because it is still pending in the workflow process.

See Also