Package wt.change2.workset

Interface WTWorkSetService

@RemoteInterface public interface WTWorkSetService
The interface describing the services available for workset

Supported API: true

Extendable: false
See Also:

  • Method Details

    • createWTWorkSetComponentLinks

      WTCollection createWTWorkSetComponentLinks(WTWorkSet workset, WTCollection components) throws WTException
      Given a WTWorkset and a collection of Changeable2 components, the created WTWorkSetComponentLink links between the workset and Changeble2 components will be returned in a WTCollection.

      Supported API: true
      Parameters:
      workset -
      components -
      Returns:
      WTCollection
      Throws:
      WTException

    • getComponents

      WTCollection getComponents(WTWorkSet worksets) throws WTException
      Given a WTWorkset object, a collection of its components will be returned in a WTCollection

      Supported API: true
      Parameters:
      worksets -
      Returns:
      WTCollection
      Throws:
      WTException

    • getComponents

      WTCollection getComponents(WTWorkSet worksets, boolean onlyOtherSide) throws WTException
      Given a WTWorkset object, a collection of its components will be returned in a WTCollection, if onlyOtherSide is true. Otherwise, a collection of its WTWorkSetComponentLink links will be returned.

      Supported API: true
      Parameters:
      worksets -
      onlyOtherSide -
      Returns:
      WTCollection
      Throws:
      WTException

    • getComponents

      WTKeyedMap getComponents(WTCollection worksets) throws WTException
      Given a collection of WTWorkset objects, a keyed map will be returned such that the collection of the components for each workset is mapped with the workset.

      Supported API: true
      Parameters:
      worksets -
      Returns:
      WTKeyedMap
      Throws:
      WTException

    • getComponents

      WTKeyedMap getComponents(WTCollection worksets, boolean onlyOtherSide) throws WTException
      Given a collection of WTWorkset objects, a keyed map will be returned such that the collection of the components for each workset is mapped with the workset, if onlyOtherSide is true. Otherwise, a collection of the WTWorkSetComponentLink for each workset is mapped with the workset in the keyed map returned.

      Supported API: true
      Parameters:
      worksets -
      onlyOtherSide -
      Returns:
      WTKeyedMap
      Throws:
      WTException

    • removeWTWorkSetComponentLinks

      WTCollection removeWTWorkSetComponentLinks(WTWorkSet workset, WTCollection components) throws WTException
      Given a WTWorkset and a collection of Changeable2 components, the WTWorkSetComponentLink links between the workset and any of the components will be deleted and returned in a WTCollection.

      Supported API: true
      Parameters:
      workset -
      components -
      Returns:
      WTCollection
      Throws:
      WTException

    • getLatestRelatedWorkSets

      WTCollection getLatestRelatedWorkSets(Changeable2 changeable) throws WTException
      Retrieve a collection of latest related Work Sets for a given changeable.

      Supported API: true
      Parameters:
      changeable -
      Returns:
      A collection of wt.change2.workset.WorkSet
      Throws:
      WTException

    • isValidComponentTypeForWorkSet

      boolean isValidComponentTypeForWorkSet(WTWorkSet workSet, Changeable2 changeable) throws WTException
      Given a Work Set and a changeable type object determine if it is a Work Set component type.

      Supported API: true
      Parameters:
      workSet - A Work Set type object
      changeable - A wt.change2.Changeable2 type object
      Returns:
      True when the changeable is a Work Set component type.
      Throws:
      WTException

    • isValidComponentTypeForWorkSet

      boolean isValidComponentTypeForWorkSet(Changeable2 changeable, WTContainerRef containerRef) throws WTException
      Given a changeable type object determine if it is a Work Set component type.

      Supported API: true
      Parameters:
      changeable - A wt.change2.Changeable2 type object
      containerRef -
      Returns:
      True when the changeable is a Work Set component type.
      Throws:
      WTException

    • isValidComponentTypeForWorkSet

      boolean isValidComponentTypeForWorkSet(TypeIdentifier workSet_type_id, TypeIdentifier component_type_id, WTContainer container) throws WTException
      Given a Work Set and a changeable type identifier determine if it is a Work Set component type.

      Supported API: true
      Parameters:
      workSet_type_id - A Work Set type identifier
      component_type_id - A wt.change2.Changeable2 type identifier
      Returns:
      True when the changeable is a Work Set component type.
      Throws:
      WTException

    • getValidComponentForWorkSet

      WTCollection getValidComponentForWorkSet(WTWorkSet workset, WTCollection changeables) throws WTException
      Given a collection of changeables, return the collection of WorkSet type components.

      Supported API: true
      Parameters:
      workset -
      changeables - A collection of changeables.
      Returns:
      The collection of components. An empty collection is returned if there are no references or if the list doesn't contain a component.
      Throws:
      WTException

    • getValidComponentForWorkSet

      WTCollection getValidComponentForWorkSet(TypeIdentifier workset_typeId, WTCollection changeables) throws WTException
      Given a collection of changeables, return the collection of WorkSet type components.

      Supported API: true
      Parameters:
      workset_typeId - Work Set type identifier
      changeables - A collection of changeables.
      Returns:
      The collection of components. An empty collection is returned if there are no references or if the list doesn't contain a component.
      Throws:
      WTException

    • getValidComponentTypeNamesForWorkSet

      List<String> getValidComponentTypeNamesForWorkSet(WTWorkSet workset, boolean toExternalForm) throws WTException
      Returns the List String type names for each in the List of valid Workset components. If the toExternalForm is true the type names in the list will be returned as the external form value of the TypeIdentifier.

      Supported API: true
      Parameters:
      workset -
      toExternalForm - return the type name of the TypeIdentifier in the external form.
      Returns:
      A list String values for the type names of Work Set component types.
      Throws:
      WTException

    • getValidComponentTypeNamesForWorkSet

      List<String> getValidComponentTypeNamesForWorkSet(TypeIdentifier tid, WTContainer container, boolean toExternalForm) throws WTException
      Returns the List String type names for each in the List of valid Workset components. If the toExternalForm is true the type names in the list will be returned as the external form value of the TypeIdentifier.

      Supported API: true
      Parameters:
      tid - A Work Set type identifier
      container -
      toExternalForm - return the type name of the TypeIdentifier in the external form.
      Returns:
      A list String values for the type names of Work Set component types.
      Throws:
      WTException

    • getReferenceDocumentLinks

      WTCollection getReferenceDocumentLinks(WTWorkSet workSet) throws WTException
      Retrieve a collection of the WTWorkSetReferenceLink links that the work set is linked to

      Supported API: true
      Parameters:
      workSet -
      Returns:
      collection of WTWorkSetReferenceLinks
      Throws:
      WTException

    • getReferenceWTDocumentMasters

      WTCollection getReferenceWTDocumentMasters(WTWorkSet workSet) throws WTException
      Retrieve a collection of the WTDocumentMasters that are linked to the work set through the WTWorkSetReferenceLinks link

      Supported API: true
      Parameters:
      workSet -
      Returns:
      collection of WTDocumentMaseters
      Throws:
      WTException

    • getReferenceWTDocuments

      WTCollection getReferenceWTDocuments(WTWorkSet workSet) throws WTException
      Retrieve a collection of the WTDocuments that are linked to the work set through the WTWorkSetReferenceLinks link

      Supported API: true
      Parameters:
      workSet -
      Returns:
      collection of WTDocuments
      Throws:
      WTException

    • getReferencedByWorkSets

      WTCollection getReferencedByWorkSets(WTDocument doc) throws WTException
      Retrieve a collection of the Work Sets that are linked to the document through the WTWorkSetReferenceLinks link

      Supported API: true
      Parameters:
      doc -
      Returns:
      collection of WTWorkSets
      Throws:
      WTException

    • getValidReferenceDocumentTypesForWorkSet

      List<TypeIdentifier> getValidReferenceDocumentTypesForWorkSet(WorkSet workSet) throws WTException
      Gets the list Work Set reference document TypeIdentifier.

      Supported API: true
      Parameters:
      workSet - The work set object.
      Returns:
      A list of Work Set reference document types.
      Throws:
      WTException

    • isValidReferenceDocument

      boolean isValidReferenceDocument(WorkSet workSet, Document document) throws WTException
      Given a work set object and document object determine if it is a work set referemce document type.

      Supported API: true
      Parameters:
      workSet - Work set object.
      document - Document reference object.
      Returns:
      True when the document is a Work Set reference document type.
      Throws:
      WTException

    • getValidReferenceDocuments

      WTCollection getValidReferenceDocuments(WorkSet workSet, WTCollection documents) throws WTException
      Given a work set object and a collection of document objects determine if the documents are work set referemce document types and return the collection of valid reference documents.

      Supported API: true
      Parameters:
      workSet - Work set object.
      documents - collection of document objects.
      Returns:
      The collection of valid document references.
      Throws:
      WTException

    • getInValidReferenceDocuments

      WTCollection getInValidReferenceDocuments(WorkSet workSet, WTCollection documents) throws WTException
      Given a work set object and a collection of document objects determine if the documents are work set referemce document types and return the collection of invalid reference documents.

      Supported API: true
      Parameters:
      workSet - Work set object.
      documents - collection of document objects.
      Returns:
      The collection of invalid document references.
      Throws:
      WTException