|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectwt.services.StandardManager
wt.ixb.clientAccess.StandardIXBService
Use the newStandardIXBService
static factory method(s),
not the StandardIXBService
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: true
Extendable: true
Nested Class Summary | |
private class |
StandardIXBService.ExportHandler
|
private class |
StandardIXBService.ImportHandler
|
Field Summary | |
private static String |
CLASSNAME
|
private static String |
IXB_RESOURCE
|
private static String |
IXB_TEMP_DIRECTORY
|
private Random |
randomNumGenerator
|
private static ResourceBundle |
rb
|
private static String |
RESOURCE
|
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 | |
StandardIXBService()
|
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 |
private IXBExpImpStatus |
doExportImpl(ObjectExportParameters exportParam)
|
private IXBExpImpStatus |
doExportImpl(WTContainerRef containerRef,
boolean previewOnly,
String[] generatorIds,
String[] generatorParams,
String[] filterIds,
String[] filterParams,
IXBStreamer ruleFile,
boolean detailedLog,
IXBStreamer policyFile,
String actionName,
String clientFileName,
String guiId,
String dtd)
|
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 |
private IXBExpImpStatus |
doImportImpl(ObjectImportParameters importParam)
|
private IXBExpImpStatus |
doImportImpl(WTContainerRef container,
IXBStreamer ruleFile,
IXBStreamer dataFile,
boolean _overrideConflicts,
boolean isPreview,
boolean detailedLog,
String actorName,
IXBStreamer policyFile,
IXBStreamer containerMappingFile,
Boolean validation,
String guiId,
String dtd,
Locale locale)
|
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. |
private WTContainerRef |
getClassicRef()
|
String |
getConceptualClassname()
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. |
String |
getObjectNumber(Persistable ob)
|
static File |
getSaveDirectoryOnServer()
|
static File |
getSaveFileOnServer()
Supported API: false |
File |
getUniqueDirectoryNameToSave()
|
File |
getUniqueFileNameToSave()
|
File |
getUniqueLogFileName()
|
private static boolean |
lookAndSort(Vector vec,
long num)
|
static StandardIXBService |
newStandardIXBService()
Supported API: false |
protected void |
performStartupProcess()
Supported API: false |
private static void |
PP_GC(String s)
|
private static void |
PP(String s)
|
private static void |
PPMem(String s)
|
private static StandardIXBService |
retriveService()
|
static boolean |
sendProgressMessageToClient(String localizedMsg,
boolean isExportOp)
|
private void |
setExpImpClientGuiId(String gId)
|
void |
testOnServer(String className,
String methodName,
Vector methodArgs)
Deprecated. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
private static final String RESOURCE
private static final String CLASSNAME
private static String IXB_RESOURCE
private static ResourceBundle rb
private static String IXB_TEMP_DIRECTORY
private Random randomNumGenerator
Constructor Detail |
public StandardIXBService()
Method Detail |
public String getConceptualClassname()
getConceptualClassname
in interface NetFactor
getConceptualClassname
in class StandardManager
public static StandardIXBService newStandardIXBService() throws WTException
WTException
protected void performStartupProcess() throws ManagerException
performStartupProcess
in class StandardManager
ManagerException
public static File getSaveFileOnServer()
public void testOnServer(String className, String methodName, Vector methodArgs) throws WTException
testOnServer
in interface IXBService
className
- methodName
- methodArgs
-
WTException
public IXBHandlerDescription[] getGeneratorList(boolean displayableOnly, Locale locale) throws WTException
IXBHandlerDescription
. If parameter
displayableOnly is set to true, then only generators which are set
displayable will be returned, otherwise all generators will be returned.
getGeneratorList
in interface IXBService
displayableOnly
- locale
-
WTException
public IXBHandlerDescription[] getFilterList(boolean displayableOnly, Locale locale) throws WTException
IXBHandlerDescription
. If parameter
displayableOnly is set to true, only filters which are set displayable
will be returned, otherwise all filters will be returned.
getFilterList
in interface IXBService
displayableOnly
- locale
-
WTException
public Vector getListOfObjectSetHandlerIds(String searchClassName, Locale locale) throws WTException
Vector
.
Eelements in the vector are IXBHandlerDescription
. By
default all generators applicable to this class and its parent classes
will be returned.
getListOfObjectSetHandlerIds
in interface IXBService
searchClassName
- The class name of the corresponding objectlocale
- locale passed from the client. If it is null, then it will be defaulted to the Windchill server locale
WTException
getListOfObjectSetHandlerIds( String searchClassName, Locale
locale, boolean exactClassSearch )
,
IXBHandlerDescription
public Vector getListOfObjectSetHandlerIds(String searchClassName, Locale locale, boolean exactClassSearch) throws WTException
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.
getListOfObjectSetHandlerIds
in interface IXBService
searchClassName
- locale
- locale passed from the client. If it is null, then it will be defaulted to the Windchill server localeexactClassSearch
- If true, the target class name will be exactly the same as the searchClass; if false, the parent class will be considered as well.
WTException
getListOfObjectSetHandlerIds( String searchClassName, Locale
locale)
,
IXBHandlerDescription
public String getLocalizedDescrForInitedGenerator(String id, String initParams) throws WTException
getLocalizedDescrForInitedGenerator
in interface IXBService
id
- initParams
-
WTException
public String getLocalizedDescrForInitedFilter(String id, String initParams) throws WTException
getLocalizedDescrForInitedFilter
in interface IXBService
id
- initParams
-
WTException
public Object getExportHandler(String obType) throws WTException
getExportHandler
in interface IXBService
obType
- The object type. Typically this is the class name for the corresponding objects such as wt.part.WTPart
WTException
public Object getExportHandler(String obType, String stDtd) throws WTException
getExportHandler
in interface IXBService
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.
WTException
public Vector getListOfExportActors(Locale locale) throws WTException
Vector
.
Eelements in the vector are ActorInfo
. By default only
those displayable to client will be returned.
getListOfExportActors
in interface IXBService
locale
-
WTException
(boolean displayableOnly, Locale locale)
,
( Locale locale)
,
( boolean displayableOnly, Locale locale)
,
ActorInfo
public Vector getListOfExportActors(boolean displayableOnly, Locale locale) throws WTException
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.
getListOfExportActors
in interface IXBService
displayableOnly
- locale
-
WTException
(Locale locale)
,
( Locale locale)
,
( boolean displayableOnly, Locale locale)
,
ActorInfo
public String getObjectDisplayId(Persistable obj, Locale locale) throws WTException
getObjectDisplayId
in interface IXBService
obj
- locale
-
WTException
public String[] getNavigatorTopObjectsSearchSpec(String navId, Locale locale) throws WTException
getNavigatorTopObjectsSearchSpec
in interface IXBService
navId
- The object set generator IDlocale
-
WTException
public String getNavigatorParamString(String navId, String topLevelObId) throws WTException
getNavigatorParamString
in interface IXBService
navId
- topLevelObId
-
WTException
public IXBObjectInfo[] findNavigatorTopObjectsBySearchSpec(String navId, String[] values) throws WTException
IXBObjectInfo
.
The search will be performed in Windchill classic container only.
This method is deprecated.
Supported API: false
findNavigatorTopObjectsBySearchSpec
in interface IXBService
navId
- The ID of the object set generatorvalues
- The values entered to search seed objects. The values are corresponding to the tag
<searchKey/queryName> in the registry XML file.
WTException
findNavigatorTopObjectsBySearchSpec( String navId, String[]
values, WTContainerRef wtcontainerRef )
,
IXBObjectInfo
.public IXBObjectInfo[] findNavigatorTopObjectsBySearchSpec(String navId, String[] values, WTContainerRef wtcontainerRef) throws WTException
IXBObjectInfo
.
The search will be performed in the specified container.
findNavigatorTopObjectsBySearchSpec
in interface IXBService
navId
- The ID of the object set generatorvalues
- 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.
WTException
IXBObjectInfo
.public boolean checkUserConfigSpecExists() throws WTException
checkUserConfigSpecExists
in interface IXBService
WTException
public Vector findTopObjects(String navId, String[] values) throws WTException
findTopObjects
in interface IXBService
navId
- The object set generator identifiervalues
- The search parameters. Searching is case insensitive.
WTException
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
doExport
in interface IXBService
previewOnly
- generatorIds
- generatorParams
- filterIds
- filterParams
- ruleFile
- guiId
- detailedLog
- policyFile
- actionName
-
WTException
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
doExport
in interface IXBService
container
- previewOnly
- generatorIds
- generatorParams
- filterIds
- filterParams
- ruleFile
- guiId
- detailedLog
- policyFile
- actionName
- clientFileName
-
WTException
public IXBExpImpStatus doExport(boolean previewOnly, String[] generatorIds, String[] generatorParams, String[] filterIds, String[] filterParams, IXBStreamer ruleFile, boolean detailedLog, String stDtd) throws WTException
doExport
in interface IXBService
previewOnly
- generatorIds
- generatorParams
- filterIds
- filterParams
- ruleFile
- detailedLog
- stDtd
-
WTException
public IXBExpImpStatus doExport(ObjectExportParameters exportParam) throws WTException
ObjectExportParameters
exportParam.
doExport
in interface IXBService
exportParam
-
WTException
public IXBExpImpStatus exportObjects(WTContainerRef containerRef, String[] objIds, ObjectExportParameters params) throws WTException
exportObjects
in interface IXBService
containerRef
- objIds
- params
-
WTException
public Vector getListOfImportActors(Locale locale) throws WTException
Vector
.
Eelements in the vector are ActorInfo
. By default only
those displayable to client will be returned.
getListOfImportActors
in interface IXBService
locale
-
WTException
( boolean displayableOnly, Locale locale)
,
( Locale locale)
,
( boolean displayableOnly, Locale locale)
,
ActorInfo
public Vector getListOfImportActors(boolean displayableOnly, Locale locale) throws WTException
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.
getListOfImportActors
in interface IXBService
displayableOnly
- locale
-
WTException
(Locale locale)
,
( Locale locale)
,
( boolean displayableOnly, Locale locale)
,
ActorInfo
public IXBExpImpStatus doImport(IXBStreamer ruleFile, IXBStreamer dataFile, boolean overrideConflicts, String guiId, boolean isPreview, boolean detailedLog, String actorName, IXBStreamer policyFile, Locale locale) throws WTException
doImport
in interface IXBService
ruleFile
- dataFile
- overrideConflicts
- guiId
- isPreview
- detailedLog
- actorName
- policyFile
- locale
-
WTException
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
doImport
in interface IXBService
container
- ruleFile
- dataFile
- overrideConflicts
- guiId
- isPreview
- detailedLog
- actorName
- policyFile
- locale
-
WTException
public IXBExpImpStatus doImport(IXBStreamer ruleFile, IXBStreamer dataFile, boolean overrideConflicts, boolean isPreview, boolean detailedLog, String actorName, String stDtd) throws WTException
doImport
in interface IXBService
ruleFile
- dataFile
- overrideConflicts
- isPreview
- detailedLog
- actorName
- stDtd
-
WTException
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
doImport
in interface IXBService
container
- ruleFile
- dataFile
- overrideConflicts
- guiId
- isPreview
- detailedLog
- actorName
- policyFile
- containerMappingFile
- locale
-
WTException
public IXBExpImpStatus doImport(IXBStreamer ruleFile, IXBStreamer dataFile, boolean overrideConflicts, boolean isPreview, boolean detailedLog, String actorName, String stDtd, Boolean validation) throws WTException
doImport
in interface IXBService
ruleFile
- dataFile
- overrideConflicts
- isPreview
- detailedLog
- actorName
- stDtd
- validation
-
WTException
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
doImport
in interface IXBService
ruleFile
- dataFile
- overrideConflicts
- guiId
- isPreview
- detailedLog
- actorName
- policyFile
- locale
- validation
-
WTException
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
doImport
in interface IXBService
container
- ruleFile
- dataFile
- overrideConflicts
- guiId
- isPreview
- detailedLog
- actorName
- policyFile
- containerMappingFile
- locale
- validation
-
WTException
public IXBExpImpStatus doImport(ObjectImportParameters importParam) throws WTException
ObjectImportParameters
exportParam.
doImport
in interface IXBService
importParam
-
WTException
public String getObjectId(Persistable ob) throws WTException
getObjectId
in interface IXBService
ob
-
WTException
public Vector getAllAvaiableGenerators(Locale locale) throws WTException
getGeneratorList( boolean displayableOnly, Locale
locale )
getAllAvaiableGenerators
in interface IXBService
locale
-
WTException
public Vector getAllAvaiableFilters(Locale locale) throws WTException
getFilterList( boolean displayableOnly, Locale
locale )
getAllAvaiableFilters
in interface IXBService
locale
-
WTException
private IXBExpImpStatus doExportImpl(ObjectExportParameters exportParam) throws WTException
WTException
private IXBExpImpStatus doExportImpl(WTContainerRef containerRef, boolean previewOnly, String[] generatorIds, String[] generatorParams, String[] filterIds, String[] filterParams, IXBStreamer ruleFile, boolean detailedLog, IXBStreamer policyFile, String actionName, String clientFileName, String guiId, String dtd) throws WTException
WTException
private IXBExpImpStatus doImportImpl(ObjectImportParameters importParam) throws WTException
WTException
private IXBExpImpStatus doImportImpl(WTContainerRef container, IXBStreamer ruleFile, IXBStreamer dataFile, boolean _overrideConflicts, boolean isPreview, boolean detailedLog, String actorName, IXBStreamer policyFile, IXBStreamer containerMappingFile, Boolean validation, String guiId, String dtd, Locale locale) throws WTException
WTException
public File getUniqueLogFileName() throws IOException
IOException
public File getUniqueFileNameToSave() throws IOException
IOException
private static StandardIXBService retriveService() throws WTException
WTException
public File getUniqueDirectoryNameToSave() throws IOException
IOException
public static File getSaveDirectoryOnServer()
private void setExpImpClientGuiId(String gId)
public static boolean sendProgressMessageToClient(String localizedMsg, boolean isExportOp)
private static void PP(String s)
private static void PPMem(String s)
private static void PP_GC(String s)
public String getObjectNumber(Persistable ob) throws WTException
WTException
private WTContainerRef getClassicRef() throws WTException
WTException
private static boolean lookAndSort(Vector vec, long num)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |