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

java.lang.Object
  com.ptc.windchill.uwgm.proesrv.cache.RequestCacheAdapter
      com.ptc.windchill.uwgm.proesrv.cache.FindIterationsRequestCacheAdapter

All Implemented Interfaces:

FindIterationsRequestCache

public class FindIterationsRequestCacheAdapter

extends RequestCacheAdapter

implements FindIterationsRequestCache

Field Summary

private ConfigSpec	configSpec
private static Log	log logging
private List	retrieverSpecs
private Persistable	scopeObject

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

Constructor Summary

FindIterationsRequestCacheAdapter()

Method Summary

private RetrieverSpec	createCADNameSpec(com.ptc.windchill.uwgm.soap.uwgmsvc.FindEpmByCadName option, RevisionIterationInfo lrii) creates CADName RetrieverSpec for FindEpmByCadName option
private RetrieverSpec	createCADNameSpec(String cadName, RevisionIterationInfo lrii) creates cadName RetrieverSpec for CADName string
private RetrieverSpec	createFindOfSpec(RetrieverSpec.Type type, RetrieverSpec spec, RetrieverSpec aux_spec)
private RetrieverSpec	createIterationSpec(com.ptc.windchill.uwgm.soap.uwgmdb.Iteration iteration)
private RetrieverSpec	createMasterIdSpec(com.ptc.windchill.uwgm.soap.uwgmsvc.FindEpmByMaster option, RevisionIterationInfo rii) creates MasterId RetrieverSpec by FindEpmByMaster option
private RetrieverSpec	createMasterIdSpec(com.ptc.windchill.uwgm.soap.uwgmsvc.FindPartByMaster option, RevisionIterationInfo rii) creates MasterId RetrieverSpec by FindEpmByMaster option
private RetrieverSpec	createMasterIdSpec(com.ptc.windchill.uwgm.soap.uwgmdb.Master master, RevisionIterationInfo lrii) creates MasterId RetrieverSpec by Master
private RetrieverSpec	createNumberSpec(com.ptc.windchill.uwgm.soap.uwgmsvc.FindPartByNumber option, RevisionIterationInfo lrii) creates Number RetrieverSpec for FindPartByNumber option
private RetrieverSpec	createOidSpec(com.ptc.windchill.uwgm.soap.uwgmdb.Iteration iteration) creates OID spec by EpmIteration
ConfigSpec	getConfigSpec() returns ConfigSpec or null if not specified
RetrieverSpec[]	getRetrievalSpecs() returns an array of RetrieverSpec
Persistable	getScope() returns Search scope (Workspace, Container, Folder)
private void	optionNotSupported(com.ptc.windchill.uwgm.soap.uwgmsvc.FindEpmOption option)
private void	optionNotSupported(com.ptc.windchill.uwgm.soap.uwgmsvc.FindPartOption option)
private ConfigSpec	processConfigSpecOption(RequestContext requestContext, com.ptc.windchill.uwgm.soap.uwgmsvc.FindByConfigSpec option)
private WTContainer	processContainerScope(RequestContext requestContext, com.ptc.windchill.uwgm.soap.uwgmsvc.FindInContainer scopeOption)
private RevisionIterationInfo	processCriterias(com.ptc.windchill.uwgm.soap.uwgmsvc.FindOption[] criteria, RequestContext requestContext) process additional Find Criteria (ConfigSpec, RevisiobIterationInfo)
private Collection	processFindEpmOption(com.ptc.windchill.uwgm.soap.uwgmsvc.FindEpmOption[] options, RevisionIterationInfo rii)
private Collection	processFindPartOption(com.ptc.windchill.uwgm.soap.uwgmsvc.FindPartOption[] options, RevisionIterationInfo rii) process and validate indPartOption
private Folder	processFolderScope(RequestContext requestContext, com.ptc.windchill.uwgm.soap.uwgmsvc.FindInFolder scopeOption) obtains Folder from FindInFolder instruction
private RevisionIterationInfo	processRIIOption(com.ptc.windchill.uwgm.soap.uwgmsvc.FindByVersion option) obtaints RevisionIterationInfo from FindByVersion option
private RevisionIterationInfo	processRIIOption(com.ptc.windchill.uwgm.soap.uwgmsvc.VersionInfo versionInfo) obtaints RevisionIterationInfo by VersionInfo from FindByVersion option
private void	processScope(com.ptc.windchill.uwgm.soap.uwgmsvc.FindScope scope, RequestContext requestContext) process and validate Find scope (WS, Container, Folder)
private EPMWorkspace	processWorkspaceScope(RequestContext requestContext, com.ptc.windchill.uwgm.soap.uwgmsvc.FindInWorkspace scopeOption)
protected void	validateRequestData(RequestContext requestContext, com.ptc.windchill.uwgm.soap.uwgm.UwgmRequest uwgmRequest) abstract validateRequestData method to be overwritten by RequestCacheAdapter implementations

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

scopeObject

private Persistable scopeObject

configSpec

private ConfigSpec configSpec

retrieverSpecs

private List retrieverSpecs

log

private static Log log

logging

Constructor Detail

FindIterationsRequestCacheAdapter

public FindIterationsRequestCacheAdapter()

Method Detail

validateRequestData

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

Description copied from class: RequestCacheAdapter

abstract validateRequestData method to be overwritten by RequestCacheAdapter implementations

Specified by:

validateRequestData in class RequestCacheAdapter

Parameters:

requestContext - RequestContext

uwgmRequest - UwgmRequest

Throws:

RequestValidationException

UwgmErrorException

processFindEpmOption

private Collection processFindEpmOption(com.ptc.windchill.uwgm.soap.uwgmsvc.FindEpmOption[] options,
                                        RevisionIterationInfo rii)
                                 throws UwgmErrorException,
                                        RequestValidationException

Throws:

UwgmErrorException

RequestValidationException

processFindPartOption

private Collection processFindPartOption(com.ptc.windchill.uwgm.soap.uwgmsvc.FindPartOption[] options,
                                         RevisionIterationInfo rii)
                                  throws UwgmErrorException,
                                         RequestValidationException

process and validate indPartOption

Parameters:

options - FindPartOption[]

rii - RevisionIterationInfo

Returns:

Collection

Throws:

UwgmErrorException

RequestValidationException

processCriterias

private RevisionIterationInfo processCriterias(com.ptc.windchill.uwgm.soap.uwgmsvc.FindOption[] criteria,
                                               RequestContext requestContext)
                                        throws UwgmErrorException,
                                               RequestValidationException

process additional Find Criteria (ConfigSpec, RevisiobIterationInfo)

Parameters:

criteria - FindOption[]

requestContext - RequestContext

Returns:

RevisionIterationInfo

Throws:

UwgmErrorException

RequestValidationException

processScope

private void processScope(com.ptc.windchill.uwgm.soap.uwgmsvc.FindScope scope,
                          RequestContext requestContext)
                   throws UwgmErrorException,
                          RequestValidationException

process and validate Find scope (WS, Container, Folder)

Parameters:

scope - FindScope

requestContext - RequestContext

Throws:

UwgmErrorException

RequestValidationException

processContainerScope

private WTContainer processContainerScope(RequestContext requestContext,
                                          com.ptc.windchill.uwgm.soap.uwgmsvc.FindInContainer scopeOption)
                                   throws RequestValidationException,
                                          UwgmErrorException

Throws:

RequestValidationException

UwgmErrorException

processFolderScope

private Folder processFolderScope(RequestContext requestContext,
                                  com.ptc.windchill.uwgm.soap.uwgmsvc.FindInFolder scopeOption)
                           throws RequestValidationException,
                                  UwgmErrorException

obtains Folder from FindInFolder instruction

Parameters:

requestContext - RequestContext

Returns:

Folder

Throws:

RequestValidationException

UwgmErrorException

processWorkspaceScope

private EPMWorkspace processWorkspaceScope(RequestContext requestContext,
                                           com.ptc.windchill.uwgm.soap.uwgmsvc.FindInWorkspace scopeOption)
                                    throws RequestValidationException,
                                           UwgmErrorException

Throws:

RequestValidationException

UwgmErrorException

processConfigSpecOption

private ConfigSpec processConfigSpecOption(RequestContext requestContext,
                                           com.ptc.windchill.uwgm.soap.uwgmsvc.FindByConfigSpec option)
                                    throws RequestValidationException,
                                           UwgmErrorException

Parameters:

option - FindByConfigSpec

Returns:

ConfigSpec

Throws:

RequestValidationException

UwgmErrorException

processRIIOption

private RevisionIterationInfo processRIIOption(com.ptc.windchill.uwgm.soap.uwgmsvc.FindByVersion option)
                                        throws RequestValidationException,
                                               UwgmErrorException

obtaints RevisionIterationInfo from FindByVersion option

Parameters:

option - FindByVersion

Returns:

RevisionIterationInfo

Throws:

RequestValidationException

UwgmErrorException

processRIIOption

private RevisionIterationInfo processRIIOption(com.ptc.windchill.uwgm.soap.uwgmsvc.VersionInfo versionInfo)
                                        throws RequestValidationException,
                                               UwgmErrorException

obtaints RevisionIterationInfo by VersionInfo from FindByVersion option

Parameters:

versionInfo - VersionInfo

Returns:

RevisionIterationInfo

Throws:

RequestValidationException

UwgmErrorException

createIterationSpec

private RetrieverSpec createIterationSpec(com.ptc.windchill.uwgm.soap.uwgmdb.Iteration iteration)
                                   throws RequestValidationException,
                                          UwgmErrorException

Throws:

RequestValidationException

UwgmErrorException

createOidSpec

private RetrieverSpec createOidSpec(com.ptc.windchill.uwgm.soap.uwgmdb.Iteration iteration)
                             throws RequestValidationException,
                                    UwgmErrorException

creates OID spec by EpmIteration

Parameters:

iteration - Iteration

Returns:

RetrieverSpec

Throws:

RequestValidationException

UwgmErrorException

createMasterIdSpec

private RetrieverSpec createMasterIdSpec(com.ptc.windchill.uwgm.soap.uwgmsvc.FindEpmByMaster option,
                                         RevisionIterationInfo rii)
                                  throws RequestValidationException,
                                         UwgmErrorException

creates MasterId RetrieverSpec by FindEpmByMaster option

Parameters:

option - FindEpmByMaster

Returns:

RetrieverSpec

Throws:

RequestValidationException

UwgmErrorException

createMasterIdSpec

private RetrieverSpec createMasterIdSpec(com.ptc.windchill.uwgm.soap.uwgmsvc.FindPartByMaster option,
                                         RevisionIterationInfo rii)
                                  throws RequestValidationException,
                                         UwgmErrorException

creates MasterId RetrieverSpec by FindEpmByMaster option

Parameters:

option - FindEpmByMaster

Returns:

RetrieverSpec

Throws:

RequestValidationException

UwgmErrorException

createMasterIdSpec

private RetrieverSpec createMasterIdSpec(com.ptc.windchill.uwgm.soap.uwgmdb.Master master,
                                         RevisionIterationInfo lrii)
                                  throws RequestValidationException,
                                         UwgmErrorException

creates MasterId RetrieverSpec by Master

Parameters:

master - Master

Returns:

RetrieverSpec

Throws:

RequestValidationException

UwgmErrorException

createCADNameSpec

private RetrieverSpec createCADNameSpec(com.ptc.windchill.uwgm.soap.uwgmsvc.FindEpmByCadName option,
                                        RevisionIterationInfo lrii)
                                 throws RequestValidationException

creates CADName RetrieverSpec for FindEpmByCadName option

Parameters:

option - FindEpmByCadName

Returns:

RetrieverSpec

Throws:

RequestValidationException

createCADNameSpec

private RetrieverSpec createCADNameSpec(String cadName,
                                        RevisionIterationInfo lrii)
                                 throws RequestValidationException

creates cadName RetrieverSpec for CADName string

Returns:

RetrieverSpec

Throws:

RequestValidationException

createNumberSpec

private RetrieverSpec createNumberSpec(com.ptc.windchill.uwgm.soap.uwgmsvc.FindPartByNumber option,
                                       RevisionIterationInfo lrii)
                                throws RequestValidationException

creates Number RetrieverSpec for FindPartByNumber option

Parameters:

option - FindPartByNumber

Returns:

RetrieverSpec

Throws:

RequestValidationException

createFindOfSpec

private RetrieverSpec createFindOfSpec(RetrieverSpec.Type type,
                                       RetrieverSpec spec,
                                       RetrieverSpec aux_spec)

getScope

public Persistable getScope()

returns Search scope (Workspace, Container, Folder)

Specified by:

getScope in interface FindIterationsRequestCache

Returns:

Persistable

getRetrievalSpecs

public RetrieverSpec[] getRetrievalSpecs()

returns an array of RetrieverSpec

Specified by:

getRetrievalSpecs in interface FindIterationsRequestCache

Returns:

RetrieverSpec[]

getConfigSpec

public ConfigSpec getConfigSpec()

returns ConfigSpec or null if not specified

Specified by:

getConfigSpec in interface FindIterationsRequestCache

Returns:

ConfigSpec

optionNotSupported

private void optionNotSupported(com.ptc.windchill.uwgm.soap.uwgmsvc.FindEpmOption option)
                         throws RequestValidationException

Throws:

RequestValidationException

optionNotSupported

private void optionNotSupported(com.ptc.windchill.uwgm.soap.uwgmsvc.FindPartOption option)
                         throws RequestValidationException

Throws:

RequestValidationException