com.ptc.windchill.cadx.search
Class StandardCustomSearchManager

java.lang.Object
  wt.services.StandardManager
      com.ptc.windchill.cadx.search.StandardCustomSearchManager

All Implemented Interfaces:

CustomSearchManager, Manager, NetFactor, Serializable

public class StandardCustomSearchManager

extends StandardManager

implements CustomSearchManager, Serializable

Use the newStandardCustomSearchManager static factory method(s), not the StandardCustomSearchManager constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private Class[]	attrDefinitionCl
private static Class[]	attrValueCl
private String	BRANCH_ID
private static String	CLASSNAME
private static String	CODEBASE_URL
private String	CONTENT_HOLDER_ID
private String	DEFINITION_REFERENCE_ID
private static long	EXPIRED_INTERVAL
private String	GENERIC_ID
private String	HOLDER_REFERENCE_CLASS
private String	HOLDER_REFERENCE_ID
private String	INSTANCE_ID
private String	ITERATION_ID
private String	MASTER_ID
private String	MASTER_NUMBER
private String	OBJ_ID
private static String	OPEN_IMG
private static String[][]	PDMObjStatusGlyphTable
private static String	RESOURCE
private Hashtable	searchResults
private String	TRAIL_PREFIX_OPEN_IN_PROE_LINK
private String	TRAIL_PREFIX_PROPERTIES_LINK
private static String	UTIL_RESOURCE
private static boolean	VERBOSE
private String	VERSION_ID

Fields inherited from class wt.services.StandardManager

Fields inherited from interface wt.services.Manager

MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE

Constructor Summary

StandardCustomSearchManager()

Method Summary

private Vector	filterByContainer(QueryResult qr, Map enabledContainers, Map shared, boolean filterByCabinet)
Vector	getAllUsedIBA() Supported API: false
String	getConceptualClassname() Deprecated.
Vector	getContainers(String activeWS, Locale locale) Supported API: false
static int	getDocumentType(boolean isInstance, boolean isGeneric)
private Map	getEnabledContainers(String value, String activeWS, Locale locale)
private HashMap	getGenericHolderOfInstances(QuerySpec searchQuerySpec)
private HashMap	getGenerics(QuerySpec searchQuerySpec)
String	getHelpURL(String helpContext, String activeWS, Locale locale) Supported API: false
private HashMap	getHolders(QuerySpec searchQuerySpec)
long	getIDByKey(String className, String path) Supported API: false
long	getIDByKey(String className, String number, String version, String iteration) Supported API: false
private HashMap	getInstances(QuerySpec searchQuerySpec)
String[]	getKeyByID(String className, long ID) Supported API: false
private String	getObjGlyphTag(EPMDocument obj, boolean[] instance_generic_holder_shared)
private String	getOperator(String value)
Vector	getSearchResults(String sessionID) Supported API: false
Vector	getSearchResults(String queryValue, Hashtable conditions, Vector sortKeys, String filter, Vector contentLibrary, String activeServer, String activeWS, Locale locale, Boolean isK_01) Supported API: false
String	getSearchResultsPage(String pageURL, String queryValue, long sessionID, int pageOffset, int pageRange, Locale locale) Supported API: false
private HashMap	getShared(QuerySpec searchQuerySpec, WTContainer container)
private String	getStatusGlyph(String objState)
Vector	getUsedIBA(Vector holdersCl) Supported API: false
private String	getValue(String value)
static String	getWorkspaceContentState(EPMDocument obj)
private String[]	getWorkspaces(Vector objs)
private boolean	isClassValid(Class cl)
boolean	isEnterpriseSearch() Supported API: false
static String	MapDocumentTypeToPDMObjType(int docType, boolean isDocWithContents)
static StandardCustomSearchManager	newStandardCustomSearchManager() Default factory for the class.
private void	refreshCache()

Methods inherited from class wt.services.StandardManager

emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, performStartupProcess, registerEvents, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

UTIL_RESOURCE

private static final String UTIL_RESOURCE

See Also:

Constant Field Values

attrDefinitionCl

private final Class[] attrDefinitionCl

attrValueCl

private static final Class[] attrValueCl

OBJ_ID

private final String OBJ_ID

See Also:

Constant Field Values

MASTER_ID

private final String MASTER_ID

See Also:

Constant Field Values

DEFINITION_REFERENCE_ID

private final String DEFINITION_REFERENCE_ID

See Also:

Constant Field Values

HOLDER_REFERENCE_ID

private final String HOLDER_REFERENCE_ID

See Also:

Constant Field Values

HOLDER_REFERENCE_CLASS

private final String HOLDER_REFERENCE_CLASS

See Also:

Constant Field Values

BRANCH_ID

private final String BRANCH_ID

See Also:

Constant Field Values

MASTER_NUMBER

private final String MASTER_NUMBER

See Also:

Constant Field Values

VERSION_ID

private final String VERSION_ID

See Also:

Constant Field Values

ITERATION_ID

private final String ITERATION_ID

See Also:

Constant Field Values

INSTANCE_ID

private final String INSTANCE_ID

See Also:

Constant Field Values

GENERIC_ID

private final String GENERIC_ID

See Also:

Constant Field Values

CONTENT_HOLDER_ID

private final String CONTENT_HOLDER_ID

See Also:

Constant Field Values

TRAIL_PREFIX_OPEN_IN_PROE_LINK

private final String TRAIL_PREFIX_OPEN_IN_PROE_LINK

See Also:

Constant Field Values

TRAIL_PREFIX_PROPERTIES_LINK

private final String TRAIL_PREFIX_PROPERTIES_LINK

See Also:

Constant Field Values

OPEN_IMG

private static String OPEN_IMG

CODEBASE_URL

private static String CODEBASE_URL

EXPIRED_INTERVAL

private static long EXPIRED_INTERVAL

VERBOSE

private static boolean VERBOSE

searchResults

private Hashtable searchResults

PDMObjStatusGlyphTable

private static String[][] PDMObjStatusGlyphTable

Constructor Detail

StandardCustomSearchManager

public StandardCustomSearchManager()

Method Detail

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Overrides:

getConceptualClassname in class StandardManager

Returns:

String

newStandardCustomSearchManager

public static StandardCustomSearchManager newStandardCustomSearchManager()
                                                                  throws WTException

Default factory for the class.

Supported API: false

Returns:

StandardCustomSearchManager

Throws:

WTException

getUsedIBA

public Vector getUsedIBA(Vector holdersCl)
                  throws WTException,
                         WTPropertyVetoException

Supported API: false

Specified by:

getUsedIBA in interface CustomSearchManager

Parameters:

holdersCl -

Returns:

Vector

Throws:

WTException

WTPropertyVetoException

getAllUsedIBA

public Vector getAllUsedIBA()
                     throws WTException,
                            WTPropertyVetoException

Supported API: false

Specified by:

getAllUsedIBA in interface CustomSearchManager

Returns:

Vector

Throws:

WTException

WTPropertyVetoException

getSearchResults

public Vector getSearchResults(String queryValue,
                               Hashtable conditions,
                               Vector sortKeys,
                               String filter,
                               Vector contentLibrary,
                               String activeServer,
                               String activeWS,
                               Locale locale,
                               Boolean isK_01)
                        throws WTException,
                               WTPropertyVetoException

Supported API: false

Specified by:

getSearchResults in interface CustomSearchManager

Parameters:

queryValue -

conditions -

sortKeys -

filter -

contentLibrary -

activeServer -

activeWS -

locale -

isK_01 -

Returns:

Vector

Throws:

WTException

WTPropertyVetoException

getSearchResults

public Vector getSearchResults(String sessionID)
                        throws WTException

Supported API: false

Specified by:

getSearchResults in interface CustomSearchManager

Parameters:

sessionID -

Returns:

Vector

Throws:

WTException

getSearchResultsPage

public String getSearchResultsPage(String pageURL,
                                   String queryValue,
                                   long sessionID,
                                   int pageOffset,
                                   int pageRange,
                                   Locale locale)
                            throws WTException

Supported API: false

Specified by:

getSearchResultsPage in interface CustomSearchManager

Parameters:

pageURL -

queryValue -

sessionID -

pageOffset -

pageRange -

locale -

Returns:

String

Throws:

WTException

getIDByKey

public long getIDByKey(String className,
                       String path)
                throws WTException

Supported API: false

Specified by:

getIDByKey in interface CustomSearchManager

Parameters:

className -

path -

Returns:

long

Throws:

WTException

getIDByKey

public long getIDByKey(String className,
                       String number,
                       String version,
                       String iteration)
                throws WTException

Supported API: false

Specified by:

getIDByKey in interface CustomSearchManager

Parameters:

className -

number -

version -

iteration -

Returns:

long

Throws:

WTException

getKeyByID

public String[] getKeyByID(String className,
                           long ID)
                    throws WTException

Supported API: false

Specified by:

getKeyByID in interface CustomSearchManager

Parameters:

className -

ID -

Returns:

String[]

Throws:

WTException

isEnterpriseSearch

public boolean isEnterpriseSearch()
                           throws WTException

Supported API: false

Specified by:

isEnterpriseSearch in interface CustomSearchManager

Returns:

boolean

Throws:

WTException

getHelpURL

public String getHelpURL(String helpContext,
                         String activeWS,
                         Locale locale)
                  throws WTException

Supported API: false

Specified by:

getHelpURL in interface CustomSearchManager

Parameters:

helpContext -

activeWS -

locale -

Returns:

String

Throws:

WTException

getContainers

public Vector getContainers(String activeWS,
                            Locale locale)
                     throws WTException,
                            WTPropertyVetoException

Supported API: false

Specified by:

getContainers in interface CustomSearchManager

Parameters:

activeWS -

locale -

Returns:

Vector

Throws:

WTException

WTPropertyVetoException

isClassValid

private boolean isClassValid(Class cl)
                      throws WTException

Throws:

WTException

getOperator

private String getOperator(String value)

getValue

private String getValue(String value)

getWorkspaces

private String[] getWorkspaces(Vector objs)
                        throws WTException

Throws:

WTException

getObjGlyphTag

private String getObjGlyphTag(EPMDocument obj,
                              boolean[] instance_generic_holder_shared)
                       throws WTException

Throws:

WTException

getStatusGlyph

private String getStatusGlyph(String objState)

getDocumentType

public static int getDocumentType(boolean isInstance,
                                  boolean isGeneric)

MapDocumentTypeToPDMObjType

public static String MapDocumentTypeToPDMObjType(int docType,
                                                 boolean isDocWithContents)

getWorkspaceContentState

public static String getWorkspaceContentState(EPMDocument obj)

getGenerics

private HashMap getGenerics(QuerySpec searchQuerySpec)
                     throws WTException

Throws:

WTException

getInstances

private HashMap getInstances(QuerySpec searchQuerySpec)
                      throws WTException

Throws:

WTException

getGenericHolderOfInstances

private HashMap getGenericHolderOfInstances(QuerySpec searchQuerySpec)
                                     throws WTException

Throws:

WTException

getHolders

private HashMap getHolders(QuerySpec searchQuerySpec)
                    throws WTException

Throws:

WTException

getShared

private HashMap getShared(QuerySpec searchQuerySpec,
                          WTContainer container)
                   throws WTException

Throws:

WTException

getEnabledContainers

private Map getEnabledContainers(String value,
                                 String activeWS,
                                 Locale locale)
                          throws WTException,
                                 WTPropertyVetoException

Throws:

WTException

WTPropertyVetoException

filterByContainer

private Vector filterByContainer(QueryResult qr,
                                 Map enabledContainers,
                                 Map shared,
                                 boolean filterByCabinet)

refreshCache

private void refreshCache()