wt.ixb.clientAccess
Interface IXBService

All Known Implementing Classes:

IXBServiceFwd, StandardIXBService

public interface IXBService

Supported API: true

Extendable: true

Method Summary

boolean	checkUserConfigSpecExists() Supported API: false
IXBExpImpStatus	doExport(boolean previewOnly, String[] generatorIds, String[] generatorParams, String[] filterIds, String[] filterParams, IXBStreamer ruleFile, boolean detailedLog, String stDtd) Deprecated.
IXBExpImpStatus	doExport(boolean previewOnly, String[] generatorIds, String[] generatorParams, String[] filterIds, String[] filterParams, IXBStreamer ruleFile, String guiId, boolean detailedLog, IXBStreamer policyFile, String actionName) Deprecated.
IXBExpImpStatus	doExport(ObjectExportParameters exportParam) Perform export.
IXBExpImpStatus	doExport(WTContainerRef container, boolean previewOnly, String[] generatorIds, String[] generatorParams, String[] filterIds, String[] filterParams, IXBStreamer ruleFile, String guiId, boolean detailedLog, IXBStreamer policyFile, String actionName, String clientFileName) Supported API: true
IXBExpImpStatus	doImport(IXBStreamer ruleFile, IXBStreamer dataFile, boolean overrideConflicts, boolean isPreview, boolean detailedLog, String actorName, String stDtd) Deprecated.
IXBExpImpStatus	doImport(IXBStreamer ruleFile, IXBStreamer dataFile, boolean overrideConflicts, boolean isPreview, boolean detailedLog, String actorName, String stDtd, Boolean validation) Deprecated.
IXBExpImpStatus	doImport(IXBStreamer ruleFile, IXBStreamer dataFile, boolean overrideConflicts, String guiId, boolean isPreview, boolean detailedLog, String actorName, IXBStreamer policyFile, Locale locale) Deprecated.
IXBExpImpStatus	doImport(IXBStreamer ruleFile, IXBStreamer dataFile, boolean overrideConflicts, String guiId, boolean isPreview, boolean detailedLog, String actorName, IXBStreamer policyFile, Locale locale, Boolean validation) Deprecated.
IXBExpImpStatus	doImport(ObjectImportParameters importParam) Perform export.
IXBExpImpStatus	doImport(WTContainerRef container, IXBStreamer ruleFile, IXBStreamer dataFile, boolean overrideConflicts, String guiId, boolean isPreview, boolean detailedLog, String actorName, IXBStreamer policyFile, IXBStreamer containerMappingFile, Locale locale) Supported API: true
IXBExpImpStatus	doImport(WTContainerRef container, IXBStreamer ruleFile, IXBStreamer dataFile, boolean overrideConflicts, String guiId, boolean isPreview, boolean detailedLog, String actorName, IXBStreamer policyFile, IXBStreamer containerMappingFile, Locale locale, Boolean validation) Supported API: true
IXBExpImpStatus	doImport(WTContainerRef container, IXBStreamer ruleFile, IXBStreamer dataFile, boolean overrideConflicts, String guiId, boolean isPreview, boolean detailedLog, String actorName, IXBStreamer policyFile, Locale locale) Supported API: true
IXBExpImpStatus	exportObjects(WTContainerRef containerRef, String[] objIds, ObjectExportParameters params) Deprecated.
IXBObjectInfo[]	findNavigatorTopObjectsBySearchSpec(String navId, String[] values) Deprecated.
IXBObjectInfo[]	findNavigatorTopObjectsBySearchSpec(String navId, String[] values, WTContainerRef wtcontainerRef) Find all seed objects matching the query identified by the parameter "values".
Vector	findTopObjects(String navId, String[] values) Deprecated.
Vector	getAllAvaiableFilters(Locale locale) Deprecated.
Vector	getAllAvaiableGenerators(Locale locale) Deprecated.
Object	getExportHandler(String obType) Returns the default export handler class name for the object type under the Windchill default DTD.
Object	getExportHandler(String obType, String stDtd) Returns the default export handler class name for the object type under the specified DTD (other than Windchill default DTD) Supported API: true
IXBHandlerDescription[]	getFilterList(boolean displayableOnly, Locale locale) Get all object set filters as an array.
IXBHandlerDescription[]	getGeneratorList(boolean displayableOnly, Locale locale) Get all object set generators as an array.
Vector	getListOfExportActors(boolean displayableOnly, Locale locale) Get all available export actor information as a Vector.
Vector	getListOfExportActors(Locale locale) Get all available export actor information as a Vector.
Vector	getListOfImportActors(boolean displayableOnly, Locale locale) Get all available import actor information as a Vector.
Vector	getListOfImportActors(Locale locale) Get all available import actor information as a Vector.
Vector	getListOfObjectSetHandlerIds(String searchClassName, Locale locale) Get all object set generator information applicable to the class with name searchClassName as a Vector.
Vector	getListOfObjectSetHandlerIds(String searchClassName, Locale locale, boolean exactClassSearch) Get all object set generator information applicable to the class with name searchClassName as a Vector.
String	getLocalizedDescrForInitedFilter(String id, String initParams) Supported API: false
String	getLocalizedDescrForInitedGenerator(String id, String initParams) Supported API: false
String	getNavigatorParamString(String navId, String topLevelObId) result is initParams string - i.e.
String[]	getNavigatorTopObjectsSearchSpec(String navId, Locale locale) Return an array of String.
String	getObjectDisplayId(Persistable obj, Locale locale) Supported API: true
String	getObjectId(Persistable ob) Deprecated.
void	testOnServer(String className, String methodName, Vector methodArgs) Deprecated.

Method Detail

testOnServer

public void testOnServer(String className,
                         String methodName,
                         Vector methodArgs)
                  throws WTException

Deprecated.

Supported API: false

Parameters:

className -

methodName -

methodArgs -

Throws:

WTException

getGeneratorList

public IXBHandlerDescription[] getGeneratorList(boolean displayableOnly,
                                                Locale locale)
                                         throws WTException

Get all object set generators as an array. Each element in the array will be IXBHandlerDescription. If parameter displayableOnly is set to true, then only generators which are set displayable will be returned, otherwise all generators will be returned.

Supported API: true

Parameters:

displayableOnly -

locale -

Returns:

IXBHandlerDescription[]

Throws:

WTException

getFilterList

public IXBHandlerDescription[] getFilterList(boolean displayableOnly,
                                             Locale locale)
                                      throws WTException

Get all object set filters as an array. Each element in the array will be IXBHandlerDescription. If parameter displayableOnly is set to true, only filters which are set displayable will be returned, otherwise all filters will be returned.

Supported API: true

Parameters:

displayableOnly -

locale -

Returns:

IXBHandlerDescription[]

Throws:

WTException

getListOfObjectSetHandlerIds

public Vector getListOfObjectSetHandlerIds(String searchClassName,
                                           Locale locale)
                                    throws WTException

Get all object set generator information applicable to the class with name searchClassName as a Vector. Eelements in the vector are IXBHandlerDescription. By default all generators applicable to this class and its parent classes will be returned.

Supported API: true

Parameters:

searchClassName - The class name of the corresponding object

locale - locale passed from the client. If it is null, then it will be defaulted to the Windchill server locale

Returns:

Vector

Throws:

WTException

See Also:

getListOfObjectSetHandlerIds( String searchClassName, Locale locale, boolean exactClassSearch ) , IXBHandlerDescription

getListOfObjectSetHandlerIds

public Vector getListOfObjectSetHandlerIds(String searchClassName,
                                           Locale locale,
                                           boolean exactClassSearch)
                                    throws WTException

Get all object set generator information applicable to the class with name searchClassName as a Vector. Eelements in the vector are IXBHandlerDescription. If parameter exactClassSearch is false, all generators applicable to this class and its parent classes will be returned; otherwise only generators for this class will be returned.

Supported API: true

Parameters:

searchClassName -

locale - locale passed from the client. If it is null, then it will be defaulted to the Windchill server locale

exactClassSearch - If true, the target class name will be exactly the same as the searchClass; if false, the parent class will be considered as well.

Returns:

Vector

Throws:

WTException

See Also:

getListOfObjectSetHandlerIds( String searchClassName, Locale locale) , IXBHandlerDescription

getLocalizedDescrForInitedGenerator

public String getLocalizedDescrForInitedGenerator(String id,
                                                  String initParams)
                                           throws WTException

Supported API: false

Parameters:

id -

initParams -

Returns:

String

Throws:

WTException

getLocalizedDescrForInitedFilter

public String getLocalizedDescrForInitedFilter(String id,
                                               String initParams)
                                        throws WTException

Supported API: false

Parameters:

id -

initParams -

Returns:

String

Throws:

WTException

getExportHandler

public Object getExportHandler(String obType)
                        throws WTException

Returns the default export handler class name for the object type under the Windchill default DTD.

Supported API: true

Parameters:

obType - The object type. Typically this is the class name for the corresponding objects such as wt.part.WTPart

Returns:

Object

Throws:

WTException

getExportHandler

public Object getExportHandler(String obType,
                               String stDtd)
                        throws WTException

Returns the default export handler class name for the object type under the specified DTD (other than Windchill default DTD)

Supported API: true

Parameters:

obType - The object type. Typically this is the class name for the corresponding objects such as wt.part.WTPart

stDtd - The DTD used to define the export handler for the object.

Returns:

Object

Throws:

WTException

getListOfExportActors

public Vector getListOfExportActors(Locale locale)
                             throws WTException

Get all available export actor information as a Vector. Eelements in the vector are ActorInfo. By default only those displayable to client will be returned.

Supported API: true

Parameters:

locale -

Returns:

Vector

Throws:

WTException

See Also:

(boolean displayableOnly, Locale locale), ( Locale locale), ( boolean displayableOnly, Locale locale), ActorInfo

getListOfExportActors

public Vector getListOfExportActors(boolean displayableOnly,
                                    Locale locale)
                             throws WTException

Get all available export actor information as a Vector. Eelements in the vector are ActorInfo. If parameter displayableOnly is set to true, only those displayable to client will be returned, otherwise all export actors will be returned.

Supported API: true

Parameters:

displayableOnly -

locale -

Returns:

Vector

Throws:

WTException

See Also:

(Locale locale), ( Locale locale), ( boolean displayableOnly, Locale locale), ActorInfo

getObjectDisplayId

public String getObjectDisplayId(Persistable obj,
                                 Locale locale)
                          throws WTException

Supported API: true

Parameters:

obj -

locale -

Returns:

String

Throws:

WTException

getNavigatorTopObjectsSearchSpec

public String[] getNavigatorTopObjectsSearchSpec(String navId,
                                                 Locale locale)
                                          throws WTException

Return an array of String. The first element of the array is the localized search description, and the rest are localized field names for search .

Supported API: true

Parameters:

navId - The object set generator ID

locale -

Returns:

String[]

Throws:

WTException

getNavigatorParamString

public String getNavigatorParamString(String navId,
                                      String topLevelObId)
                               throws WTException

result is initParams string - i.e. navigator "technical description"

Supported API: true

Parameters:

navId -

topLevelObId -

Returns:

String

Throws:

WTException

findNavigatorTopObjectsBySearchSpec

public IXBObjectInfo[] findNavigatorTopObjectsBySearchSpec(String navId,
                                                           String[] values)
                                                    throws WTException

Deprecated.

Find all seed objects matching the query identified by the parameter "values". The returned is an array of IXBObjectInfo. The search will be performed in Windchill classic container only.

This method is deprecated.

Supported API: false

Parameters:

navId - The ID of the object set generator

values - The values entered to search seed objects. The values are corresponding to the tag <searchKey/queryName> in the registry XML file.

Returns:

IXBObjectInfo[]

Throws:

WTException

See Also:

findNavigatorTopObjectsBySearchSpec( String navId, String[] values, WTContainerRef wtcontainerRef ), IXBObjectInfo.

findNavigatorTopObjectsBySearchSpec

public IXBObjectInfo[] findNavigatorTopObjectsBySearchSpec(String navId,
                                                           String[] values,
                                                           WTContainerRef wtcontainerRef)
                                                    throws WTException

Find all seed objects matching the query identified by the parameter "values". The returned is an array of IXBObjectInfo. The search will be performed in the specified container.

Supported API: true

Parameters:

navId - The ID of the object set generator

values - The values entered to search seed objects. The values are corresponding to the tag <searchKey/queryName> in the registry XML file.

wtcontainerRef - The container reference for seed objects to be searched in.

Returns:

IXBObjectInfo[]

Throws:

WTException

See Also:

IXBObjectInfo.

checkUserConfigSpecExists

public boolean checkUserConfigSpecExists()
                                  throws WTException

Supported API: false

Returns:

boolean

Throws:

WTException

findTopObjects

public Vector findTopObjects(String navId,
                             String[] values)
                      throws WTException

Deprecated.

Find the seed objects according to the object set generator and search parameters

Supported API: false

Parameters:

navId - The object set generator identifier

values - The search parameters. Searching is case insensitive.

Returns:

Vector

Throws:

WTException

doExport

public IXBExpImpStatus doExport(boolean previewOnly,
                                String[] generatorIds,
                                String[] generatorParams,
                                String[] filterIds,
                                String[] filterParams,
                                IXBStreamer ruleFile,
                                String guiId,
                                boolean detailedLog,
                                IXBStreamer policyFile,
                                String actionName)
                         throws WTException

Deprecated.

Supported API: false

Parameters:

previewOnly -

generatorIds -

generatorParams -

filterIds -

filterParams -

ruleFile -

guiId -

detailedLog -

policyFile -

actionName -

Returns:

IXBExpImpStatus

Throws:

WTException

doExport

public IXBExpImpStatus doExport(WTContainerRef container,
                                boolean previewOnly,
                                String[] generatorIds,
                                String[] generatorParams,
                                String[] filterIds,
                                String[] filterParams,
                                IXBStreamer ruleFile,
                                String guiId,
                                boolean detailedLog,
                                IXBStreamer policyFile,
                                String actionName,
                                String clientFileName)
                         throws WTException

Supported API: true

Parameters:

container -

previewOnly -

generatorIds -

generatorParams -

filterIds -

filterParams -

ruleFile -

guiId -

detailedLog -

policyFile -

actionName -

clientFileName -

Returns:

IXBExpImpStatus

Throws:

WTException

doExport

public IXBExpImpStatus doExport(boolean previewOnly,
                                String[] generatorIds,
                                String[] generatorParams,
                                String[] filterIds,
                                String[] filterParams,
                                IXBStreamer ruleFile,
                                boolean detailedLog,
                                String stDtd)
                         throws WTException

Deprecated.

Supported API: false

Parameters:

previewOnly -

generatorIds -

generatorParams -

filterIds -

filterParams -

ruleFile -

detailedLog -

stDtd -

Returns:

IXBExpImpStatus

Throws:

WTException

doExport

public IXBExpImpStatus doExport(ObjectExportParameters exportParam)
                         throws WTException

Perform export. All information is set in parameter ObjectExportParameters exportParam.

Supported API: true

Parameters:

exportParam -

Returns:

IXBExpImpStatus

Throws:

WTException

exportObjects

public IXBExpImpStatus exportObjects(WTContainerRef containerRef,
                                     String[] objIds,
                                     ObjectExportParameters params)
                              throws WTException

Deprecated.

Supported API: false

Parameters:

containerRef -

objIds -

params -

Returns:

IXBExpImpStatus

Throws:

WTException

getListOfImportActors

public Vector getListOfImportActors(Locale locale)
                             throws WTException

Get all available import actor information as a Vector. Eelements in the vector are ActorInfo. By default only those displayable to client will be returned.

Supported API: true

Parameters:

locale -

Returns:

Vector

Throws:

WTException

See Also:

( boolean displayableOnly, Locale locale), ( Locale locale), ( boolean displayableOnly, Locale locale), ActorInfo

getListOfImportActors

public Vector getListOfImportActors(boolean displayableOnly,
                                    Locale locale)
                             throws WTException

Get all available import actor information as a Vector. Eelements in the vector are ActorInfo. If parameter displayableOnly, is set to true, only those displayable to client will be returned, otherwise all import actors will be returned.

Supported API: true

Parameters:

displayableOnly -

locale -

Returns:

Vector

Throws:

WTException

See Also:

(Locale locale), ( Locale locale), ( boolean displayableOnly, Locale locale), ActorInfo

doImport

public IXBExpImpStatus doImport(IXBStreamer ruleFile,
                                IXBStreamer dataFile,
                                boolean overrideConflicts,
                                String guiId,
                                boolean isPreview,
                                boolean detailedLog,
                                String actorName,
                                IXBStreamer policyFile,
                                Locale locale)
                         throws WTException

Deprecated.

Supported API: false

Parameters:

ruleFile -

dataFile -

overrideConflicts -

guiId -

isPreview -

detailedLog -

actorName -

policyFile -

locale -

Returns:

IXBExpImpStatus

Throws:

WTException

doImport

public IXBExpImpStatus doImport(WTContainerRef container,
                                IXBStreamer ruleFile,
                                IXBStreamer dataFile,
                                boolean overrideConflicts,
                                String guiId,
                                boolean isPreview,
                                boolean detailedLog,
                                String actorName,
                                IXBStreamer policyFile,
                                Locale locale)
                         throws WTException

Supported API: true

Parameters:

container -

ruleFile -

dataFile -

overrideConflicts -

guiId -

isPreview -

detailedLog -

actorName -

policyFile -

locale -

Returns:

IXBExpImpStatus

Throws:

WTException

doImport

public IXBExpImpStatus doImport(IXBStreamer ruleFile,
                                IXBStreamer dataFile,
                                boolean overrideConflicts,
                                boolean isPreview,
                                boolean detailedLog,
                                String actorName,
                                String stDtd)
                         throws WTException

Deprecated.

Supported API: false

Parameters:

ruleFile -

dataFile -

overrideConflicts -

isPreview -

detailedLog -

actorName -

stDtd -

Returns:

IXBExpImpStatus

Throws:

WTException

doImport

public IXBExpImpStatus doImport(WTContainerRef container,
                                IXBStreamer ruleFile,
                                IXBStreamer dataFile,
                                boolean overrideConflicts,
                                String guiId,
                                boolean isPreview,
                                boolean detailedLog,
                                String actorName,
                                IXBStreamer policyFile,
                                IXBStreamer containerMappingFile,
                                Locale locale)
                         throws WTException

Supported API: true

Parameters:

container -

ruleFile -

dataFile -

overrideConflicts -

guiId -

isPreview -

detailedLog -

actorName -

policyFile -

containerMappingFile -

locale -

Returns:

IXBExpImpStatus

Throws:

WTException

doImport

public IXBExpImpStatus doImport(IXBStreamer ruleFile,
                                IXBStreamer dataFile,
                                boolean overrideConflicts,
                                boolean isPreview,
                                boolean detailedLog,
                                String actorName,
                                String stDtd,
                                Boolean validation)
                         throws WTException

Deprecated.

Supported API: false

Parameters:

ruleFile -

dataFile -

overrideConflicts -

isPreview -

detailedLog -

actorName -

stDtd -

validation -

Returns:

IXBExpImpStatus

Throws:

WTException

doImport

public IXBExpImpStatus doImport(IXBStreamer ruleFile,
                                IXBStreamer dataFile,
                                boolean overrideConflicts,
                                String guiId,
                                boolean isPreview,
                                boolean detailedLog,
                                String actorName,
                                IXBStreamer policyFile,
                                Locale locale,
                                Boolean validation)
                         throws WTException

Deprecated.

Supported API: false

Parameters:

ruleFile -

dataFile -

overrideConflicts -

guiId -

isPreview -

detailedLog -

actorName -

policyFile -

locale -

validation -

Returns:

IXBExpImpStatus

Throws:

WTException

doImport

public IXBExpImpStatus doImport(WTContainerRef container,
                                IXBStreamer ruleFile,
                                IXBStreamer dataFile,
                                boolean overrideConflicts,
                                String guiId,
                                boolean isPreview,
                                boolean detailedLog,
                                String actorName,
                                IXBStreamer policyFile,
                                IXBStreamer containerMappingFile,
                                Locale locale,
                                Boolean validation)
                         throws WTException

Supported API: true

Parameters:

container -

ruleFile -

dataFile -

overrideConflicts -

guiId -

isPreview -

detailedLog -

actorName -

policyFile -

containerMappingFile -

locale -

validation -

Returns:

IXBExpImpStatus

Throws:

WTException

doImport

public IXBExpImpStatus doImport(ObjectImportParameters importParam)
                         throws WTException

Perform export. All information is set in parameter ObjectImportParameters exportParam.

Supported API: true

Parameters:

importParam -

Returns:

IXBExpImpStatus

Throws:

WTException

getObjectId

public String getObjectId(Persistable ob)
                   throws WTException

Deprecated.

Supported API: false

Parameters:

ob -

Returns:

String

Throws:

WTException

getAllAvaiableGenerators

public Vector getAllAvaiableGenerators(Locale locale)
                                throws WTException

Deprecated.

This method is deprecated.
Use the method getGeneratorList( boolean displayableOnly, Locale locale )

Supported API: false

Parameters:

locale -

Returns:

Vector

Throws:

WTException

getAllAvaiableFilters

public Vector getAllAvaiableFilters(Locale locale)
                             throws WTException

Deprecated.

This method is deprecated.
Use the method getFilterList( boolean displayableOnly, Locale locale )

Supported API: false

Parameters:

locale -

Returns:

Vector

Throws:

WTException