Package wt.change2

Interface ChangeService2


@RemoteInterface public interface ChangeService2
The interface describing the services available for the change2 package.

Supported API: true

Extendable: false
See Also:
  • Method Details

    • deleteAffectedActivityData

      AffectedActivityData deleteAffectedActivityData(AffectedActivityData aad) throws WTException, ChangeException2
      Delete the AffectedActivityData relationship only. The ChangeActivityIfc object and Changeable2 object that the AffectedActivityData relationship links together will still both exist after the relationship is deleted.

      Supported API: true
      Parameters:
      aad -
      Returns:
      AffectedActivityData
      Throws:
      WTException
      ChangeException2
      See Also:
    • deleteAnalysisActivity

      Deletes the concrete subclass of AnalysisActivityIfc from the database. The associated (or relevant) DetailedByIfc concrete associations will be deleted by the Persistence Manager and all related change objects will be deleted by listeners on ChangeService2, with the exception of related ChangeAnalysisIfc (ChangeInvestigationIfc or ChangeProposalIfc) objects. This method should be called rather than calling the Persistence Manager delete method directly.

      Supported API: true
      Parameters:
      aa -
      Returns:
      AnalysisActivityIfc
      Throws:
      ChangeException2
      WTException
    • deleteChangeActivity

      Deletes the concrete subclass of ChangeActivityIfc from the database. The associated (or relevant) IncludedInIfc concrete associations will be deleted by the Persistence Manager and all related change objects will be deleted by listeners on ChangeService2, with the exception of related ChangeOrderIfc objects. This method should be called rather than calling the Persistence Manager delete method directly.

      Supported API: true
      Parameters:
      ca -
      Returns:
      ChangeActivityIfc
      Throws:
      ChangeException2
      WTException
    • deleteChangeInvestigation

      Deletes the concrete subclass of ChangeInvestigationIfc from the database. The associated (or relevant) ResearchedByIfc concrete associations will be deleted by the Persistence Manager and all related change objects will be deleted by listeners on ChangeService2, with the exception of related ChangeRequestIfc objects. This method should be called rather than calling the Persistence Manager delete method directly.

      Supported API: true
      Parameters:
      ci -
      Returns:
      ChangeInvestigationIfc
      Throws:
      ChangeException2
      WTException
    • deleteChangeIssue

      Deletes the concrete subclass of ChangeIssueIfc from the database. The associated (or relevant) FormalizedByIfc concrete associations will be deleted by the Persistence Manager and all related change objects will be deleted by listeners on ChangeService2, with the exception of related ChangeRequestIfc objects. This method should be called rather than calling the Persistence Manager delete method directly.

      Supported API: true
      Parameters:
      ci -
      Returns:
      ChangeIssueIfc
      Throws:
      ChangeException2
      WTException
    • deleteChangeOrder

      Deletes the concrete subclass of ChangeOrderIfc from the database. The associated (or relevant) AddressedByIfc concrete associations will be deleted by the Persistence Manager and all related change objects will be deleted by listeners on ChangeService2, with the exception of related ChangeRequestIfc objects. This method should be called rather than calling the Persistence Manager delete method directly.

      Supported API: true
      Parameters:
      co -
      Returns:
      ChangeOrderIfc
      Throws:
      ChangeException2
      WTException
    • deleteChangeProposal

      Deletes the concrete subclass of ChangeProposalIfc from the database. The associated (or relevant) ResearchedByIfc concrete associations will be deleted by the Persistence Manager and all related change objects will be deleted by listeners on ChangeService2, with the exception of related ChangeRequestIfc objects. This method should be called rather than calling the Persistence Manager delete method directly.

      Supported API: true
      Parameters:
      cp -
      Returns:
      ChangeProposalIfc
      Throws:
      ChangeException2
      WTException
    • deleteChangeRecord

      ChangeRecord2 deleteChangeRecord(ChangeRecord2 cr) throws WTException, ChangeException2
      Delete the ChangeRecord2 relationship only. The ChangeActivityIfc object and Changeable2 object that the ChangeRecord2 relationship links together will still both exist after the relationship is deleted.

      Supported API: true
      Parameters:
      cr -
      Returns:
      ChangeRecord2
      Throws:
      WTException
      ChangeException2
      See Also:
    • deleteChangeRequest

      Deletes the concrete subclass of ChangeRequestIfc from the database. The associated (or relevant) FormalizedByIfc concrete associations will be deleted by the Persistence Manager and all related change objects will be deleted by listeners on ChangeService2, with the exception of related ChangeIssueIfc objects. This method should be called rather than calling the Persistence Manager delete method directly.

      Supported API: true
      Parameters:
      cr -
      Returns:
      ChangeRequestIfc
      Throws:
      WTException
      ChangeException2
    • deleteRelevantAnalysisData

      RelevantAnalysisData deleteRelevantAnalysisData(RelevantAnalysisData rad) throws WTException, ChangeException2
      Delete the RelevantAnalysisData relationship only. The AnalysisActivityIfc object and Changeable2 object that the RelevantAnalysisData relationship links together will still both exist after the relationship is deleted.

      Supported API: true
      Parameters:
      rad -
      Returns:
      RelevantAnalysisData
      Throws:
      WTException
      ChangeException2
      See Also:
    • deleteChangeReview

      Deletes the concrete subclass of ChangeReviewIfc from the database. The associated (or relevant) ChangeReviewItemLinkIfc concrete associations will be deleted by the Persistence Manager. This method should be called rather than calling the Persistence Manager delete method directly.

      Supported API: true
      Parameters:
      cr -
      Returns:
      ChangeReviewIfc
      Throws:
      ChangeException2
      WTException
    • getAffectingChangeActivities

      QueryResult getAffectingChangeActivities(Changeable2 changeable, boolean onlyChangeActivities) throws ChangeException2, WTException
      Returns a QueryResult of ChangeActivity2 objects related to the given Changeable2 object by the AffectedActivityData association. These Changeable2 objects represent revisions that need to be changed as part of the change process If onlyChangeActivities is true, the QueryResult returned contains a set of ChangeActivity2 objects.

      If onyChangeActivities is false, the QueryResult returned contains a set of AffectedActivityData link objects that have references to the Changeable objects.

      Supported API: true

      Parameters:
      changeable -
      onlyChangeActivities -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
      See Also:
    • getAffectingChangeActivities

      QueryResult getAffectingChangeActivities(Changeable2 changeable) throws ChangeException2, WTException
      Returns a QueryResult of ChangeActivity2 objects related to the given Changeable2 object by the AffectedActivityData association. These Changeable2 objects represent revisions that need to be changed as part of the change process.

      Supported API: true
      Parameters:
      changeable -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
      See Also:
    • getAnalysisActivities

      QueryResult getAnalysisActivities(Changeable2 changeable, boolean onlyAnalysisActivities) throws ChangeException2, WTException
      Retrieves the AnalysisActivity objects related to the given Changeable2 object by the RelevantAnalysisData association. These Changeable2 objects represent revisions that are important for the completion of a particular AnalysisActivity. If onlyAnalysisActivities is true, the QueryResult returned contains a set of AnalysisActivity objects.

      If onlyAnalysisActivities is false, the QueryResult returned contains a set of RelevantAnalysisData link objects that have references to the Changeable objects.

      Supported API: true

      Parameters:
      changeable -
      onlyAnalysisActivities -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
      See Also:
    • getAnalysisActivities

      QueryResult getAnalysisActivities(Changeable2 changeable) throws ChangeException2, WTException
      Retrieves the AnalysisActivity objects related to the given Changeable2 object by the RelevantAnalysisData association. These Changeable2 objects represent revisions that are important for the completion of a particular AnalysisActivity.

      Supported API: true
      Parameters:
      changeable -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
      See Also:
    • getAnalysisActivities

      QueryResult getAnalysisActivities(ChangeAnalysisIfc ca) throws WTException, ChangeException2
      Retrieves the AnalysisActivityIfc objects related to the given ChangeAnalysisIfc object by the DetailedByIfc association. These AnalysisActivityIfc objects represent activies that part of the particular ChangeAnalysisIfc. The QueryResult returned contains a set of AnalysisActivityIfc objects, not a set of DetailedByIfc link objects that have references to the ChangeAnalysisIfc objects. Use the two parameter version of this method to return the DetailedByIfc link objects.

      Supported API: true
      Parameters:
      ca -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getAnalysisActivities

      QueryResult getAnalysisActivities(ChangeAnalysisIfc ca, boolean onlyAnalysisActivities) throws WTException, ChangeException2
      Retrieves the AnalysisActivityIfc objects related to the given ChangeAnalysisIfc object by the DetailedByIfc association. These AnalysisActivityIfc objects represent investigations that are important for the completion of a particular ChangeAnalysisIfc. If onlyAnalysisActivities is true, the QueryResult returned contains a set of AnalysisActivityIfc objects.

      If onlyAnalysisActivities is false, the QueryResult returned contains a set of DetailedByIfc link objects that have references to the AnalysisActivityIfc objects.

      Supported API: true

      Parameters:
      ca -
      onlyAnalysisActivities -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeables

      Retrieves the Changeable2 objects related to the given AnalysisActivityIfc object by the ResearchedByIfc association. These Changeable2 objects represent changeables that are relevant to the completion of a particular AnalysisActivityIfc. The QueryResult returned contains a set of Changeable2 objects, not a set of RelevantAnalysisData link objects that have references to the Changeable2 objects. There is another method that contains the RelevantAnalysisData link objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true
      Parameters:
      aa -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeables

      QueryResult getChangeables(AnalysisActivityIfc aa, boolean onlyChangeables) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given AnalysisActivityIfc object by the RelevantAnalysisData association. These Changeable2 objects represent investigations that are important for the completion of a particular AnalysisActivityIfc. If onlyChangeables is true, the QueryResult returned contains a set of Changeable2 objects.

      If onlyChangeables is false, the QueryResult returned contains a set of RelevantAnalysisData link objects that have references to the Changeable2 objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true

      Parameters:
      aa -
      onlyChangeables -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeables

      Retrieves the Changeable2 objects related to the given ChangeRequestIfc object by the RelevantRequestDataIfc association. These Changeable2 objects represent additional documentation for the Change Request. The QueryResult returned contains a set of Changeable2 objects, not a set of RelevantAnalysisData link objects that have references to the Changeable2 objects. There is another method that contains the RelevantAnalysisData link objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true
      Parameters:
      cr -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeables

      QueryResult getChangeables(ChangeRequestIfc cr, boolean onlyChangeables) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given ChangeRequestIfc object by the RelevantRequestDataIfc association. These Changeable2 objects represent additional documentation for the Change Request. If onlyChangeables is true, the QueryResult returned contains a set of Changeable2 objects.

      If onlyChangeables is false, the QueryResult returned contains a set of RelevantRequestDataIfc link objects that have references to the Changeable2 objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true

      Parameters:
      cr -
      onlyChangeables -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeablesAfter

      QueryResult getChangeablesAfter(ChangeActivityIfc ca) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given ChangeActivityIfc object by the ChangeRecord2 association. These Changeable2 objects represent changeables that have been changed to implement the ChangeActivityIfc. The changeables returned are only the latest iterations (wt.vc.VersionControlHelper.getSearchCondition is used to do this) and then only the items that the user is allowed to see are returned (wt.vc.config.MultipleLatestConfigSpec.process is used to do this). The QueryResult returned contains a set of Changeable2 objects, not a set of ChangeRecord2 link objects that have references to the Changeable2 objects. There is another method that contains the ChangeRecord2 link objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true
      Parameters:
      ca -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeablesAfter

      QueryResult getChangeablesAfter(ChangeActivityIfc ca, boolean onlyChangeables) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given ChangeActivityIfc object by the ChangeRecord2 association. These Changeable2 objects represent changeables that have been changed to implement the ChangeActivityIfc. The changeables returned are only the latest iterations (wt.vc.VersionControlHelper.getSearchCondition is used to do this) and then only the items that the user is allowed to see are returned (wt.vc.config.MultipleLatestConfigSpec.process is used to do this). If onlyChangeables is true, the QueryResult returned contains a set of Changeable2 objects.

      If onlyChangeables is false, the QueryResult returned contains a set of ChangeRecord2 link objects that have references to the Changeable2 objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true

      Parameters:
      ca -
      onlyChangeables -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeablesAfter

      QueryResult getChangeablesAfter(ChangeOrderIfc co) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given ChangeOrderIfc object through its IncludedInIfc association with its ChangeActivityIfc and then by their ChangeRecord2 associations. These Changeable2 objects represent changeables that have been affected by the implementation of the ChangeOrderIfc. The changeables returned are only the latest iterations (wt.vc.VersionControlHelper.getSearchCondition is used to do this) and then only the items that the user is allowed to see are returned (wt.vc.config.MultipleLatestConfigSpec.process is used to do this). The QueryResult returned contains a set of Changeable2 objects, not a set of ChangeRecord2 link objects that have references to the Changeable2 objects. There is another method that contains the ChangeRecord2 link objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true
      Parameters:
      co -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeablesAfter

      QueryResult getChangeablesAfter(ChangeOrderIfc co, boolean onlyChangeables) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given ChangeOrderIfc object through its IncludedInIfc associations with its ChangeActivityIfc object and then by their ChangeRecord2 associations. These Changeable2 objects represent changeables that have been changed to implement the ChangeOrderIfc. The changeables returned are only the latest iterations (wt.vc.VersionControlHelper.getSearchCondition is used to do this) and then only the items that the user is allowed to see are returned (wt.vc.config.MultipleLatestConfigSpec.process is used to do this). If onlyChangeables is true, the QueryResult returned contains a set of Changeable2 objects.

      If onlyChangeables is false, the QueryResult returned contains a set of ChangeRecord2 link objects that have references to the Changeable2 objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true

      Parameters:
      co -
      onlyChangeables -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeablesBefore

      QueryResult getChangeablesBefore(ChangeActivityIfc ca) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given ChangeActivityIfc object by the AffectedActivityData association. These Changeable2 objects represent changeables that may need to be changed for the completion of a particular ChangeActivityIfc. The QueryResult returned contains a set of Changeable2 objects, not a set of AffectedActivityData link objects that have references to the Changeable2 objects. There is another method that contains the AffectedActivityData link objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true
      Parameters:
      ca -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeablesBefore

      QueryResult getChangeablesBefore(ChangeActivityIfc ca, boolean onlyChangeables) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given ChangeActivityIfc object by the AffectedActivityData association. These Changeable2 objects represent changeables that are may need to be changed for the completion of a particular ChangeActivityIfc. If onlyChangeables is true, the QueryResult returned contains a set of Changeable2 objects.

      If onlyChangeables is false, the QueryResult returned contains a set of AffectedActivityData link objects that have references to the Changeable2 objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true

      Parameters:
      ca -
      onlyChangeables -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeablesBefore

      QueryResult getChangeablesBefore(ChangeOrderIfc co) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given ChangeOrderIfc object through the IncludedInIfc association with each of its ChangeActivityIfc objects and then by their AffectedActivityData association. These Changeable2 objects represent changeables that may be affected by the completion of a particular ChangeOrderIfc. The QueryResult returned contains a set of Changeable2 objects, not a set of AffectedActivityData link objects that have references to the Changeable2 objects. There is another method that contains the AffectedActivityData link objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true
      Parameters:
      co -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeablesBefore

      QueryResult getChangeablesBefore(ChangeOrderIfc co, boolean onlyChangeables) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given ChangeOrderIfc object through the IncludedInIfc association of each of its ChangeActivityIfc object and then by their AffectedActivityData associations. These Changeable2 objects represent changeables that are may be affected by the completion of a particular ChangeOrderIfc. If onlyChangeables is true, the QueryResult returned contains a set of Changeable2 objects.

      If onlyChangeables is false, the QueryResult returned contains a set of AffectedActivityData link objects that have references to the Changeable2 objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true

      Parameters:
      co -
      onlyChangeables -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeablesBefore

      WTCollection getChangeablesBefore(WTKeyedMap taskToResultingObjsMap, boolean onlyChangeables) throws WTException
      Given the map of change task keys and collection of resulting object values, returns either the affected objects or affected object links that have the same change task and master reference. If onlyChangeables is true then returns affected objects.

      Supported API: true
      Parameters:
      taskToResultingObjectMap - expected key is a change task and value is a collection of resulting objects.
      onlyChangeables -
      Returns:
      a collection of affected links or affected objects
      Throws:
      WTException
    • getChangeActivities

      QueryResult getChangeActivities(ChangeOrderIfc co) throws WTException, ChangeException2
      Retrieves the ChangeActivityIfc objects related to the given ChangeOrderIfc object by the IncludedInIfc association. These ChangeActivityIfc objects represent activies that part of the particular ChangeOrderIfc The QueryResult returned contains a set of ChangeActivityIfc objects, not a set of IncludedInIfc link objects that have references to the ChangeOrderIfc objects. Use the two parameter version of this method to return the IncludedInIfc link objects.

      Supported API: true
      Parameters:
      co -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeActivities

      QueryResult getChangeActivities(ChangeOrderIfc co, boolean onlyChangeActivities) throws WTException, ChangeException2
      Retrieves the ChangeActivityIfc objects related to the given ChangeOrderIfc object by the IncludedInIfc association. These ChangeActivityIfc objects represent investigations that are important for the completion of a particular ChangeOrderIfc. If onlyChangeActivities is true, the QueryResult returned contains a set of ChangeActivityIfc objects.

      If onlyChangeActivities is false, the QueryResult returned contains a set of IncludedInIfc link objects that have references to the ChangeActivityIfc objects.

      Supported API: true

      Parameters:
      co -
      onlyChangeActivities -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeInvestigations

      QueryResult getChangeInvestigations(ChangeRequestIfc cr) throws WTException, ChangeException2
      Retrieves the ChangeInvestigationIfc objects related to the given ChangeRequestIfc object by the ResearchedByIfc association. These ChangeInvestigationIfc objects represent investigations that are important for the completion of a particular ChangeRequestIfc. The QueryResult returned contains a set of ChangeInvestigationIfc objects, not a set of ResearchedByIfc link objects that have references to the ChangeRequestIfc objects. Use the two parameter version of this method to return the ResearchedByIfc link objects.

      Supported API: true
      Parameters:
      cr -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeInvestigations

      QueryResult getChangeInvestigations(ChangeRequestIfc cr, boolean onlyChangeInvestigations) throws WTException, ChangeException2
      Retrieves the ChangeInvestigationIfc objects related to the given ChangeRequestIfc object by the ResearchedByIfc association. These ChangeInvestigationIfc objects represent investigations that are important for the completion of a particular ChangeRequestIfc. If onlyChangeRequests is true, the QueryResult returned contains a set of ChangeInvestigationIfc objects.

      If onlyChangeRequests is false, the QueryResult returned contains a set of ResearchedByIfc link objects that have references to the ChangeInvestigationIfc objects.

      Supported API: true

      Parameters:
      cr -
      onlyChangeInvestigations -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeIssues

      Retrieves the ChangeIssueIfc objects related to the given ChangeRequestIfc object by the FormalizedByIfc association. These ChangeIssueIfc objects represent issues that will formally be addressed by the particular ChangeRequestIfc. If the given ChangeRequestIfc is a flexible change object, then it will invoke the FlexibleChangeService and return the related flexible process associations. The QueryResult returned contains a set of ChangeIssueIfc objects, not a set of FormalizedByIfc link objects that have references to the ChangeRequestIfc objects. Use the two parameter version of this method to return the FormalizedByIfc link objects.

      Supported API: true
      Parameters:
      cr -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeIssues

      QueryResult getChangeIssues(ChangeActivityIfc changeActivity) throws WTException, ChangeException2
      Retrieves all versions of ChangeIssueIfc objects related to the provided version of the ChangeActivityIfc object by the IssueImplementedByIfc association. These ChangeIssueIfc objects represent issues that will be implemented by the particular ChangeActivityIfc. The QueryResult returned contains a set of ChangeIssueIfc objects.

      Supported API: true
      Parameters:
      changeActivity -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeIssues

      QueryResult getChangeIssues(ChangeRequestIfc cr, boolean onlyChangeIssues) throws WTException, ChangeException2
      Retrieves the ChangeIssueIfc objects related to the given ChangeRequestIfc object by the FormalizedByIfc association. These ChangeIssueIfc objects represent investigations that are important for the completion of a particular ChangeRequestIfc. If the given ChangeRequestIfc is a flexible change object, then it will invoke the FlexibleChangeService and return the related flexible process associations. If onlyChangeIssues is true, the QueryResult returned contains a set of ChangeIssueIfc objects.

      If onlyChangeIssues is false, the QueryResult returned contains a set of FormalizedByIfc link objects that have references to the ChangeIssueIfc objects.

      Supported API: true

      Parameters:
      cr -
      onlyChangeIssues -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeOrders

      Retrieves the ChangeOrderIfc objects related to the given ChangeRequestIfc object by the AddressedByIfc association. These ChangeOrderIfc objects represent orders that will implement the particular ChangeRequestIfc. If the given ChangeRequestIfc is a flexible change object, then it will invoke the FlexibleChangeService and return the related flexible process associations. The QueryResult returned contains a set of ChangeOrderIfc objects, not a set of AddressedByIfc link objects that have references to the ChangeRequestIfc objects. Use the two parameter version of this method to return the AddressedByIfc link objects.

      Supported API: true
      Parameters:
      cr -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeOrders

      QueryResult getChangeOrders(ChangeRequestIfc cr, boolean onlyChangeOrders) throws WTException, ChangeException2
      Retrieves the ChangeOrderIfc objects related to the given ChangeRequestIfc object by the AddressedByIfc association. These ChangeOrderIfc objects represent investigations that implement the completion of a particular ChangeRequestIfc. If the given ChangeRequestIfc is a flexible change object, then it will invoke the FlexibleChangeService and return the related flexible process associations. If onlyChangeOrders is true, the QueryResult returned contains a set of ChangeOrderIfc objects.

      If onlyChangeOrders is false, the QueryResult returned contains a set of AddressedByIfc link objects that have references to the ChangeOrderIfc objects.

      Supported API: true

      Parameters:
      cr -
      onlyChangeOrders -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeOrders

      QueryResult getChangeOrders(ChangeIssueIfc changeIssue) throws WTException, ChangeException2
      Retrieves all versions of ChangeOrderIfc objects related to the provided version of the ChangeIssueIfc object by the IssueImplementedByIfc association. The QueryResult returned contains a set of ChangeOrderIfc objects.

      Supported API: true
      Parameters:
      changeIssue -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeProposals

      QueryResult getChangeProposals(ChangeRequestIfc cr) throws WTException, ChangeException2
      Retrieves the ChangeProposalIfc objects related to the given ChangeRequestIfc object by the ResearchedByIfc association. These ChangeProposalIfc objects represent proposals that are proposed for the completion of a particular ChangeRequestIfc. The QueryResult returned contains a set of ChangeProposalIfc objects, not a set of ResearchedByIfc link objects that have references to the ChangeRequestIfc objects. Use the two parameter version of this method to return the ResearchedByIfc link objects.

      Supported API: true
      Parameters:
      cr -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeProposals

      QueryResult getChangeProposals(ChangeRequestIfc cr, boolean onlyChangeProposals) throws WTException, ChangeException2
      Retrieves the ChangeProposalIfc objects related to the given ChangeRequestIfc object by the ResearchedByIfc association. These ChangeProposalIfc objects represent investigations that are important for the completion of a particular ChangeRequestIfc. If onlyChangeProposals is true, the QueryResult returned contains a set of ChangeProposalIfc objects.

      If onlyChangeProposals is false, the QueryResult returned contains a set of ResearchedByIfc link objects that have references to the ChangeProposalIfc objects.

      Supported API: true

      Parameters:
      cr -
      onlyChangeProposals -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getFormalizingChangeRequest

      ChangeRequest2 getFormalizingChangeRequest(ChangeIssue ci) throws ChangeException2, WTException
      Retrieves the ChangeRequest2 object that formalizes the given ChangeIssue object. If the given ChangeIssue is a flexible change object, then it will invoke the FlexibleChangeService and return the related flexible process associations.

      Supported API: true
      Parameters:
      ci -
      Returns:
      ChangeRequest2
      Throws:
      ChangeException2
      WTException
      See Also:
    • getImplementedChangeActivities

      QueryResult getImplementedChangeActivities(Changeable2 changeable) throws ChangeException2, WTException
      Returns a QueryResult of ChangeActivity2 objects related to the given Changeable2 object by the ChangeRecord2 association. These Changeable2 objects represent revisions that have been changed as part of the change process

      Supported API: true
      Parameters:
      changeable -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
      See Also:
    • getImplementedChangeActivities

      QueryResult getImplementedChangeActivities(Changeable2 changeable, boolean onlyChangeActivities) throws ChangeException2, WTException
      Returns a QueryResult of ChangeActivity2 objects related to the given Changeable2 object by the ChangeRecord2 association. These Changeable2 objects represent revisions that have been changed as part of the change process If onlyChangeActivities is true, the QueryResult returned contains a set of ChangeActivity2 objects.

      If onlyChangeActivities is false, the QueryResult returned contains a set of ChangeRecord2 link objects that have references to the Changeable objects.

      Supported API: true

      Parameters:
      changeable -
      onlyChangeActivities -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
      See Also:
    • reviseChangeRequest

      ChangeRequestIfc reviseChangeRequest(ChangeRequestIfc cr, String versionLabel) throws WTException
      Creates a new version of the Change Request.

      Supported API: true
      Parameters:
      cr - The Change Request to revise
      versionLabel - The version label for this revision.
      Returns:
      ChangeRequestIfc
      Throws:
      WTException
    • reviseChangeRequest

      ChangeRequestIfc reviseChangeRequest(ChangeRequestIfc cr) throws WTException


      Supported API: true
      Parameters:
      cr -
      Returns:
      ChangeRequestIfc
      Throws:
      WTException
    • reviseChangeIssue

      ChangeIssueIfc reviseChangeIssue(ChangeIssueIfc ci, String versionLabel) throws WTException


      Supported API: true
      Parameters:
      ci -
      versionLabel -
      Returns:
      ChangeIssueIfc
      Throws:
      WTException
    • reviseChangeIssue

      ChangeIssueIfc reviseChangeIssue(ChangeIssueIfc ci) throws WTException


      Supported API: true
      Parameters:
      ci -
      Returns:
      ChangeIssueIfc
      Throws:
      WTException
    • reviseAnalysisActivity

      AnalysisActivityIfc reviseAnalysisActivity(AnalysisActivityIfc aa, String versionLabel) throws WTException


      Supported API: true
      Parameters:
      aa -
      versionLabel -
      Returns:
      AnalysisActivityIfc
      Throws:
      WTException
    • reviseAnalysisActivity

      AnalysisActivityIfc reviseAnalysisActivity(AnalysisActivityIfc aa) throws WTException


      Supported API: true
      Parameters:
      aa -
      Returns:
      AnalysisActivityIfc
      Throws:
      WTException
    • reviseChangeInvestigation

      ChangeInvestigationIfc reviseChangeInvestigation(ChangeInvestigationIfc ci, String versionLabel) throws WTException


      Supported API: true
      Parameters:
      ci -
      versionLabel -
      Returns:
      ChangeInvestigationIfc
      Throws:
      WTException
    • reviseChangeInvestigation

      ChangeInvestigationIfc reviseChangeInvestigation(ChangeInvestigationIfc ci) throws WTException


      Supported API: true
      Parameters:
      ci -
      Returns:
      ChangeInvestigationIfc
      Throws:
      WTException
    • reviseChangeOrderWithChangeActivities

      Map<ChangeOrderIfc,WTSet> reviseChangeOrderWithChangeActivities(ChangeOrderIfc changeOrder, String coRevLabel, WTKeyedMap changeActivities) throws WTException
      Will create a new version of the ChangeOrder and ChangeActivities that are passed in. All the change activities passed in will be revised. Revision of WTChangeActivity2 is supported only in context if revised with WTChangeOrder2. The passed change activities should be associated to the change order object. If the changeActivities collection is empty or null, only change order object will be revised

      Supported API: true
      Parameters:
      changeOrder - -Predecessor change notices
      coRevLabel - - Revision Label for the revised WTChangeOrder2 If the value is null, next revision label will be set on the object.
      changeActivities - - Predecessor change activities map. Key is the WTChangeActivity2 and value is the Revision Label. If the value is null, next revision label will be set on the object.
      Returns:
      Map containing key as revised change order and values with revised change activities
      Throws:
      WTException
    • reviseChangeOrder

      ChangeOrderIfc reviseChangeOrder(ChangeOrderIfc co, String versionLabel) throws WTException


      Supported API: true
      Parameters:
      co -
      versionLabel -
      Returns:
      ChangeOrderIfc
      Throws:
      WTException
    • reviseChangeOrder

      ChangeOrderIfc reviseChangeOrder(ChangeOrderIfc co) throws WTException


      Supported API: true
      Parameters:
      co -
      Returns:
      ChangeOrderIfc
      Throws:
      WTException
    • reviseChangeProposal

      ChangeProposalIfc reviseChangeProposal(ChangeProposalIfc cp, String versionLabel) throws WTException


      Supported API: true
      Parameters:
      cp -
      versionLabel -
      Returns:
      ChangeProposalIfc
      Throws:
      WTException
    • reviseChangeProposal

      ChangeProposalIfc reviseChangeProposal(ChangeProposalIfc cp) throws WTException


      Supported API: true
      Parameters:
      cp -
      Returns:
      ChangeProposalIfc
      Throws:
      WTException
    • saveAnalysisActivity

      Stores the given concrete subclass of AnalysisActivityIfc in the database and associates it to the given ChangeAnalysisIfc; the ChangeAnalysisIfc must be persistent already. If the AnalysisActivityIfc object is LifeCycleManaged, this method uses Change2DelegateFactory to get a ChooseLifeCycleDelegate to programatically assign the LifeCycle. If the ChangeAnalysistIfc object is Foldered, this method uses Change2DelegateFactory to get a ChooseFolderDelegate to programatically assign the Folder.

      Supported API: true
      Parameters:
      ca -
      aa -
      Returns:
      AnalysisActivityIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveChangeActivity

      Stores the given concrete subclass of ChangeActivityIfc in the database and associates it to the given ChangeOrderIfc; the ChangeOrderIfc must be persistent already. If the ChangeActivityIfc object is LifeCycleManaged, this method uses Change2DelegateFactory to get a ChooseLifeCycleDelegate to programatically assign the LifeCycle. If the ChangeActivityIfc object is Foldered, this method uses Change2DelegateFactory to get a ChooseFolderDelegate to programatically assign the Folder.

      Supported API: true
      Parameters:
      co -
      ca -
      Returns:
      ChangeActivityIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveChangeActivity

      ChangeActivityIfc saveChangeActivity(ChangeOrderIfc co, ChangeActivityIfc ca, boolean validate) throws ChangeException2, WTException
      Stores the given concrete subclass of ChangeActivityIfc in the database and associates it to the given ChangeOrderIfc; the ChangeOrderIfc must be persistent already. If the ChangeActivityIfc object is LifeCycleManaged, this method uses Change2DelegateFactory to get a ChooseLifeCycleDelegate to programatically assign the LifeCycle. If the ChangeActivityIfc object is Foldered, this method uses Change2DelegateFactory to get a ChooseFolderDelegate to programatically assign the Folder.

      The implementation plan association rules can be optionally evaluated using the validate parameter.

      Supported API: true
      Parameters:
      co -
      ca -
      validate - False to ignore association rule validation
      Returns:
      ChangeActivityIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveChangeInvestigation

      Stores the given concrete subclass of ChangeInvestigationIfc in the database and associates it to the given ChangeItemIfc; changeItem must be persistent already. If the ChangeInvestigationIfc object is LifeCycleManaged, this method uses Change2DelegateFactory to get a ChooseLifeCycleDelegate to programatically assign the LifeCycle. If the ChangeInvestigationIfc object is Foldered, this method uses Change2DelegateFactory to get a ChooseFolderDelegate to programatically assign the Folder. The changeItem needs to be a primary change object like ChangeIssue, ChangeOrder2 or ChangeRequest2 to get associated with ChangeInvestigation

      Supported API: true
      Parameters:
      changeItem -
      ci -
      Returns:
      ChangeInvestigationIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveChangeInvestigation

      Stores the given concrete subclass of ChangeInvestigationIfc in the database If the ChangeInvestigationIfc object is LifeCycleManaged, this method uses Change2DelegateFactory to get a ChooseLifeCycleDelegate to programatically assign the LifeCycle. If the ChangeInvestigationIfc object is Foldered, this method uses Change2DelegateFactory to get a ChooseFolderDelegate to programatically assign the Folder.

      Supported API: true
      Parameters:
      ci -
      Returns:
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveChangeIssue

      Stores the given concrete subclass of ChangeIssueIfc in the database. If the ChangeIssueIfc object is LifeCycleManaged, this method uses Change2DelegateFactory to get a ChooseLifeCycleDelegate to programatically assign the LifeCycle. If the ChangeIssueIfc object is Foldered, this method uses Change2DelegateFactory to get a ChooseFolderDelegate to programatically assign the Folder.

      Supported API: true
      Parameters:
      ci -
      Returns:
      ChangeIssueIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveChangeOrder

      Stores the given concrete subclass of ChangeOrderIfc in the database and associates it to the given ChangeRequestIfc; theChangeRequestIfc must be persistent already. If the ChangeOrderIfc object is LifeCycleManaged, this method uses Change2DelegateFactory to get a ChooseLifeCycleDelegate to programatically assign the LifeCycle. If the ChangeRequestIfc object is Foldered, this method uses Change2DelegateFactory to get a ChooseFolderDelegate to programatically assign the Folder.

      Supported API: true
      Parameters:
      cr -
      co -
      Returns:
      ChangeOrderIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveChangeOrder

      ChangeOrderIfc saveChangeOrder(ChangeRequestIfc cr, ChangeOrderIfc co, boolean validate) throws ChangeException2, WTException
      Stores the given concrete subclass of ChangeOrderIfc in the database and associates it to the given ChangeRequestIfc; theChangeRequestIfc must be persistent already. If the ChangeOrderIfc object is LifeCycleManaged, this method uses Change2DelegateFactory to get a ChooseLifeCycleDelegate to programatically assign the LifeCycle. If the ChangeRequestIfc object is Foldered, this method uses Change2DelegateFactory to get a ChooseFolderDelegate to programatically assign the Folder.

      Supported API: true
      Parameters:
      cr -
      co -
      validate - True to validate association rules
      Returns:
      ChangeOrderIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveChangeProposal

      Stores the given concrete subclass of ChangeProposalIfc in the database and associates it to the given ChangeRequestIfc; theChangeRequestIfc must be persistent already. If the theChangeRequestIfc object is LifeCycleManaged, this method uses Change2DelegateFactory to get a ChooseLifeCycleDelegate to programatically assign the LifeCycle. If the theChangeRequestIfc object is Foldered, this method uses Change2DelegateFactory to get a ChooseFolderDelegate to programatically assign the Folder.

      Supported API: true
      Parameters:
      cr -
      cp -
      Returns:
      ChangeProposalIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveChangeRequest

      Stores the given concrete subclass of ChangeRequestIfc in the database. If the object is LifeCycleManaged, this method uses Change2DelegateFactory to get a ChooseLifeCycleDelegate to programatically assign the LifeCycle.

      Supported API: true
      Parameters:
      cr -
      Returns:
      ChangeRequestIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveIssueImplementedBy

      WTCollection saveIssueImplementedBy(WTKeyedHashMap map) throws ChangeException2, WTException
      Save the collection of ChangeIssueIfc objects associated to the ChangeActivityIfc key in the WTKeyedSet where the key is the ChangeActivityIfc and the value is a WTSet of ChangeIssueIfc objects.

      Supported API: true
      Parameters:
      map - of change activities keys and collection of change issue values.
      Returns:
      a collection of persisted links
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveRelevantAnalysisData

      Vector saveRelevantAnalysisData(Vector radVector) throws ChangeException2, WTException
      Stores all the RelevantAnalysisData objects in the input vector and returns a vector of the persisted (or updated) RelevantAnalysisData objects.

      Supported API: true
      Parameters:
      radVector -
      Returns:
      Vector
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveAffectedActivityData

      Vector saveAffectedActivityData(Vector aadVector) throws ChangeException2, WTException
      Stores all the AffectedActivityData objects in the input vector and returns a vector of the persisted (or updated) AffectedActivityData objects.

      Supported API: true
      Parameters:
      aadVector -
      Returns:
      Vector
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveChangeRecord

      Vector saveChangeRecord(Vector crVector) throws ChangeException2, WTException
      Stores all the ChangeRecord2 objects in the input vector and returns a vector of the persisted (or updated) ChangeRecord2 objects.

      Supported API: true
      Parameters:
      crVector -
      Returns:
      Vector
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveChangeReview

      Stores the given concrete subclass of ChangeReviewIfc in the database. If the object is LifeCycleManaged, this method uses Change2DelegateFactory to get a ChooseLifeCycleDelegate to programatically assign the LifeCycle.

      Supported API: true
      Parameters:
      cr -
      Returns:
      ChangeReviewIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • getChangeRequest

      Retrieves the ChangeRequestIfc object related to the given ChangeIssueIfc object by the FormalizedByIfc association. These ChangeRequestIfc object represents the request that will formally address the particular ChangeIssueIfc. If the given ChangeIssueIfc is a flexible change object, then it will invoke the FlexibleChangeService and return the related flexible process associations. The QueryResult returned contains zero or one ChangeRequestIfc object, not zero or one FormalizedByIfc link object that has a reference to the ChangeRequestIfc object. There is another method that contains the FormalizedByIfc link object.

      Supported API: true
      Parameters:
      ci -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeRequest

      QueryResult getChangeRequest(ChangeIssueIfc ci, boolean onlyChangeRequest) throws WTException, ChangeException2
      Retrieves the ChangeRequestIfc object related to the given ChangeIssueIfc object by the FormalizedByIfc association. The ChangeRequestIfc object represents the request that formally address the ChangeRequestIfc. If the given ChangeIssueIfc is a flexible change object, then it will invoke the FlexibleChangeService and return the related flexible process associations. If onlyChangeRequest is true, the QueryResult returned contains zero or one ChangeRequest objects.

      If onlyChangeRequest is false, the QueryResult returned contains zero or one FormalizedByIfc link objects that has a reference to the ChangeRequestIfc object.

      Supported API: true

      Parameters:
      ci -
      onlyChangeRequest -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeRequest

      Retrieves the ChangeRequestIfc object related to the given ChangeAnalysisIfc object by the ResearchedByIfc association. These ChangeRequestIfc object represents the request for which the ChangeAnalysisIfc is performing . The QueryResult returned contains zero or one ChangeRequestIfc object, not zero or one ResearchedByIfc link object that has a reference to the ChangeRequestIfc object. There is another method that contains the ResearchedByIfc link object.

      Supported API: true
      Parameters:
      ca -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeRequest

      QueryResult getChangeRequest(ChangeAnalysisIfc ca, boolean onlyChangeRequest) throws WTException, ChangeException2
      Retrieves the ChangeRequestIfc object related to the given ChangeAnalysisIfc object by the ResearchedByIfc association. The ChangeRequestIfc object represents the request that formally address the ChangeRequestIfc. If onlyChangeRequest is true, the QueryResult returned contains zero or one ChangeRequest objects.

      If onlyChangeRequest is false, the QueryResult returned contains zero or one ResearchedByIfc link objects that has a reference to the ChangeRequestIfc object.

      Supported API: true

      Parameters:
      ca -
      onlyChangeRequest -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeRequest

      Retrieves the ChangeRequestIfc object related to the given ChangeOrderIfc object by the AddressedByIfc association. These ChangeRequestIfc object represents the request for which the ChangeOrderIfc is performing . The QueryResult returned contains zero or one ChangeRequestIfc object, not zero or one AddressedByIfc link object that has a reference to the ChangeRequestIfc object. There is another method that contains the AddressedByIfc link object.

      Supported API: true
      Parameters:
      co -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeRequest

      QueryResult getChangeRequest(ChangeOrderIfc co, boolean onlyChangeRequest) throws WTException, ChangeException2
      Retrieves the ChangeRequestIfc object related to the given ChangeOrderIfc object by the AddressedByIfc association. The ChangeRequestIfc object represents the request that is addressed by the ChangeOrderIfc. If onlyChangeRequest is true, the QueryResult returned contains zero or one ChangeRequest objects.

      If onlyChangeRequest is false, the QueryResult returned contains zero or one AddressedByIfc link objects that has a reference to the ChangeRequestIfc object.

      Supported API: true

      Parameters:
      co -
      onlyChangeRequest -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeAnalysis

      Retrieves the ChangeAnalysisIfc object related to the given AnalysisActivityIfc object by the DetailedByIfc association. These ChangeAnalysisIfc object represents the request for which the AnalysisActivityIfc is performing . The QueryResult returned contains zero or one ChangeAnalysisIfc object, not zero or one DetailedByIfc link object that has a reference to the ChangeAnalysisIfc object. There is another method that contains the DetailedByIfc link object.

      Supported API: true
      Parameters:
      aa -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeAnalysis

      QueryResult getChangeAnalysis(AnalysisActivityIfc aa, boolean onlyChangeAnalysis) throws WTException, ChangeException2
      Retrieves the ChangeAnalysisIfc object related to the given AnalysisActivityIfc object by the DetailedByIfc association. The ChangeAnalysisIfc object represents the request that is addressed by the AnalysisActivityIfc. If onlyChangeAnalysis is true, the QueryResult returned contains zero or one ChangeAnalysisIfc objects.

      If onlyChangeAnalysis is false, the QueryResult returned contains zero or one DetailedByIfc link objects that has a reference to the ChangeAnalysisIfc object.

      Supported API: true

      Parameters:
      aa -
      onlyChangeAnalysis -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeOrder

      Retrieves the ChangeOrderIfc object related to the given ChangeActivityIfc object by the IncludedInIfc association. These ChangeOrderIfc object represents the request for which the ChangeActivityIfc is performing . The QueryResult returned contains zero or one ChangeOrderIfc object, not zero or one IncludedInIfc link object that has a reference to the ChangeOrderIfc object. There is another method that contains the IncludedInIfc link object.

      Supported API: true
      Parameters:
      ca -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeOrder

      QueryResult getChangeOrder(ChangeActivityIfc ca, boolean onlyChangeActivity) throws WTException, ChangeException2
      Retrieves the ChangeOrderIfc object related to the given ChangeActivityIfc object by the IncludedInIfc association. The ChangeOrderIfc object represents the request that is addressed by the ChangeActivityIfc. If onlyChangeOrder is true, the QueryResult returned contains zero or one ChangeOrderIfc objects.

      If onlyChangeOrder is false, the QueryResult returned contains zero or one IncludedInIfc link objects that has a reference to the ChangeOrderIfc object.

      Supported API: true

      Parameters:
      ca -
      onlyChangeActivity -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangingChangeActivities

      @Deprecated QueryResult getChangingChangeActivities(Changeable2 changeable, boolean onlyChangeActivities) throws ChangeException2, WTException
      Returns a QueryResult of ChangeActivity2 objects related to the given Changeable2 object by the ChangeRecord2 association. These Changeable2 objects represent revisions that need to be changed as part of the change process If onlyChangeActivities is true, the QueryResult returned contains a set of ChangeActivity2 objects.

      If onyChangeActivities is false, the QueryResult returned contains a set of AffectedActivityData link objects that have references to the Changeable objects.

      Supported API: true

      Parameters:
      changeable -
      onlyChangeActivities -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
      See Also:
    • getChangingChangeActivities

      @Deprecated QueryResult getChangingChangeActivities(Changeable2 changeable) throws ChangeException2, WTException
      Returns a QueryResult of ChangeActivity2 objects related to the given Changeable2 object by the ChangeRecord2 association. These Changeable2 objects represent revisions that need to be changed as part of the change process

      Supported API: true
      Parameters:
      changeable -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
      See Also:
    • getChangeItem

      ChangeItem getChangeItem(Class theClass, long id) throws WTException, ChangeException2
      Retrieves the ChangeItem object that corresponds to the given Class and id. Uses ObjectIdentifier and PersistenceHelper.

      Supported API: true
      Parameters:
      theClass -
      id -
      Returns:
      ChangeItem
      Throws:
      WTException
      ChangeException2
    • storeAssociations

      Vector storeAssociations(Class theClass, ChangeItemIfc ci, Vector changeables) throws ChangeException2, WTException
      Creates and stores the correct association object type between the ChangeItemIfc object and the Changeable2 objects in the input vector and returns a vector of the persisted association objects.

      Supported API: true
      Parameters:
      theClass -
      ci -
      changeables -
      Returns:
      Vector
      Throws:
      ChangeException2
      WTException
    • storeAssociations

      WTCollection storeAssociations(ChangeItemIfc changeItem, WTCollection links) throws ChangeException2, WTException
      Stores the association objects for the given change item.

      Supported API: true
      Parameters:
      changeItem -
      links -
      Returns:
      collection of persisted links
      Throws:
      ChangeException2
      WTException
    • getChangeItem

      ChangeItem getChangeItem(String oid) throws WTException, ChangeException2
      Retrieves the ChangeItem object that corresponds to the given oid. Uses the ReferenceFactory.

      Supported API: true
      Parameters:
      oid -
      Returns:
      ChangeItem
      Throws:
      WTException
      ChangeException2
      See Also:
    • findChangeRequest

      ChangeRequestIfc findChangeRequest(Object theObject) throws WTException, ChangeException2
      Uses Change2DelegateFactory and FindChangeRequestDelegate mechanism to find the change request associated with the object passed in.

      Supported API: true
      Parameters:
      theObject -
      Returns:
      ChangeRequestIfc
      Throws:
      WTException
      ChangeException2
      See Also:
    • getRelevantChangeRequests

      QueryResult getRelevantChangeRequests(Changeable2 changeable, boolean onlyChangeRequests) throws ChangeException2, WTException
      Returns a QueryResult of ChangeRequest2 objects related to the given Changeable2 object by the RelevantRequestData2 association. This association links product data that the user considers relevant to the change request. If onlyChangeRequests is true, the QueryResult returned contains a set of ChangeActivity2 objects.

      If onlyChangeRequests is false, the QueryResult returned contains a set of RelevantRequestData2 link objects that have references to the Changeable2 object.

      Supported API: true

      Parameters:
      changeable -
      onlyChangeRequests -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
      See Also:
    • getRelevantChangeRequests

      QueryResult getRelevantChangeRequests(Changeable2 changeable) throws ChangeException2, WTException
      Returns a QueryResult of ChangeRequest2 objects related to the given Changeable2 object by the RelevantRequestData2 association. This association links product data that the user considers relevant to the change request.

      Supported API: true
      Parameters:
      changeable -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
      See Also:
    • unattachChangeable

      void unattachChangeable(Changeable2 refObject, ChangeItem changeItem, Class linkClass, String changeRole) throws ChangeException2, WTException
      Deletes the association between a ChangeItem and a Changeable2. Also removes the associated working copy if the Changeable2 is checked out.

      Supported API: true
      Parameters:
      refObject - A Changeable2 object to be disassociatd from a ChangeItem.
      changeItem - The ChangeItem associated to the Changeable2.
      linkClass - The associated link Class, which has a ChangeItem as role A.
      changeRole - The role name.
      Throws:
      ChangeException2
      WTException
    • getSubjectProducts

      QueryResult getSubjectProducts(ChangeRequestIfc cr, boolean onlyProducts) throws WTException, ChangeException2
      Retrieves the WTPartMaster objects related to the given ChangeRequestIfc object by the SubjectProductIfc association. These WTPartMaster objects represent additional documentation for the Change Request. The QueryResult returned contains a set of WTPartMaster objects, not a set of SubjectProduct link objects that have references to the WTPartMaster objects. There is another method that contains the SubjectProduct link objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true
      Parameters:
      cr -
      onlyProducts -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getSubjectProducts

      QueryResult getSubjectProducts(ChangeRequestIfc cr) throws WTException, ChangeException2
      Retrieves the WTPartMaster objects related to the given ChangeRequestIfc object by the SubjectProductIfc association. These WTPartMaster objects represent additional documentation for the Change Request. If onlyProducts is true, the QueryResult returned contains a set of WTPartMaster objects.

      If onlyProducts is false, the QueryResult returned contains a set of SubjectProductIfc link objects that have references to the WTPartMaster objects. Get the working copy if the current user was the one who checked it out, otherwise get the checked out copy.

      Supported API: true

      Parameters:
      cr -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • unattachProduct

      void unattachProduct(WTPartMaster refObject, ChangeItemIfc changeItem, Class linkClass, String changeRole) throws ChangeException2, WTException
      Deletes the association between a PartMaster and a ChangeRequest.

      Supported API: true
      Parameters:
      refObject - A Changeable2 object to be disassociatd from a ChangeItem.
      changeItem - The ChangeItem associated to the Changeable2.
      linkClass - The associated link Class, which has a ChangeItem as role A.
      changeRole - The role name.
      Throws:
      ChangeException2
      WTException
    • getChangeables

      QueryResult getChangeables(ChangeIssueIfc changeIssue) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given ChangeIssueIfc object by the ReportedAgainst association.

      Supported API: true
      Parameters:
      changeIssue -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
    • getChangeables

      QueryResult getChangeables(ChangeIssueIfc changeIssue, boolean onlyChangeables) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given ChangeIssueIfc object by the Reported Against association. If onlyChangeables is true, the QueryResult returned contains a set of Changeable2 objects.

      If onlyChangeables is false, the QueryResult returned contains a set of ReportedAgainst link objects that have references to the Changeable2 objects.

      Supported API: true

      Parameters:
      changeIssue -
      onlyChangeables -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
    • getProblemProducts

      QueryResult getProblemProducts(ChangeIssueIfc changeIssue, boolean onlyProducts) throws WTException, ChangeException2
      Retrieves the WTPartMaster objects related to the given ChangeIssueIfc object by the ProblemProduct association.

      Supported API: true
      Parameters:
      changeIssue -
      onlyProducts -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
    • getProblemProducts

      QueryResult getProblemProducts(ChangeIssueIfc changeIssue) throws WTException, ChangeException2
      Retrieves the WTPartMaster objects related to the given ChangeIssueIfc object by the ProblemProduct association.

      Supported API: true
      Parameters:
      changeIssue -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
    • getReportedAgainstChangeIssue

      QueryResult getReportedAgainstChangeIssue(Changeable2 changeable) throws WTException, ChangeException2
      Returns a QueryResult of ChangeIssues objects related to the given Changeable2 object by the ReportedAgainst association.

      Supported API: true
      Parameters:
      changeable -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
    • getUniqueImplementedChangeOrders

      QueryResult getUniqueImplementedChangeOrders(Changeable2 changeable) throws ChangeException2, WTException
      Returns a QueryResult of unique ChangeOrder2 objects that are indirectly related to the given Changeable2 object. This method obtains all ChangeActivity2 objects connected to the given Changeable2 via the ChangeRecord2 association, and then obtains all of the parent ChangeOrder2 objects via the IncludedIn2 association. Finally, the result is filtered to remove duplicates.

      Supported API: true
      Parameters:
      changeable -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
    • getUniqueAffectingChangeOrders

      QueryResult getUniqueAffectingChangeOrders(Changeable2 changeable) throws ChangeException2, WTException
      Returns a QueryResult of unique ChangeOrder2 objects that are indirectly related to the given Changeable2 object. This method obtains all ChangeActivity2 objects connected to the given Changeable2 via the AffectedActivityData association, and then obtains all of the parent ChangeOrder2 objects via the IncludedIn2 association. Finally, the result is filtered to remove duplicates.

      Supported API: true
      Parameters:
      changeable -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
    • saveResearchedBy

      Stores the given concrete subclass of ResearchedByIfc in the database. It constructs the ResearchedByIfc based on the ChangeRequestIfc and ChangeProposalIfc objects passed in, using the ResearchedByDelegate.

      Supported API: true
      Parameters:
      cr -
      cp -
      Returns:
      ResearchedByIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveResearchedBy

      ResearchedByIfc saveResearchedBy(ChangeItemIfc changeItem, ChangeAnalysisIfc changeAnalysis) throws ChangeException2, WTException
      Stores the given concrete subclass of ResearchedByIfc in the database. It constructs the ResearchedByIfc based on the ChangeItemIfc and ChangeAnalysisIfc objects passed in, using the ResearchedByDelegate. The ChangeItemIfc is intended to be used with primary change object like ChangeRequest2, ChangeOrder2 or ChangeIssue. *

      Supported API: true
      Parameters:
      changeItem -
      changeAnalysis -
      Returns:
      ResearchedByIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • getSupportingDispositionLinks

      WTKeyedMap getSupportingDispositionLinks(ChangeOrderIfc changeOrder) throws WTException
      Retrieves the links that for the "Affected Object" with dispositions set for the associated "Resulting Objects" of the given change notice. Returns a KeyedMap where the key is the "Resulting Objects" and the values are the "Affected Object" links (@see AffectedActivityData).

      Supported API: true
      Parameters:
      changeOrder - A change notice object
      Returns:
      WTKeyedMap
      Throws:
      WTException
    • saveChangeOrder

      Stores the given concrete subclass of ChangeOrderIfc in the database. If the ChangeOrderIfc object is LifeCycleManaged, this method uses Change2DelegateFactory to get a ChooseLifeCycleDelegate to programatically assign the LifeCycle.

      Supported API: true
      Parameters:
      co -
      Returns:
      ChangeOrderIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • saveChangeOrder

      ChangeOrderIfc saveChangeOrder(ChangeOrderIfc co, boolean validate) throws ChangeException2, WTException
      Stores the given concrete subclass of ChangeOrderIfc in the database. If the ChangeOrderIfc object is LifeCycleManaged, this method uses Change2DelegateFactory to get a ChooseLifeCycleDelegate to programatically assign the LifeCycle.

      Supported API: true
      Parameters:
      co -
      validate - True to validate association rules
      Returns:
      ChangeOrderIfc
      Throws:
      ChangeException2
      WTException
      See Also:
    • getChangeablesAfter

      WTList getChangeablesAfter(ChangeActivityIfc ca, WTList changeable2) throws WTException, ChangeException2
      Retrieves the ChangeRecord2 objects related to the given ChangeActivityIfc object and WTList of changeable2.

      Supported API: true
      Parameters:
      ca -
      changeable2 -
      Returns:
      WTList
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeables

      WTList getChangeables(ChangeIssueIfc changeIssue, WTList changeables) throws WTException, ChangeException2
      Retrieves the Reported Against links related to the given ChangeIssueIfc object by changeables.

      Supported API: true
      Parameters:
      changeIssue -
      changeables -
      Returns:
      WTList
      Throws:
      WTException
      ChangeException2
    • getChangeables

      QueryResult getChangeables(ChangeReviewIfc changeReview) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given ChangeIssueIfc object by the ReviewItem association.

      Supported API: true
      Parameters:
      changeReview -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
    • getChangeables

      QueryResult getChangeables(ChangeReviewIfc changeReview, boolean onlyChangeables) throws WTException, ChangeException2
      Retrieves the Changeable2 objects related to the given ChangeReviewIfc object by the ChagneReviewItemLinkIfc association. These Changeable2 objects represent additional documentation for the Change Review. If onlyChangeables is true, the QueryResult returned contains a set of Changeable2 objects.

      If onlyChangeables is false, the QueryResult returned contains a set of ChangeReviewItemLinIfc link objects that have references to the Changeable2 objects.

      Supported API: true

      Parameters:
      changeReview -
      onlyChangeables -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestAnalysisActivity

      QueryResult getLatestAnalysisActivity(ChangeAnalysisIfc ca) throws WTException, ChangeException2
      Retrieves the AnalysisActivityIfc object related to the given ChangeAnalysisIfc object by the DetailedByIfc association.

      Supported API: true
      Parameters:
      ca -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestChangeInvestigation

      QueryResult getLatestChangeInvestigation(ChangeRequestIfc cr) throws WTException, ChangeException2
      Retrieves the ChangeInvestigationIfc object related to the given ChangeRequestIfc object by the ResearchedByIfc association.

      Supported API: true
      Parameters:
      cr -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestChangeProposal

      QueryResult getLatestChangeProposal(ChangeRequestIfc cr) throws WTException, ChangeException2
      Retrieves the ChangeProposalIfc object related to the given ChangeRequestIfc object by the ResearchedByIfc association.

      Supported API: true
      Parameters:
      cr -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestChangeIssue

      QueryResult getLatestChangeIssue(ChangeRequestIfc cr) throws WTException, ChangeException2
      Retrieves the ChangeIssueIfc object related to the given ChangeRequestIfc object by the FormalizedByIfc association. If the given ChangeRequestIfc is a flexible change object, then it will invoke the FlexibleChangeService and return the related flexible process associations.

      Supported API: true
      Parameters:
      cr -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestChangeIssues

      QueryResult getLatestChangeIssues(ChangeActivityIfc changeActivity) throws WTException, ChangeException2
      Retrieves the latest version of the ChangeIssueIfc objects related to the provide version of the ChangeActivityIfc object by the IssueImplementedByIfc association. These ChangeIssueIfc objects represent issues that will be implemented by the particular ChangeActivityIfc. The QueryResult returned contains a set of ChangeIssueIfc objects.

      Supported API: true
      Parameters:
      changeActivity -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestChangeActivity

      QueryResult getLatestChangeActivity(ChangeOrderIfc co) throws WTException, ChangeException2
      Retrieves the latest version of ChangeActivityIfc object related to the given ChangeOrderIfc object by the IncludedInIfc association.

      Supported API: true
      Parameters:
      co -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestChangeOrder

      QueryResult getLatestChangeOrder(ChangeRequestIfc cr) throws WTException, ChangeException2
      Retrieves the ChangeOrderIfc object related to the given ChangeRequestIfc object by the AddressedByIfc association. If the given ChangeRequestIfc is a flexible change object, then it will invoke the FlexibleChangeService and return the related flexible process associations.

      Supported API: true
      Parameters:
      cr -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestChangeOrder

      QueryResult getLatestChangeOrder(ChangeActivityIfc ca) throws WTException, ChangeException2
      Retrieves the ChangeOrderIfc object related to the given ChangeActivityIfc object by the IncludedInIfc association.

      Supported API: true
      Parameters:
      ca -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestChangeOrder

      QueryResult getLatestChangeOrder(ChangeIssueIfc changeIssue) throws WTException, ChangeException2
      Retrieves the latest version of the ChangeOrderIfc objects related to the provide version of the ChangeIssueIfc object by the IssueImplementedByIfc association. These ChangeOrderIfc objects represent change notices that will be that have change tasks that implement the given ChangeIssueIfc object. The QueryResult returned contains a set of ChangeOrderIfc objects.

      Supported API: true
      Parameters:
      changeIssue -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestChangeRequest

      QueryResult getLatestChangeRequest(ChangeIssueIfc ci) throws WTException, ChangeException2
      Retrieves the ChangeRequestIfc object related to the given ChangeIssueIfc object by the FormalizedByIfc association. If the given ChangeIssueIfc is a flexible change object, then it will invoke the FlexibleChangeService and return the related flexible process associations.

      Supported API: true
      Parameters:
      ci -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestChangeRequest

      QueryResult getLatestChangeRequest(ChangeAnalysisIfc ca) throws WTException, ChangeException2
      Retrieves the ChangeRequestIfc object related to the given ChangeAnalysisIfc object by the ResearchedByIfc association.

      Supported API: true
      Parameters:
      ca -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestChangeRequest

      QueryResult getLatestChangeRequest(ChangeOrderIfc co) throws WTException, ChangeException2
      Retrieves the ChangeRequestIfc object related to the given ChangeOrderIfc object by the AddressedByIfc association.

      Supported API: true
      Parameters:
      co -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getAssociatedChanges

      WTCollection getAssociatedChanges(ChangeItemIfc changeItem, Class<? extends ChangeItemIfc> targetChangeItemClass) throws WTException, ChangeException2
      Retrieves a collection of associated objects for the given change object and relationship class. Currently only supports the relationships:

      changeItem Target Link
      ChangeActivityIfc ChangeOrderIfc IncludedIn2
      ChangeActivityIfc ChangeRequestIfc AddressedBy2 & IncludedIn2
      ChangeActivityIfc ChangeIssueIfc IssueImplementedBy
      VersionableChangeItem VersionableChangeItem ResearchedBy
      ChangeAnalysisIfc AnalysisActivityIfc DetailedBy
      AnalysisActivityIfc ChangeAnalysis DetailedBy
      AnalysisActivityIfc VersionableChangeItem ResearchedBy & DetailedBy


      Supported API: true
      Parameters:
      changeItem -
      targetChangeItemClass - (ChangeRequestIfc.class)
      Returns:
      Collection of associated objects
      Throws:
      WTException
      ChangeException2
    • getLatestChangeAnalysis

      QueryResult getLatestChangeAnalysis(AnalysisActivityIfc aa) throws WTException, ChangeException2
      Retrieves the ChangeAnalysisIfc object related to the given AnalysisActivityIfc object by the DetailedByIfc association.

      Supported API: true
      Parameters:
      aa -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getChangeables

      WTKeyedHashMap getChangeables(WTCollection cSet, String role, Class link, boolean onlyOtherSide) throws WTException, ChangeException2
      Given a set of ChangeItems and the proper role class return a WTKeyedHashMap of Changeables associated to each ChangeItem where the key is the ChangeItem and the value is a Set of changeables.

      Supported API: true
      Parameters:
      cSet - This is a WTSet of the VersionableChangeItems that you want to return the associated Changeable2 objects on.
      role - This is the role that will be used to navigate to the Changeable2. For example: RelevantRequestData2.CHANGEABLE2_ROLE.
      link - The link class to the Changeable
      onlyOtherSide - If true return the otherside objects, ie the changeables. If false return the link objects.
      Returns:
      WTKeyedHashMap
      Throws:
      WTException
      ChangeException2
    • deleteAddessedBy

      @Deprecated void deleteAddessedBy(WTCollection roleSet, String role) throws WTException, ChangeException2
      Deprecated.
      The AddressedBy2 link was replaced by ChangeProcessLink in 11.0. It is recommended to use the FlexibleChangeService to perform deletes.

      Supported API: true
      Delete the AddressedBy2 relationship associated to the passed in roleSet. The roleSet must be a set of either ChangeIssuesIfc or ChangeOrderIfc. Example call: deleteAddressedBy(crSet, AddressedBy2.CHANGE_ORDER2_ROLE
      Parameters:
      roleSet - This set contains either ChangeOrderfc or ChangeRequesetIfc. The AddressedBy2 link will be deleted to the otherside.
      role - The role variable contains the role to navigate via the AddressedBy2 link. For example, AddressedBy2.CHANGE_ORDER_ROLE.
      Throws:
      WTException
      ChangeException2
    • deleteChangeActivities

      void deleteChangeActivities(WTSet changeActivities) throws WTException, ChangeException2
      Delete the ChangeActivities in the WTSet.

      Supported API: true
      Parameters:
      changeActivities - This list contains ChangeActivities
      Throws:
      WTException
      ChangeException2
    • getLatestChangeIssue

      QueryResult getLatestChangeIssue(ChangeableIfc changeable2) throws WTException, ChangeException2
      Retrieves the ChangeIssueIfc object related to the given Changeable2 object by the ReportedAgainstByIfc association.

      Supported API: true
      Parameters:
      changeable2 -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestChangeRequest

      QueryResult getLatestChangeRequest(ChangeableIfc changeable2) throws WTException, ChangeException2
      Retrieves the ChangeRequestIfc object related to the given ChangeableIfc object by the FormalizedByIfc association.

      Supported API: true
      Parameters:
      changeable2 -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getLatestUniqueAffectingChangeOrders

      QueryResult getLatestUniqueAffectingChangeOrders(Changeable2 changeable) throws ChangeException2, WTException
      Returns a QueryResult of unique latest ChangeOrder2 objects that are indirectly related to the given Changeable2 object. This method obtains all ChangeActivity2 objects connected to the given Changeable2 via the AffectedActivityData association, and then obtains all of the parent ChangeOrder2 objects via the IncludedIn2 association. Finally, the result is filtered to remove duplicates.

      Supported API: true
      Parameters:
      changeable -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
    • getLatestChangeOrders

      @Deprecated WTKeyedMap getLatestChangeOrders(WTCollection changeables, Class... linkClasses) throws ChangeException2, WTException
      Returns a map of changeable objects and the latest change notices associated as affected and/or resulting objects on change tasks owned by the change notices.

      Supported API: true
      Parameters:
      changeables -
      linkClasses - To get change notices for only affected objects use wt.change2.AffectedActivityData. To only get change notices for resulting objects use wt.change2.ChangeRecord2. To get change notices for both affected and resulting associations pass both link classes. An empty map will be returned if no valid link type is specified.
      Returns:
      A map containing the changeable objects as keys and WTCollection of change notices associated. If not change notices are found for a given changeable the collection of change notices will be empty. The map returned is guaranteed non-null but may be empty.
      Throws:
      ChangeException2
      WTException
    • getLatestChangeOrders

      WTKeyedMap getLatestChangeOrders(WTCollection changeables, boolean includeAffected, boolean includeResulting) throws ChangeException2, WTException
      Returns a map of changeable objects and the latest change notices associated as affected and/or resulting objects on change tasks owned by the change notices. If neither affect or resulting are specified then an empty map will be returned.

      Supported API: true
      Parameters:
      changeables -
      includeAffected - True to get change notices for affected objects.
      includeResulting - True to get change notices for resulting objects.
      Returns:
      A map containing the changeable objects as keys and WTCollection of change notices associated. If no change notices are found for a given changeable the collection of change notices will be null. The map returned is guaranteed non-null but may be empty. The map will use the same key mask as the passed in collection of changeable objects.
      Throws:
      ChangeException2
      WTException
    • getLatestUniqueImplementedChangeOrders

      QueryResult getLatestUniqueImplementedChangeOrders(Changeable2 changeable) throws ChangeException2, WTException
      Returns a QueryResult of latest unique ChangeOrder2 objects that are indirectly related to the given Changeable2 object. This method obtains all ChangeActivity2 objects connected to the given Changeable2 via the ChangeRecord2 association, and then obtains all of the parent ChangeOrder2 objects via the IncludedIn2 association. Finally, the result is filtered to remove duplicates.

      Supported API: true
      Parameters:
      changeable -
      Returns:
      QueryResult
      Throws:
      ChangeException2
      WTException
    • deleteIncludeIn2

      @Deprecated void deleteIncludeIn2(WTSet changeActivities) throws WTException
      Deprecated.
      Retrieves the set of IncludedIn2 links associated with the passed in ChangeActivities and if the RoleB (ChangeAcitivity2) points to one and only one ChangeOrder2 then the RoleB object (ChangeActivity2) will be deleted. The IncludedIn2 link associated with the ChangeActivity will always be deleted. This API is deprecated, use deleteIncludeIn2AndChangeTask

      Supported API: true
      Parameters:
      changeActivities - This list contains ChangeActivities
      Throws:
      WTException
    • deleteIncludeIn2AndChangeTask

      @Deprecated void deleteIncludeIn2AndChangeTask(WTSet changeActivities, ChangeOrder2 co) throws WTException
      Retrieves a set of IncludedIn2 links associated with the passed in change tasks. If the RoleB(Change task) points to just one Change notice then the change task will be deleted. The IncludedIn2 link will be deleted if the RoleAObject(ChangeNotice) is the same as the passed change notice.

      Supported API: true
      Parameters:
      changeActivities - This list contains ChangeActivities
      co -
      Throws:
      WTException
    • deleteIncludeIn2AndChangeTask

      void deleteIncludeIn2AndChangeTask(WTSet changeActivities, ChangeOrder2 co, boolean validate) throws WTException
      Retrieves a set of IncludedIn2 links associated with the passed in change tasks. If the RoleB(Change task) points to just one Change notice then the change task will be deleted. The IncludedIn2 link will be deleted if the RoleAObject(ChangeNotice) is the same as the passed change notice.

      The implementation plan association rules can be optionally evaluated using the validate parameter.

      Supported API: true
      Parameters:
      changeActivities - This list contains ChangeActivities
      co -
      validate - False to ignore association rule validation
      Throws:
      WTException
    • deleteIssueImplementedBy

      void deleteIssueImplementedBy(ChangeActivityIfc changeActivity, WTCollection changeIssues) throws WTException, ChangeException2
      Delete the IssueImplementedByIfc relationships implied by the two arguments. The concrete subclasses of the ChangeActivityIfc, the collection of ChangeIssueIfc objects and the IssueImplementedByIfc relationship must already be Persistent. In the event there is no IssueImplementedByIfc (the two objects passed in are not related) then there will be no exception generated, instead a null will be returned..

      Supported API: true
      Parameters:
      changeActivity -
      changeIssues -
      Throws:
      WTException
      ChangeException2
    • deleteIssueImplementedBy

      void deleteIssueImplementedBy(Class<?> linkClass, ChangeActivityIfc changeActivity, WTCollection changeIssues) throws WTException, ChangeException2
      Delete the IssueImplementedByIfc relationships implied by the two arguments. The concrete subclasses of the ChangeActivityIfc, the collection of ChangeIssueIfc objects and the IssueImplementedByIfc relationship must already be Persistent. In the event there is no IssueImplementedByIfc (the two objects passed in are not related) then there will be no exception generated, instead a null will be returned..

      Supported API: true
      Parameters:
      linkClass -
      changeActivity -
      changeIssues -
      Throws:
      WTException
      ChangeException2
    • getChangeItems

      WTKeyedHashMap getChangeItems(WTCollection cSet, String role, Class link, boolean onlyOtherSide) throws WTException, ChangeException2
      Given a set of Changeable2 and the proper role class return a WTKeyedHashMap of ChangeItems associated to each Changeable2 where the key is the Changeable and the value is a Set of ChangeItems.

      Supported API: true
      Parameters:
      cSet - This is a WTSet of the VersionableChangeItems that you want to return the associated Changeable2 objects on.
      role - This is the role that will be used to navigate to the Changeable2. For example: RelevantRequestData2.CHANGEABLE2_ROLE.
      link - The link class to the Changeable
      onlyOtherSide - If true return the otherside objects, ie the changeables. If false return the link objects.
      Returns:
      WTKeyedHashMap
      Throws:
      WTException
      ChangeException2
    • getTrackingChange

      boolean getTrackingChange(Persistable p) throws WTException
      Get the trackingChangeItem Preference for a Persistable. It checks from the Org Container up to Site Container.

      Supported API: true
      Parameters:
      p -
      Returns:
      boolean
      Throws:
      WTException
    • getPendRequests

      @Deprecated String[] getPendRequests() throws WTException
      Deprecated.
      The pending change request states are now maintained by DefaultPendingChangeEventHandler.


      Supported API: true
      Returns:
      String []
      Throws:
      WTException
    • getPendOrders

      @Deprecated String[] getPendOrders() throws WTException
      Deprecated.
      The pending change order states are now maintained by DefaultPendingChangeEventHandler.


      Supported API: true
      Returns:
      String []
      Throws:
      WTException
    • saveChangeActivities

      @Deprecated WTKeyedMap saveChangeActivities(WTKeyedHashMap coMap) throws WTException, ChangeException2
      Save the ChangeActivities associated to the ChangeOrder key in the WTKeyedSet where the key is the ChangeOrder and the value is a WTList of ChangeActivities.

      Supported API: true
      Parameters:
      coMap - This WTKeyedMap contains the ChangeOrder as the key and a WTList of ChangeActivities as the value.
      Returns:
      WTKeyedMap
      Throws:
      WTException
      ChangeException2
    • saveChangeActivities

      WTKeyedMap saveChangeActivities(WTKeyedHashMap coMap, boolean validate) throws WTException, ChangeException2
      Save the ChangeActivities associated to the ChangeOrder key in the WTKeyedSet where the key is the ChangeOrder and the value is a WTList of ChangeActivities.

      The implementation plan association rules can be optionally evaluated using the validate parameter.

      Supported API: true
      Parameters:
      coMap - This WTKeyedMap contains the ChangeOrder as the key and a WTList of ChangeActivities as the value.
      validate - False to ignore association rule validation
      Returns:
      WTKeyedMap
      Throws:
      WTException
      ChangeException2
    • saveChangeDirective

      Stores the given concrete subclass of ChangeDirective in the database.

      Supported API: true
      Parameters:
      cd -
      Returns:
      WTChangeDirective
      Throws:
      ChangeException2
      WTException
    • saveChangeAction

      ChangeAction saveChangeAction(ChangeAction action) throws ChangeException2, WTException
      Stores the given concrete subclass of ChangeAction in the database.

      Supported API: true
      Parameters:
      action -
      Returns:
      ChangeAction
      Throws:
      ChangeException2
      WTException
    • getPredessorActions

      WTKeyedMap getPredessorActions(ChangeAction action) throws WTException, ChangeException2
      Retrieves the ChangeAction predessor stack

      Supported API: true
      Parameters:
      action -
      Returns:
      WTKeyedMap
      Throws:
      WTException
      ChangeException2
    • getChangeDirective

      QueryResult getChangeDirective(ChangeOrderIfc co, boolean onlyChangeDirective) throws WTException, ChangeException2
      Retrieves the WTChangeDirective object related to the given ChangeOrderIfc object by the AddressesDirective association. The WTChangeDirective object represents the request that is addressed by the ChangeOrderIfc. If onlyChangeDirective is true, the QueryResult returned contains zero or one WTChangeDirective objects.

      If onlyChangeDirective is false, the QueryResult returned contains zero or one AddressesDirective link objects that has a reference to the WTChangeDirective object.

      Supported API: true

      Parameters:
      co -
      onlyChangeDirective -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also:
    • getWorkflowRecords

      WTCollection getWorkflowRecords(Persistable primaryBusinessObject, boolean isGetOnlySignedReviews) throws WTException
      Given a primary business object, return the related workflow records.

      Supported API: true
      Parameters:
      primaryBusinessObject -
      isGetOnlySignedReviews - when true only workflow records that were signed as part of task completion are returned
      Returns:
      WTCollection. Guaranteed non-null, but could be empty
      Throws:
      WTException
    • getLatestChangeReview

      QueryResult getLatestChangeReview(ChangeableIfc changeable2) throws WTException, ChangeException2
      Retrieves the ChangeReview object related to the given Changeable2 object by the ChangeReviewItemLinkIfc association.

      Supported API: true
      Parameters:
      changeable2 -
      Returns:
      QueryResult
      Throws:
      WTException
      ChangeException2
      See Also: