Write Two-Part Checkin of Vcfile and Vcfolder

To write a client that performs a two-part checkin of a vcfile or vcfolder, use the doIt() method of the HttpVcCheckinStart and HttpCheckinEnd classes at the appropriate times as indicated in the sequence diagram.

The class com.matrixone.fcs.http.HttpVcCheckinStart is derived from the parent class com.matrixone.fcs.mcs.CheckinStart. There is no derived class required for com.matrixone.fcs.http.HttpCheckinEnd; use it as done for FCS checkin for captured stores as described in File Collaboration Server Guide : File Checkins.

The HttpVcCheckinStart.doIt() method is shown below.

public static TicketWrapper doIt(
                       Context ctx,
                       java.lang.String processingPage,
                       java.lang.String targetPage,
                       java.lang.String errorPage,
                       java.lang.String[] boids,
                       long[] vcIndexList,
                       java.lang.String[] comments,
                       java.lang.String[] unlock,
                       javax.servlet.http.HttpServletRequest req,
                       javax.servlet.http.HttpServletResponse res)
                          throws MatrixException

The arguments are:

Argument Description

Ctx

The ENOVIA context.

processingPage

The page to use for the checkin end. This is the page where the checkin.end() is called from. This page should perform any user processing. Users' parameters will be available on this page.

targetPage

The final destination page.

errorPage

The error page.

boids

An array of business object ids for the business objects whose associated files or folders are being checked in.

vcIndexList

An array of vcconnection indexes for the files and folders being checked in.

comments

An array of comments, one for each of the vcfiles or vcfolders being checked in.

unlock

An array of flags that indicates whether the files in the DesignSync server are to be unlocked on checkin.

req

An Http request which must have a matching params of boid, vcIndex, comment, and unlock. If the param counts do not match, an error is thrown.

res

Http Servlet response