Package wt.epm.annotation

Interface EPMAnnotationService

@RemoteInterface public interface EPMAnnotationService
The service in Annotation package to Add and Abort Structure Annotations to a StructureAnnotatable.

Supported API: true

Extendable: false

  • Method Details

    • abortAnnotation

      EPMStructureAnnotatable abortAnnotation(EPMStructureAnnotatable annotatableObject) throws WTException
      Single Object API to remove all StructureAnnotations on a StructureAnnotatable object.

      Supported API: true
      Parameters:
      annotatableObject - EPMStructureAnnotatable object from which annotations are to be removed. If annotatable has ADD type of annotation then the annotatable object will be deleted as part of abort annotation.
      Returns:
      EPMStructureAnnotatable
      Throws:
      WTException

    • abortAnnotation

      WTCollection abortAnnotation(WTCollection annotatables) throws WTException
      Single Object API to remove all StructureAnnotations on a StructureAnnotatable object.

      Supported API: true
      Parameters:
      annotatables - Collection of EPMStructureAnnotatable objects from which annotations are to be removed. If annotatable has ADD type of annotation then the annotatable object will be deleted as part of abort annotation.
      Returns:
      WTCollection
      Throws:
      WTException

    • getEPMStructureAnnotationType

      WTKeyedMap getEPMStructureAnnotationType(WTCollection memberLinks) throws WTException
      Returns annotations on the given WTCollection of member links in a WTKeyedMap where the keys are member links and the values are of type EPMStructureAnnotationType. Note that this API returns null as value for a member link which has no structure annotation.

      Supported API: true
      Parameters:
      annotatables - WTCollection of EPMStructureAnnotatable objects
      Returns:
      WTKeyedMap of EPMStructureAnnotatable to EPMStructureAnnotationType.
      Throws:
      WTException