Package com.ptc.windchill.mpml.processplan

Interface PlantLocalizationService

@RemoteInterface public interface PlantLocalizationService
Service to perform plant assignment-related tasks.

Supported API: true

Extendable: false

  • Method Details

    • localizeOperations

      PlantLocalizationReport localizeOperations(ObjectReference aWorkCenter, List<ObjectReference> anOperationList, NCServerHolder aCriteria, Locale aLocale) throws WTException
      (Plant) Localize the specified operations to the specified work centers. MPMPlantLocalizationLinks will be created in the order specified in anOperationList.

      Supported API: true
      Parameters:
      aWorkCenter - a work center to be localize by operations
      anOperationList - operations to (plant)-localize to work centers
      aCriteria - navigation criteria to use when loading objects
      aLocale - locale to use to prepare messages for the user
      Returns:
      plant-localization execution report containing all the information about what took place
      Throws:
      WTException
      NullPointerException - if a null operation collection is passed in, a null work center is passed in, a null criteria is passed in, or, a null locale is passed in.
      IllegalArgumentException - if an empty operation collection is passed in

    • localizeOperationsAfter

      PlantLocalizationReport localizeOperationsAfter(ObjectReference aWorkCenter, ObjectReference anAfterOperation, List<ObjectReference> anOperationList, NCServerHolder aCriteria, Locale aLocale) throws WTException
      (Plant) Localize the specified operations to the specified work centers. MPMPlantLocalizationLinks will be created in the order specified in anOperationList.

      Supported API: true
      Parameters:
      aWorkCenter - a work center to be localize by operations
      anAfterOperation - the operation that indicates the 'after' insertion point -- can be null
      anOperationList - operations to (plant)-localize to work centers
      aCriteria - navigation criteria to use when loading objects
      aLocale - locale to use to prepare messages for the user
      Returns:
      plant-localization execution report containing all the information about what took place
      Throws:
      WTException
      NullPointerException - if a null operation collection is passed in, a null work center is passed in, a null criteria is passed in, or, a null locale is passed in.
      IllegalArgumentException - if an empty operation collection is passed in

    • relocalizeOperations

      PlantLocalizationReport relocalizeOperations(ObjectReference aSourceWorkCenter, ObjectReference aTargetWorkCenter, List<ObjectReference> operationsToRelocalize, NCServerHolder aCriteria, Locale aLocale) throws WTException
      (Plant) Re-localize the specified operations from the source work center to the target work center. The new order in operationsToRelocalize is respected (this could be different that the original order at the source work center).
      Parameters:
      aSourceWorkCenter - the source work center (to localize from)
      aTargetWorkCenter - the target work center (to localize to)
      operationsToRelocalize - operations to relocalize (in the given, new order)
      aCriteria - navigation criteria to use when loading objects
      aLocale - locale to use to prepare messages for the user

      Supported API: true
      Returns:
      plant-localization execution report containing all the information about what took place
      Throws:
      WTException
      NullPointerException - if a null operation collection is passed in, a null work center is passed in, a null criteria is passed in, or, a null locale is passed in.
      IllegalArgumentException - if an empty operation collection is passed in

    • removeLocalizedOperations

      PlantLocalizationReport removeLocalizedOperations(ObjectReference aWorkCenter, Set<ObjectReference> operationToRemove, NCServerHolder aCriteria, Locale aLocale) throws WTException
      Remove a list of localized operations from a work center.

      Supported API: true
      Parameters:
      aWorkCenter - the work center to remove from
      operationToRemove - the operations to remove ("delocalize")
      aCriteria - navigation criteria
      aLocale - locale to use to prepare messages for the user
      Returns:
      plant-localization execution report containing all the information about what took place
      Throws:
      WTException

    • reorderLocalizedOperations

      PlantLocalizationReport reorderLocalizedOperations(ObjectReference aWorkCenter, ObjectReference anOperation, List<ObjectReference> operationsToReorder, NCServerHolder aCriteria, Locale aLocale) throws WTException
      Reorder a set of localized operations from a work center.

      Supported API: true
      Parameters:
      aWorkCenter - the work center to remove from
      anOperation - the operation that indicates the 'after' insertion point -- can be null
      operationsToReorder - the operations to reorder (insert after the insertion point)
      aCriteria - navigation criteria
      aLocale - locale to use to prepare messages for the user
      Returns:
      plant-localization execution report containing all the information about what took place
      Throws:
      WTException

    • getWorkCenterCompatibilities

      PlantLocalizationService.WorkCenterCompatibilityReport getWorkCenterCompatibilities(Set<ObjectReference> operations, Set<ObjectReference> workCenters, NCServerHolder aCriteria, Locale aLocale) throws WTException
      Generate a work center compatibility report

      Supported API: true
      Parameters:
      operations - the operations to consider
      workCenters - the work centers to consider
      aCriteria - navigation criteria
      aLocale - locale to use to prepare messages for the user
      Returns:
      work center compatibility report
      Throws:
      WTException