com.ptc.windchill.uwgm.proesrv.cache
Class TargetFolderInstructionCacheAdapter

java.lang.Object
  com.ptc.windchill.uwgm.proesrv.cache.RequestCacheAdapter
      com.ptc.windchill.uwgm.proesrv.cache.IterationRequestCacheAdapter
          com.ptc.windchill.uwgm.proesrv.cache.WorkspaceIterationRequestCacheAdapter
              com.ptc.windchill.uwgm.proesrv.cache.WorkableIterationRequestCacheAdapter
                  com.ptc.windchill.uwgm.proesrv.cache.TargetFolderInstructionCacheAdapter

All Implemented Interfaces:

IterationRequestCache, TargetFolderInstructionCache, WorkspaceIterationRequestCache, WorkspaceRequestCache

Direct Known Subclasses:

CheckinInstructionCacheAdapter

public class TargetFolderInstructionCacheAdapter

extends WorkableIterationRequestCacheAdapter

implements TargetFolderInstructionCache

TargetFolderInstructionCache adapter

Nested Class Summary

Nested classes inherited from class com.ptc.windchill.uwgm.proesrv.cache.IterationRequestCacheAdapter

Field Summary

private WTValuedMap	iterationFolderMap internal [Iteration(EPMDoc, WTPart), Folder(or null)] Map
private boolean	keepNullFolderInstructions allow to accept/keep instructions with null folder
private static Log	log logging
private boolean	newIterationsOnly allow only new iterations

Fields inherited from class com.ptc.windchill.uwgm.proesrv.cache.WorkspaceIterationRequestCacheAdapter

checkedInIterations, checkedOutIterations, epmWorkspace, iterationsNotInWorkspace, newIterations, wsContent

Fields inherited from class com.ptc.windchill.uwgm.proesrv.cache.IterationRequestCacheAdapter

objectVsUwgmIteration, oidHelper

Fields inherited from class com.ptc.windchill.uwgm.proesrv.cache.RequestCacheAdapter

Constructor Summary

TargetFolderInstructionCacheAdapter()
default constructor

Method Summary

protected List	collectValidationMessages(com.ptc.windchill.uwgm.soap.uwgmsvc.WorkspaceRequest uwgmRequest) Collects the validation messages for objects in the request.
WTValuedMap	getTargetFolderInstructions() returns TargetFolderInstruction map [Persistable, Folder]
protected void	keepNullFolderInstructions(boolean trueOrFalse)
protected void	setNewIterationsOnly(boolean trueOrFalse)
protected void	validateRequestData(RequestContext requestContext, com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest uwgmRequest) validates TargetFolderRequest data
protected void	validateTargetFolderInstructions(RequestContext requestContext, com.ptc.windchill.uwgm.soap.uwgmsvc.TargetFolderInstruction[] instructions) validates TargetFolderInstruction

Methods inherited from class com.ptc.windchill.uwgm.proesrv.cache.WorkableIterationRequestCacheAdapter

collectValidationMessages

Methods inherited from class com.ptc.windchill.uwgm.proesrv.cache.WorkspaceIterationRequestCacheAdapter

getCheckedInIterations, getCheckedOutIterations, getEpmWorkspace, getIterationsNotInWorkspace, getNewIterations, getPartDocumentFinder, validateWorkspaceIterations

Methods inherited from class com.ptc.windchill.uwgm.proesrv.cache.IterationRequestCacheAdapter

addIterationNotFoundMessage, getIterations, resolveIterationByMasters, validateIterations

Methods inherited from class com.ptc.windchill.uwgm.proesrv.cache.RequestCacheAdapter

checkCacheData, isValid, setValid, validate

Methods inherited from class java.lang.Object

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

Field Detail

iterationFolderMap

private WTValuedMap iterationFolderMap

internal [Iteration(EPMDoc, WTPart), Folder(or null)] Map

newIterationsOnly

private boolean newIterationsOnly

allow only new iterations

keepNullFolderInstructions

private boolean keepNullFolderInstructions

allow to accept/keep instructions with null folder

log

private static Log log

logging

Constructor Detail

TargetFolderInstructionCacheAdapter

public TargetFolderInstructionCacheAdapter()

default constructor

Method Detail

getTargetFolderInstructions

public WTValuedMap getTargetFolderInstructions()

returns TargetFolderInstruction map [Persistable, Folder]

Specified by:

getTargetFolderInstructions in interface TargetFolderInstructionCache

Returns:

WTValuedMap

setNewIterationsOnly

protected void setNewIterationsOnly(boolean trueOrFalse)

keepNullFolderInstructions

protected void keepNullFolderInstructions(boolean trueOrFalse)

validateRequestData

protected void validateRequestData(RequestContext requestContext,
                                   com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest uwgmRequest)
                            throws RequestValidationException,
                                   UwgmErrorException

validates TargetFolderRequest data

Overrides:

validateRequestData in class WorkableIterationRequestCacheAdapter

Parameters:

requestContext - RequestContext

uwgmRequest - UwgmRequest

Throws:

RequestValidationException

UwgmErrorException

validateTargetFolderInstructions

protected void validateTargetFolderInstructions(RequestContext requestContext,
                                                com.ptc.windchill.uwgm.soap.uwgmsvc.TargetFolderInstruction[] instructions)
                                         throws RequestValidationException,
                                                UwgmErrorException

validates TargetFolderInstruction

Parameters:

requestContext - RequestContext

instructions - TargetFolderInstruction[]

Throws:

RequestValidationException

UwgmErrorException

collectValidationMessages

protected List collectValidationMessages(com.ptc.windchill.uwgm.soap.uwgmsvc.WorkspaceRequest uwgmRequest)
                                  throws WTException

Description copied from class: WorkspaceIterationRequestCacheAdapter

Collects the validation messages for objects in the request. Checks if any object in the request is not present in the workspace. This method can be overridden by the subclasses to check whether the individual iterations are valid for the operation.

Overrides:

collectValidationMessages in class WorkspaceIterationRequestCacheAdapter

Parameters:

uwgmRequest - The UWGM request

Returns:

List of messages

Throws:

WTException