com.ptc.windchill.uwgm.proesrv.request
Class CheckinRequest

java.lang.Object
  com.ptc.windchill.uwgm.proesrv.ProeServiceRequest
      com.ptc.windchill.uwgm.proesrv.request.CheckinRequest

All Implemented Interfaces:

RequestResultCache.Populator

public class CheckinRequest

extends ProeServiceRequest

Checkin UWGM Request implementation Checkin request is not transactional, but rather multi-transactional. Thus transaction handling is inside of execute

Field Summary

private WTValuedMap	docMasterToPartMasterMap
private static Log	log logging
private CheckinRequestCache	requestCache

Fields inherited from class com.ptc.windchill.uwgm.proesrv.ProeServiceRequest

context, RESOURCE, resultPopulator, uwgmRequest

Constructor Summary

CheckinRequest(com.ptc.windchill.uwgm.soap.uwgmsvc.Checkin checkin, RequestResultCache resultCache)

Method Summary

private WTCollection	addAssocPartMasters(WTCollection masters) Adds the masters of WTParts associated with the documents whose masters appear in the input WTCollection of masters using docMasterToPartMasterMap.
private WTCollection	createWTParts(EPMWorkspace epmWorkspace, WTCollection epmDocuments) creates associated WTParts for epmDocuments to checkin
private WTCollection	doCheckin(com.ptc.windchill.uwgm.soap.uwgmsvc.Checkin uwgmCheckinRequest) internal checkin
private void	doCheckout(WTCollection masters, WTCollection checkins) performs "post-checkin" operation - KeepCheckout
private void	doRemove(WTCollection masters, WTCollection checkins)
com.ptc.windchill.uwgm.soap.uwgm.UwgmMessage	executeRequest() executes Checkin request
void	validateRequest() validates request data

Methods inherited from class com.ptc.windchill.uwgm.proesrv.ProeServiceRequest

addContainer, addContent, addEPMDocument, addEPMDocumentMaster, addEPMWorkspace, addEPMWorkspace, addFakeFolder, addFolder, addLink, addLink, addPreferedContentURLs, addWTPart, addWTPartMaster, bindContent, bindFoldered, createDbObjIterator, getContext, getLocalizedName, getUwgmRequest, ignoreOriginalState, reportFailure, reportInfoMessage, reportInfoMessage, reportMessage, reportMessages, reportWarnings, resetCurrentEpmWS, setRequestCode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

requestCache

private final CheckinRequestCache requestCache

docMasterToPartMasterMap

private WTValuedMap docMasterToPartMasterMap

log

private static Log log

logging

Constructor Detail

CheckinRequest

public CheckinRequest(com.ptc.windchill.uwgm.soap.uwgmsvc.Checkin checkin,
                      RequestResultCache resultCache)

Method Detail

validateRequest

public void validateRequest()
                     throws RequestValidationException,
                            UwgmErrorException

Description copied from class: ProeServiceRequest

validates request data

Specified by:

validateRequest in class ProeServiceRequest

Throws:

RequestValidationException - to report validation problems

UwgmErrorException - to report errors

executeRequest

public com.ptc.windchill.uwgm.soap.uwgm.UwgmMessage executeRequest()
                                                            throws UwgmConflictException,
                                                                   UwgmErrorException

executes Checkin request

Specified by:

executeRequest in class ProeServiceRequest

Returns:

UwgmMessage[]

Throws:

UwgmErrorException - to report errors

UwgmConflictException - to report execution conflicts

doCheckin

private WTCollection doCheckin(com.ptc.windchill.uwgm.soap.uwgmsvc.Checkin uwgmCheckinRequest)
                        throws UwgmConflictException,
                               UwgmErrorException

internal checkin

Parameters:

uwgmCheckinRequest - Checkin

Returns:

WTCollection

Throws:

UwgmConflictException

UwgmErrorException

doCheckout

private void doCheckout(WTCollection masters,
                        WTCollection checkins)
                 throws UwgmConflictException,
                        UwgmErrorException

performs "post-checkin" operation - KeepCheckout

Parameters:

masters - WTCollection

checkins - WTCollection

Throws:

UwgmConflictException

UwgmErrorException

doRemove

private void doRemove(WTCollection masters,
                      WTCollection checkins)
               throws UwgmConflictException,
                      UwgmErrorException

Throws:

UwgmConflictException

UwgmErrorException

createWTParts

private WTCollection createWTParts(EPMWorkspace epmWorkspace,
                                   WTCollection epmDocuments)
                            throws UwgmConflictException,
                                   UwgmErrorException

creates associated WTParts for epmDocuments to checkin

Parameters:

epmWorkspace - EPMWorkspace

epmDocuments - WTCollection

Returns:

WTCollection

Throws:

UwgmConflictException

UwgmErrorException

addAssocPartMasters

private WTCollection addAssocPartMasters(WTCollection masters)
                                  throws WTException

Adds the masters of WTParts associated with the documents whose masters appear in the input WTCollection of masters using docMasterToPartMasterMap.

Parameters:

masters - WTCollection of masters (could be EPMDocumentMasters or WTPartMasters)

Returns:

WTCollection

Throws:

WTException