Package wt.ixb.clientAccess

Class StandardIXBService

java.lang.Object
wt.services.StandardManager
wt.ixb.clientAccess.StandardIXBService
All Implemented Interfaces:
Serializable, wt.fc._NetFactor, NetFactor, IXBService, IXBSvrService, wt.services.Manager
public class StandardIXBService extends StandardManager implements IXBService, IXBSvrService

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

See Also:

  • Method Details

    • 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
      Specified by:
      getListOfObjectSetHandlerIds in interface IXBService
      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
      Specified by:
      getListOfObjectSetHandlerIds in interface IXBService
      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

    • 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
      Specified by:
      getExportHandler in interface IXBService
      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
      Specified by:
      getExportHandler in interface IXBService
      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
      Specified by:
      getListOfExportActors in interface IXBService
      Parameters:
      locale -
      Returns:
      Vector
      Throws:
      WTException
      See Also:

    • getListOfExportActors

      public Vector getListOfExportActors(boolean displayableOnly, Locale locale) throws WTException
      Get all available export actor information as a Vector. Elements 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
      Specified by:
      getListOfExportActors in interface IXBService
      Parameters:
      displayableOnly -
      locale -
      Returns:
      Vector
      Throws:
      WTException
      See Also:

    • getObjectDisplayId

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


      Supported API: true
      Specified by:
      getObjectDisplayId in interface IXBService
      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
      Specified by:
      getNavigatorTopObjectsSearchSpec in interface IXBService
      Parameters:
      navId - The object set generator ID
      locale -
      Returns:
      String[]
      Throws:
      WTException

    • getNavigatorTopObjectsKeysSearchSpec

      public String[] getNavigatorTopObjectsKeysSearchSpec(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 keys for search .

      Supported API: true
      Specified by:
      getNavigatorTopObjectsKeysSearchSpec in interface IXBService
      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
      Specified by:
      getNavigatorParamString in interface IXBService
      Parameters:
      navId -
      topLevelObId -
      Returns:
      String
      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
      Specified by:
      doExport in interface IXBService
      Parameters:
      container -
      previewOnly -
      generatorIds -
      generatorParams -
      filterIds -
      filterParams -
      ruleFile -
      guiId -
      detailedLog -
      policyFile -
      actionName -
      clientFileName -
      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
      Specified by:
      doExport in interface IXBService
      Parameters:
      exportParam -
      Returns:
      IXBExpImpStatus
      Throws:
      WTException

    • doExport

      public IXBExpImpStatus doExport(ObjectExportParameters exportParam, ConflictResolution[] conflictResolutions) throws WTException
      Perform export. All information is set in parameter ObjectExportParameters exportParam. The predefined conflict resolutions in the ConflictResolution[]

      Supported API: true
      Specified by:
      doExport in interface IXBService
      Parameters:
      exportParam -
      conflictResolutions -
      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
      Specified by:
      getListOfImportActors in interface IXBService
      Parameters:
      locale -
      Returns:
      Vector
      Throws:
      WTException
      See Also:

    • 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
      Specified by:
      getListOfImportActors in interface IXBService
      Parameters:
      displayableOnly -
      locale -
      Returns:
      Vector
      Throws:
      WTException
      See Also:

    • 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
      Specified by:
      doImport in interface IXBService
      Parameters:
      container -
      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, IXBStreamer containerMappingFile, Locale locale) throws WTException


      Supported API: true
      Specified by:
      doImport in interface IXBService
      Parameters:
      container -
      ruleFile -
      dataFile -
      overrideConflicts -
      guiId -
      isPreview -
      detailedLog -
      actorName -
      policyFile -
      containerMappingFile -
      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, IXBStreamer containerMappingFile, Locale locale, Boolean validation) throws WTException


      Supported API: true
      Specified by:
      doImport in interface IXBService
      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 import. All information is set in parameter ObjectImportParameters importParam

      Supported API: true
      Specified by:
      doImport in interface IXBService
      Parameters:
      importParam -
      Returns:
      IXBExpImpStatus
      Throws:
      WTException

    • doImport

      public IXBExpImpStatus doImport(ObjectImportParameters importParam, ConflictResolution[] conflictResolutions) throws WTException
      Perform import. All information is set in parameter ObjectImportParameters importParam. The predefined conflict resolutions in the ConflictResolution[]

      Supported API: true
      Specified by:
      doImport in interface IXBService
      Parameters:
      importParam -
      conflictResolutions -
      Returns:
      IXBExpImpStatus
      Throws:
      WTException