Package wt.eff

Interface EffService

@RemoteInterface public interface EffService
This service provides general effectivity functionality, both through its API and through listeners, that operate on EffManagedVersion, Eff, EffContext, EffConfigurationItem, ProductSolution and ProductInstance objects; this functionality can be reused by various implementations of effectivity including the reference implementation in wt.effectivity. EffConfigSpecAssistant and EffGroupAssistant also execute server-side actions for several classes of objects in this package.

The reference implementation of this service interface also manages effectivity data during various business operations via listeners defined in StandardEffService.

  • Cookie: None
  • Helper: EffHelper has helper methods
  • Service implementation: StandardEffService (has listeners)
  • ServiceEvent: None
  • ServiceException: None


Supported API: true

Extendable: false

  • Method Details

    • getEffs

      QueryResult getEffs(EffManagedVersion version) throws WTException
      For a given EffManagedVersion, return all Effs assigned to it.

      Supported API: true
      Parameters:
      version -
      Returns:
      QueryResult
      Throws:
      WTException

    • getAllContexts

      QueryResult getAllContexts() throws WTException
      Return all EffContext objects in the DB. The result is filtered by access control.

      Supported API: true
      Returns:
      QueryResult
      Throws:
      WTException

    • getEffConfigurationItem

      EffConfigurationItem getEffConfigurationItem(String name) throws WTException
      Returns the EffConfigurationItem that has this name. If none exists, returns null.

      Supported API: true
      Parameters:
      name -
      Returns:
      EffConfigurationItem
      Throws:
      WTException

    • getInstances

      QueryResult getInstances(EffConfigurationItem configItem) throws WTException
      Returns all ProductInstances for this EffConfigurationItem. The instances are subject to access control.

      Supported API: true
      Parameters:
      configItem -
      Returns:
      QueryResult
      Throws:
      WTException

    • getEffectableChangeRecords

      List<ChangeRecordIfc> getEffectableChangeRecords(ChangeOrderIfc changeNotice) throws WTException
      Returns all change records of passed in change notice for which the associated changeable is a valid effectivity target.



      Supported API: true

      Parameters:
      changeNotice - Change notice to return valid effectivity targetable change records of
      Returns:
      List
      Throws:
      WTException

    • getEffectableChangeRecords

      List<ChangeRecordIfc> getEffectableChangeRecords(List<ChangeActivityIfc> listChangeActivities) throws WTException
      Returns all change records across list of passed in change activities for which the associated changeable is a valid effectivity target.



      Supported API: true

      Parameters:
      listChangeActivities - List of change activities
      Returns:
      List
      Throws:
      WTException

    • getEffectableChangeRecords

      List<ChangeRecordIfc> getEffectableChangeRecords(ChangeActivityIfc changeActivity, List<Changeable2> listChangeables) throws WTException
      Returns all change records which associate a changeable in the passed in list with the passed in change activity, and for which the changeable is a valid eff target.



      Supported API: true

      Parameters:
      changeActivity - Change activity
      listChangeables - List of changeables participating in change record associations with the passed in change activity
      Returns:
      List
      Throws:
      WTException

    • getClientEffGroups

      Map<WTReference,List<ClientEffGroup>> getClientEffGroups(List<WTReference> references) throws WTException
      Given a list of references to EffRecordables, returns map keyed by reference and valued by list of ClientEffGroup objects.



      Supported API: true

      Parameters:
      references - List of references to EffRecordable objects
      Returns:
      Map<WTReference,List>
      Throws:
      WTException

    • getEffectableReportedAgainsts

      List<ReportedAgainstIfc> getEffectableReportedAgainsts(ChangeIssue changeIssue) throws WTException
      Returns all reported against links of passed in change issue for which the associated changeable is a valid effectivity target.



      Supported API: true

      Parameters:
      changeIssue - Change issue to return valid effectivity targetable reported againsts of
      Returns:
      List
      Throws:
      WTException

    • getEffectableReportedAgainsts

      List<ReportedAgainstIfc> getEffectableReportedAgainsts(ChangeIssue changeIssue, List<Changeable2> listChangeables) throws WTException
      Returns all change records which associate a changeable in the passed in list with the passed in change issue, and for which the changeable is a valid eff target.



      Supported API: true

      Parameters:
      changeIssue - Change issue
      listChangeables - List of changeables participating in reported against associations with the passed in change issue
      Returns:
      List
      Throws:
      WTException

    • filterEffectableChangeRecords

      Map<Boolean,List<ChangeRecordIfc>> filterEffectableChangeRecords(ChangeOrderIfc changeNotice) throws WTException
      Filters all change records of passed in change notice and places those for which the associated changeable is a valid effectivity target into list keyed by Boolean.TRUE, and the non-valid ones into the list keyed by Boolean.FALSE.



      Supported API: true

      Parameters:
      changeNotice - Change notice to return valid effectivity targetable change records of
      Returns:
      Map<Boolean,List>
      Throws:
      WTException

    • cloneEffRecords

      Set<EffRecord> cloneEffRecords(EffRecordable effRecordable) throws WTException
      Clones the EffRecords for passed in EffRecordable.

      Supported API: true
      Parameters:
      effRecordable -
      Returns:
      Set
      Throws:
      WTException

    • getEffectivity

      QueryResult getEffectivity(EffRecordable effRecordable) throws WTException
      For a given EffRecordable returns all the effectivities.

      Supported API: true
      Parameters:
      effRecordable -
      Returns:
      QueryResult
      Throws:
      WTException

    • filterEffectableChangeRecords

      Map<Boolean,List<ChangeRecordIfc>> filterEffectableChangeRecords(List<ChangeActivityIfc> listChangeActivities) throws WTException
      Filters all change records across list of passed in change activities and returns those for which the associated changeable is a valid effectivity target into the list keyed by Boolean.TRUE, and the non-valid ones into the list keyed by Boolean.FALSE.



      Supported API: true

      Parameters:
      listChangeActivities - List of change activities
      Returns:
      Map<Boolean,List>
      Throws:
      WTException

    • filterEffectableChangeRecords

      Map<Boolean,List<ChangeRecordIfc>> filterEffectableChangeRecords(ChangeActivityIfc changeActivity, List<Changeable2> listChangeables) throws WTException
      Filters all change records which associate a changeable in the passed in list with the passed in change activity, and returns those for which the changeable is a valid eff target in the list keyed by Boolean.TRUE, and those which are not valid in the list keyed by Boolean.FALSE.



      Supported API: true

      Parameters:
      changeActivity - Change activity
      listChangeables - List of changeables participating in change record associations with the passed in change activity
      Returns:
      Map<Boolean,List>
      Throws:
      WTException

    • filterEffectableReportedAgainsts

      Map<Boolean,List<ReportedAgainstIfc>> filterEffectableReportedAgainsts(ChangeIssue changeIssue) throws WTException
      Filters all reported against links of passed in change issue and returns those for which the associated changeable is a valid effectivity target in the list keyed by Boolean.TRUE, and those which are not in the list keyed by Boolean.FALSE.



      Supported API: true

      Parameters:
      changeIssue - Change issue to return valid effectivity targetable reported againsts of
      Returns:
      Map<Boolean,List>
      Throws:
      WTException

    • filterEffectableReportedAgainsts

      Map<Boolean,List<ReportedAgainstIfc>> filterEffectableReportedAgainsts(ChangeIssue changeIssue, List<Changeable2> listChangeables) throws WTException
      Filters all change records which associate a changeable in the passed in list with the passed in change issue, and returns those for which the changeable is a valid eff target in the list keyed by Boolean.TRUE, and those which are not in the list keyed by Boolean.FALSE.



      Supported API: true

      Parameters:
      changeIssue - Change issue
      listChangeables - List of changeables participating in reported against associations with the passed in change issue
      Returns:
      Map<Boolean,List>
      Throws:
      WTException

    • hasPendingEffectivities

      boolean hasPendingEffectivities(EffContext effContext) throws WTException
      Given an effectivity context, this method returns whether any existing pending effectivities exist which are active against the context.



      Supported API: true

      Parameters:
      effContext - effectivity context
      Returns:
      boolean
      Throws:
      WTException

    • getEffs

      Map<EffManagedVersion,Set<Eff>> getEffs(WTSet setTargets) throws WTException
      For a given set of EffManagedVersion objects, return a map keyed by the target and valued by a set of Effs assigned to the target.

      Supported API: true
      Parameters:
      setTargets -
      Returns:
      Map<EffManagedVersion,Set>
      Throws:
      WTException

    • getAllEffs

      Map<WTReference,Set<Eff>> getAllEffs(WTSet setTargets) throws WTException
      For a given set of targets, return a map keyed by the target reference and valued by a set of Effs assigned to the target reference.

      Supported API: true
      Parameters:
      setTargets -
      Returns:
      Map<WTReference,<Set&ltEff>>
      Throws:
      WTException

    • getAllEffectivities

      Map<EffRecordable,Set<EffRecord>> getAllEffectivities(WTSet setTargets, boolean processedFlag) throws WTException, WTPropertyVetoException
      Returns all Effectivities (Pending,Variance,Active)for given set of targets objects,if processed flag is true it will return the pending effectivities which are resolved.

      Supported API: true
      Parameters:
      setTargets - set of objects or which need to find out effectivites
      processedFlag - flag to include processed pending effectivities
      Returns:
      returns a map of EffRecordable and set of effectivties applied on it
      Throws:
      WTException
      WTPropertyVetoException

    • getAllEffectivities

      Map<EffRecordable,Set<EffRecord>> getAllEffectivities(WTSet setTargets, List<EffContext> effContext, List<Class> effType, List<Class> effUsage, boolean processedFlag) throws WTException, WTPropertyVetoException
      Returns all Effectivities (Pending,Variance,Active)for given set of targets objects,on the bases of given context ,type and usage.

      Supported API: true
      Parameters:
      setTargets - set of objects or which need to find out effectivites
      effContext - List of EffContext Objects for which related Effectivites objects are to be retrieved
      effType - List of Class object representing the concrete type of the Effectivity, can not be null
      effUsage - List of Class object representing effusage(Pending,Variance,Active)
      processedFlag - flag to include processed pending effectivities
      Returns:
      returns a map of EffRecordable and set of effectivties applied on it
      Throws:
      WTException
      WTPropertyVetoException

    • getAllEffectivities

      Set<EffRecord> getAllEffectivities(EffRecordable effRecordable, EffContext effContext, Class effType, Class effUsage, boolean processedFlag) throws WTException
      Returns all Effectivities (Pending,Variance,Active)for given set of targets objects,on the bases of given context ,type and usage.

      Supported API: true
      Parameters:
      effRecordable - object or which need to find out effectivites
      effContext - EffContext Object for which related Effectivites objects are to be retrieved
      effType - Class object representing the concrete type of the Effectivity, can not be null
      effUsage - Class object representing effusage(Pending,Variance,Active)
      processedFlag - flag to include processed pending effectivities
      Returns:
      returns a set of effectivties applied on EffRecordable
      Throws:
      WTException

    • createProductEffectivities

      Set<EffGroup> createProductEffectivities(EffManagedVersion target, List<ClientEffGroup> clientEffGroups, ChangeActivityIfc authorizedBy) throws WTException
      Creates Product Effectivity on specified EffRecordable and returns the map of specified EffManagedVersion and the set of all effectivities on that specified EffManagedVersion. This API also supports custom effectivity types.

      Supported API: true
      Parameters:
      EffManagedVersion - target - It is the target to create the effectivities
      List - clientEffGroups - It is the list of clientEffGroups for creating effectivities. Each clientEffGroup must specify below attributes: 1. effContextReference - optional for Date effectivities, but mandatory for Serial, Lot, Block and MSN. This Specifies effectivity Context. 2. effFormClass - mandatory. This specifies the type of Effectivity. Below are the values for respective effectivity types: a. DateEffForm for Date effectivity b. BlockEffForm for Block effectivity c. LotEffForm for Lot Effectivity d. MSNEffForm for MSN Effectivity e. SerialEffForm for Serial Effectivity 3. range - mandatory. This specifies the start and end range. The start and end range value needs to be specified in format Based on the configured start and end range separator. OOTB the separator is DASH "-" 4. effTypeModifier - optional. This specifies the Effectivity Qualifier. 5. attrMap - not required for OOTB effectivites but might be required for custom effectivities defining their additional attributes. For custom effectivities some attribute might be mandatory or optional depending on how custom effectivities are defined.
      ChangeActivityIfc - authorizedBy - optional. It is the change task to set as authorization for effectivities. If this is not specified then the user invoking the API will be treated as Authorization.
      Returns:
      Set - Returns the set of all product effectivities on that target. The returned EffGroup also contains the authorization information and which is represented by authorizedBy and modifier attributes of EffGroup.
      Throws:
      WTException

    • modifyProductEffectivities

      Set<EffGroup> modifyProductEffectivities(EffManagedVersion target, Map<ClientEffGroup,ClientEffGroup> originalToModifedEffGroupMap, boolean modifyAuthorizedBy, ChangeActivityIfc authorizedBy) throws WTException
      Modifies Product Effectivity on specified EffManagedVersion and returns the map of specified EffManagedVersion and the set of all effectivities on that specified EffManagedVersion. This API also supports custom effectivity types.

      Supported API: true
      Parameters:
      EffManagedVersion - target - It is the target to modify the effectivities
      Map - <ClientEffGroup, ClientEffGroup> originalToModifedEffGroupMap - It is the map of original ClientEffGroup and modified ClientEffGroup to modify effectivities Each clientEffGroup must specify below attributes: 1. effContextReference - optional for Date effectivities, but mandatory for Serial, Lot, Block and MSN. This Specifies effectivity Context. 2. effFormClass - mandatory. This specifies the type of Effectivity. Below are the values for respective effectivity types: a. DateEffForm for Date effectivity b. BlockEffForm for Block effectivity c. LotEffForm for Lot Effectivity d. MSNEffForm for MSN Effectivity e. SerialEffForm for Serial Effectivity 3. range - mandatory. This specifies the start and end range. The start and end range value needs to be specified in format Based on the configured start and end range separator. OOTB the separator is DASH "-" 4. effTypeModifier - optional. This specifies the Effectivity Qualifier. 5. attrMap - not required for OOTB effectivites but might be required for custom effectivities defining their additional attributes. For custom effectivities some attribute might be mandatory or optional depending on how custom effectivities are defined. Note: Make sure to specify the all the values for attributes that need to remain unchanged as well as those that need to be modified.
      boolean - modifyAuthorizedBy - This flag indicates whether to modify authorization or not.
      ChangeActivityIfc - authorizedBy - optional. It is the change task to set as authorization for effectivities. The value of this parameter is considered only when modifyAuthorizedBy flag is true.
      Returns:
      Set - Returns the set of all product effectivities on that target represented by an EffGroup. The returned EffGroup also contains the authorization information and which is represented by authorizedBy and modifier attributes of EffGroup.
      Throws:
      WTException

    • deleteProductEffectivities

      Set<EffGroup> deleteProductEffectivities(EffManagedVersion target, List<ClientEffGroup> listDeleteEffGroups) throws WTException
      Deletes Product Effectivity on specified EffManagedVersion and returns the map of specified EffManagedVersion and the set of all remaining effectivities after deletion on that specified EffManagedVersion. This API also supports custom effectivity types.

      Supported API: true
      Parameters:
      EffManagedVersion - target - It is the target to delete the effectivities
      List - listDeleteEffGroups - It is the list of clientEffGroups for deleting effectivities Each clientEffGroup must specify below attributes: 1. effContextReference - optional for Date effectivities, but mandatory for Serial, Lot, Block and MSN. This Specifies effectivity Context. 2. effFormClass - mandatory. This specifies the type of Effectivity. Below are the values for respective effectivity types: a. DateEffForm for Date effectivity b. BlockEffForm for Block effectivity c. LotEffForm for Lot Effectivity d. MSNEffForm for MSN Effectivity e. SerialEffForm for Serial Effectivity 3. range - mandatory. This specifies the start and end range. The start and end range value needs to be specified in format Based on the configured start and end range separator. OOTB the separator is DASH "-" 4. effTypeModifier - optional. This specifies the Effectivity Qualifier. 5. attrMap - not required for OOTB effectivites but might be required for custom effectivities defining their additional attributes. For custom effectivities some attribute might be mandatory or optional depending on how custom effectivities are defined.
      Returns:
      Set - Returns the set of all remaining product effectivities on that target represented by an EffGroup after deletion on that target The returned EffGroup also contains the authorization information and which is represented by authorizedBy and modifier attributes of EffGroup.
      Throws:
      WTException

    • getProductEffectivities

      Set<EffGroup> getProductEffectivities(EffManagedVersion effManaged) throws WTException
      For a given EffManagedVersion object, returns a set of all Product effectivities assigned to the effManaged object.

      Supported API: true
      Parameters:
      effManaged -
      Returns:
      Set - Returns the set of all product effectivities on that target represented by an EffGroup. The returned EffGroup also contains the authorization information and which is represented by authorizedBy and modifier attributes of EffGroup.
      Throws:
      WTException

    • getProductEffectivitiesMap

      Map<WTReference,Collection<EffGroup>> getProductEffectivitiesMap(EffManagedVersion effManaged) throws WTException
      For a given EffManagedVersion object, returns a map of WTReference of passed effManaged and Collection of all Product effectivities assigned to the effManaged object.

      Supported API: true
      Parameters:
      effManaged -
      Returns:
      Map<WTReference, Collection> The returned EffGroup also contains the authorization information and which is represented by authorizedBy and modifier attributes of EffGroup.
      Throws:
      WTException

    • createPendingEffectivities

      Set<PendingEff> createPendingEffectivities(EffManagedVersion target, List<ClientEffGroup> listNewPendingEffGroups) throws WTException
      Creates Pending Effectivities on specified EffRecordable and returns the set of all effectivities on that specified EffManagedVersion. This API also supports custom pending effectivity types.

      Supported API: true
      Parameters:
      EffManagedVersion - target - It is the target to create the pending effectivities
      List - listNewPendingEffGroups - It is the list of clientEffGroups for creating pending effectivities. Each clientEffGroup must specify below attributes: 1. effContextReference - optional for Date effectivities, but mandatory for Serial, Lot, Block and MSN. This Specifies effectivity Context. 2. effFormClass - mandatory. This specifies the type of Effectivity. Below are the values for respective effectivity types: a. DateEffForm for Date effectivity b. BlockEffForm for Block effectivity c. LotEffForm for Lot Effectivity d. MSNEffForm for MSN Effectivity e. SerialEffForm for Serial Effectivity 3. range - mandatory. This specifies the start and end range. The start and end range value needs to be specified in format Based on the configured start and end range separator. OOTB the separator is DASH "-" 4. effTypeModifier - optional. This specifies the Effectivity Qualifier. 5. linkReference - mandatory. This specifies the Change Record Link for locating pending effectivity. 6. propagateDown - optional. This specifies whether to propagate through effectivity strcuture. This can only be specified when Structure propagation preference is turned on. 7. stopAtTraceable - This specified whether to stop progataion at lower-level traceable objects. This can only be specified when Structure propagation preference is turned on. 8. attrMap - not required for OOTB effectivites but might be required for custom effectivities defining their additional attributes. For custom effectivities some attribute might be mandatory or optional depending on how custom effectivities are defined.
      Returns:
      Set - Returns the set of all pending effectivities on that target
      Throws:
      WTException

    • modifyPendingEffectivities

      Set<PendingEff> modifyPendingEffectivities(EffManagedVersion target, Map<ClientEffGroup,ClientEffGroup> originalToModifedPendingEffGroupMap) throws WTException
      Modifies Pending Effectivity on specified EffManagedVersion and returns the set of all pending effectivities on that specified EffManagedVersion. This API also supports custom pending effectivity types.

      Supported API: true
      Parameters:
      EffManagedVersion - target - It is the target to modify the Pending effectivities
      Map - <ClientEffGroup, ClientEffGroup> originalToModifedPendingEffGroupMap - It is the map of original ClientEffGroup and modified ClientEffGroup to modify Pending effectivities Each clientEffGroup must specify below attributes: 1. effContextReference - optional for Date effectivities, but mandatory for Pending Serial, Lot, Block and MSN. This Specifies effectivity Context. 2. effFormClass - mandatory. This specifies the type of Effectivity. Below are the values for respective effectivity types: a. DateEffForm for Pending Date effectivity b. BlockEffForm for Pending Block effectivity c. LotEffForm for Pending Lot Effectivity d. MSNEffForm for Pending MSN Effectivity e. SerialEffForm for Pending Serial Effectivity 3. range - mandatory. This specifies the start and end range. The start and end range value needs to be specified in format Based on the configured start and end range separator. OOTB the separator is DASH "-" 4. effTypeModifier - optional. This specifies the Effectivity Qualifier. 5. linkReference - mandatory. This specifies the Change Record Link for locating pending effectivity. 6. propagateDown - optional. This specifies whether to propagate through effectivity strcuture. This can only be specified when Structure propagation preference is turned on. 7. stopAtTraceable - This specified whether to stop progataion at lower-level traceable objects. This can only be specified when Structure propagation preference is turned on. 8. attrMap - not required for OOTB effectivites but might be required for custom effectivities defining their additional attributes. For custom effectivities some attribute might be mandatory or optional depending on how custom effectivities are defined. Note: Make sure to specify the all the values for attributes that need to remain unchanged as well as those that need to be modified.
      Returns:
      Set - Returns the set of all Pending effectivities on that target
      Throws:
      WTException

    • deletePendingEffectivities

      Set<PendingEff> deletePendingEffectivities(EffManagedVersion target, List<ClientEffGroup> listDeletePendingEffGroups) throws WTException
      Deletes Pending Effectivity on specified EffManagedVersion and returns the set of all remaining pending effectivities after deletion on that specified EffManagedVersion. This API also supports custom pending effectivity types.

      Supported API: true
      Parameters:
      EffManagedVersion - target - It is the target to delete the pending effectivities
      List - listDeletePendingEffGroups - It is the list of clientEffGroups for deleting pending effectivities Each clientEffGroup must specify below attributes: 1. effContextReference - optional for Date effectivities, but mandatory for Pending Serial, Lot, Block and MSN. This Specifies effectivity Context. 2. effFormClass - mandatory. This specifies the type of Effectivity. Below are the values for respective effectivity types: a. DateEffForm for Pending Date effectivity b. BlockEffForm for Pending Block effectivity c. LotEffForm for Pending Lot Effectivity d. MSNEffForm for Pending MSN Effectivity e. SerialEffForm for Pending Serial Effectivity 3. range - mandatory. This specifies the start and end range. The start and end range value needs to be specified in format Based on the configured start and end range separator. OOTB the separator is DASH "-" 4. effTypeModifier - optional. This specifies the Effectivity Qualifier. 5. linkReference - mandatory. This specifies the Change Record Link for locating pending effectivity. 6. propagateDown - optional. This specifies whether to propagate through effectivity strcuture. This can only be specified when Structure propagation preference is turned on. 7. stopAtTraceable - This specified whether to stop progataion at lower-level traceable objects. This can only be specified when Structure propagation preference is turned on. 8. attrMap - not required for OOTB effectivites but might be required for custom effectivities defining their additional attributes. For custom effectivities some attribute might be mandatory or optional depending on how custom effectivities are defined.
      Returns:
      Set - Returns the set of all remaining Pending effectivities after deletion on that target
      Throws:
      WTException

    • getPendingEffectivities

      Set<PendingEff> getPendingEffectivities(EffManagedVersion effManaged) throws WTException
      For a given EffManagedVersion object, returns a set of all Pending effectivities assigned to the effManaged object. It does not include factually deleted (i.e., historical) Effectivity records.

      Supported API: true
      Parameters:
      effManaged -
      Returns:
      Set
      Throws:
      WTException

    • createVarianceEffectivities

      Set<VarianceEff> createVarianceEffectivities(EffManagedVersion target, List<ClientEffGroup> listNewVarianceEffGroups) throws WTException
      Creates Variance Effectivities on specified EffRecordable and returns the set of all effectivities on that specified EffManagedVersion. This API also supports custom variance effectivity types.

      Supported API: true
      Parameters:
      EffManagedVersion - target - It is the target to create the variance effectivities
      List - setOfVarianceEffGroups - It is the list of clientEffGroups for creating variance effectivities. Each clientEffGroup must specify below attributes: 1. effContextReference - optional for Date effectivities, but mandatory for Serial, Lot, Block and MSN. This Specifies effectivity Context. 2. effFormClass - mandatory. This specifies the type of Effectivity. Below are the values for respective effectivity types: a. DateEffForm for Date effectivity b. BlockEffForm for Block effectivity c. LotEffForm for Lot Effectivity d. MSNEffForm for MSN Effectivity e. SerialEffForm for Serial Effectivity 3. range - mandatory. This specifies the start and end range. The start and end range value needs to be specified in format Based on the configured start and end range separator. OOTB the separator is DASH "-" 4. effTypeModifier - optional. This specifies the Effectivity Qualifier. 5. linkReference - mandatory. This specifies the Reported Against Link for locating variance effectivity. 6. attrMap - not required for OOTB effectivites but might be required for custom effectivities defining their additional attributes. For custom effectivities some attribute might be mandatory or optional depending on how custom effectivities are defined.
      Returns:
      Set - Returns the set of all variance effectivities on that target
      Throws:
      WTException

    • modifyVarianceEffectivities

      Set<VarianceEff> modifyVarianceEffectivities(EffManagedVersion target, Map<ClientEffGroup,ClientEffGroup> originalToModifedVarianceEffGroupMap) throws WTException
      Modifies Variance Effectivity on specified EffManagedVersion and returns the set of all variance effectivities on that specified EffManagedVersion. This API also supports custom variance effectivity types.

      Supported API: true
      Parameters:
      EffManagedVersion - target - It is the target to modify the Variance effectivities
      Map - <ClientEffGroup, ClientEffGroup> originalToModifedVarianceEffGroupMap - It is the map of original ClientEffGroup and modified ClientEffGroup to modify Variance effectivities Each clientEffGroup must specify below attributes: 1. effContextReference - optional for Date effectivities, but mandatory for Variance Serial, Lot, Block and MSN. This Specifies effectivity Context. 2. effFormClass - mandatory. This specifies the type of Effectivity. Below are the values for respective effectivity types: a. DateEffForm for Variance Date effectivity b. BlockEffForm for Variance Block effectivity c. LotEffForm for Variance Lot Effectivity d. MSNEffForm for Variance MSN Effectivity e. SerialEffForm for Variance Serial Effectivity 3. range - mandatory. This specifies the start and end range. The start and end range value needs to be specified in format Based on the configured start and end range separator. OOTB the separator is DASH "-" 4. effTypeModifier - optional. This specifies the Effectivity Qualifier. 5. linkReference - mandatory. This specifies the Reported Against Link for locating variance effectivity. 6. attrMap - not required for OOTB effectivites but might be required for custom effectivities defining their additional attributes. For custom effectivities some attribute might be mandatory or optional depending on how custom effectivities are defined. Note: Make sure to specify the all the values for attributes that need to remain unchanged as well as those that need to be modified.
      Returns:
      Set - Returns the set of all Variance effectivities on that target
      Throws:
      WTException

    • deleteVarianceEffectivities

      Set<VarianceEff> deleteVarianceEffectivities(EffManagedVersion target, List<ClientEffGroup> listDeleteVarianceEffGroups) throws WTException
      Deletes Variance Effectivity on specified EffManagedVersion and returns the set of all remaining variance effectivities after deletion on that specified EffManagedVersion. This API also supports custom variance effectivity types.

      Supported API: true
      Parameters:
      EffManagedVersion - target - It is the target to delete the variance effectivities
      List - listDeleteVarianceEffGroups - It is the list of clientEffGroups for deleting variance effectivities Each clientEffGroup must specify below attributes: 1. effContextReference - optional for Date effectivities, but mandatory for Variance Serial, Lot, Block and MSN. This Specifies effectivity Context. 2. effFormClass - mandatory. This specifies the type of Effectivity. Below are the values for respective effectivity types: a. DateEffForm for Variance Date effectivity b. BlockEffForm for Variance Block effectivity c. LotEffForm for Variance Lot Effectivity d. MSNEffForm for Variance MSN Effectivity e. SerialEffForm for Variance Serial Effectivity 3. range - mandatory. This specifies the start and end range. The start and end range value needs to be specified in format Based on the configured start and end range separator. OOTB the separator is DASH "-" 4. effTypeModifier - optional. This specifies the Effectivity Qualifier. 5. linkReference - mandatory. This specifies the Reported Against Link for locating variance effectivity. 6. attrMap - not required for OOTB effectivites but might be required for custom effectivities defining their additional attributes. For custom effectivities some attribute might be mandatory or optional depending on how custom effectivities are defined.
      Returns:
      Set - Returns the set of all remaining Variance effectivities after deletion on that target
      Throws:
      WTException

    • getVarianceEffectivities

      Set<VarianceEff> getVarianceEffectivities(EffManagedVersion effManaged) throws WTException
      For a given EffManagedVersion object, returns a set of all Variance effectivities assigned to the effManaged object.

      Supported API: true
      Parameters:
      effManaged -
      Returns:
      Set
      Throws:
      WTException