Package com.solibri.smc.api.communication

Interface Slide

  • public interface Slide
    Slide represents a single issue slide created manually or from other sources that is intended to be communicated outside the software. Notably these slides might be used in communication through BCF API with servers.
    Since:
    9.10.8

    • Method Detail

      • create

        static Slide create()
        Creates an empty slide.
        Returns:
        the new slide
        Since:
        9.12.0

      • getUniqueId

        String getUniqueId()
        Returns the unique ID of the slide.
        Returns:
        the ID of the slide
        Since:
        9.12.0

      • getTitle

        String getTitle()
        Returns the title of this slide.
        Returns:
        the title
        Since:
        9.10.8

      • getComments

        List<Comment> getComments()
        Returns a list of the comments this Slide has directly. Note that the viewpoints under this slide can also have comments.
        Returns:
        the comments
        Since:
        9.12.0

      • getViewpoints

        List<Viewpoint> getViewpoints()
        Returns the viewpoints this Slide has.
        Returns:
        the viewpoints
        Since:
        9.10.8

      • addViewpoint

        boolean addViewpoint​(Viewpoint viewpoint)
        Adds the given viewpoint to this Slide.
        Parameters:
        viewpoint - the new viewpoint
        Returns:
        true if the viewpoint did not previously exist for this slide, false otherwise
        Since:
        9.12.0

      • removeViewpoint

        boolean removeViewpoint​(Viewpoint viewpoint)
        Removes the given viewpoint from this slide. If the viewpoint is not in this slide, nothing happens. If the given viewpoint is the last viewpoint then the slide is removed from Solibri.
        Parameters:
        viewpoint - the viewpoint to remove
        Returns:
        true if the viewpoint was removed, false if it didn't exist to begin with
        Since:
        9.12.0

      • getCheckingResult

        Optional<Result> getCheckingResult()
        Returns the checking result this slide is based on, if it is based on a checking result.
        Returns:
        the checking result
        Since:
        9.10.8

      • setTitle

        void setTitle​(String title)
        Sets the title of this slide.
        Parameters:
        title - the title
        Since:
        9.12.0

      • getType

        String getType()
        Returns the type of this slide. Type is the type of issue the slide represents. Solibri defaults are Error, Info, Warning, Unknown.
        Returns:
        the type
        Since:
        9.12.0

      • setType

        void setType​(String type)
        Sets the type of this slide. Type is the type of issue the slide represents. Solibri defaults are Error, Info, Warning, Unknown.
        Parameters:
        type - the type
        Since:
        9.12.0

      • getStatus

        String getStatus()
        Returns the status of this slide. Status is the state of the slide in the workflow. Solibri defaults are Open, Assigned, Closed, Resolved.
        Returns:
        the status
        Since:
        9.12.0

      • setStatus

        void setStatus​(String status)
        Sets the status of this slide. Status is the state of the slide in the workflow. Solibri defaults are Open, Assigned, Closed, Resolved.
        Parameters:
        status - the status
        Since:
        9.12.0

      • getStage

        Optional<String> getStage()
        Returns the stage of slide in issue management workflow. BCF Servers controls the list of values that can be used as stage.
        Returns:
        the stage
        Since:
        9.12.0

      • setStage

        void setStage​(String stage)
        Sets the stage of slide in issue management workflow. BCF Servers controls the list of values that can be used as stage.
        Parameters:
        stage - the stage
        Since:
        9.12.0

      • getPriority

        Optional<String> getPriority()
        Returns the priority of this slide. BCF Servers controls the list of values that can be used as priority.
        Returns:
        the priority
        Since:
        9.12.0

      • setPriority

        void setPriority​(String priority)
        Sets the priority of this slide. BCF Servers controls the list of values that can be used as priority.
        Parameters:
        priority - the priority
        Since:
        9.12.0

      • getDescription

        Optional<String> getDescription()
        Returns the description of this slide.
        Returns:
        the description
        Since:
        9.12.0

      • setDescription

        void setDescription​(String description)
        Sets the description of this slide.
        Parameters:
        description - the description
        Since:
        9.12.0

      • getResponsibilities

        Collection<String> getResponsibilities()
        Returns the responsible persons of this slide. BCF Servers controls the list of values that can be used as responsible persons.
        Returns:
        the responsibilities
        Since:
        9.12.0

      • setResponsibilities

        void setResponsibilities​(List<String> responsibilities)
        Sets the list of responsible persons to this slide. BCF Servers controls the list of values that can be used as priority.
        Parameters:
        responsibilities - the responsibilities
        Since:
        9.12.0

      • getLabels

        Set<String> getLabels()
        Returns the labels of this slide. BCF Servers controls the list of values that can be used as labels. Labels can be used for tagging or grouping the slides.
        Returns:
        the labels
        Since:
        9.12.0

      • setLabels

        void setLabels​(Set<String> labels)
        Sets the labels to this slide. BCF Servers controls the list of values that can be used as labels. Labels can be used for tagging or grouping the slides.
        Parameters:
        labels - the labels
        Since:
        9.12.0

      • getDueDate

        Optional<LocalDate> getDueDate()
        Returns the optional due date for this slide.
        Returns:
        the optional due date
        Since:
        9.12.0

      • setDueDate

        void setDueDate​(LocalDate dueDate)
        Sets the due date for this slide.
        Parameters:
        dueDate - the due date
        Since:
        9.12.0

      • getComponents

        Set<Component> getComponents()
        Returns the components of this slide.
        Returns:
        the set of components
        Since:
        9.12.0

      • setComponents

        void setComponents​(Set<Component> components)
        Sets the given components as components of this slide.
        Parameters:
        components - the set of components
        Since:
        9.12.0

      • addComponent

        boolean addComponent​(Component component)
        Add the given component to the components of this slide.
        Parameters:
        component - the component
        Returns:
        true if the given components was added, false if component was already in this slide
        Since:
        9.12.0

      • removeComponent

        boolean removeComponent​(Component component)
        Remove the given component from the components of this slide.
        Parameters:
        component - the component
        Returns:
        true if the given components was removed, false if it wasn't there to begin with
        Since:
        9.12.0

      • getResultCategory

        Optional<ResultCategory> getResultCategory()
        Returns the related checking result category, if one exists.
        Returns:
        the related checking result category
        Since:
        9.12.0

      • getResultAndComponent

        Optional<Pair<Result,​Component>> getResultAndComponent()
        Get the source result and component pair.
        Returns:
        return the pair, or empty, if it doesn't exist.
        Since:
        9.12.0

      • addExternalID

        boolean addExternalID​(UUID uuid)
        Add an id this slide has in some external system.
        Parameters:
        uuid - the external id
        Returns:
        true when the id didn't exist previously
        Since:
        9.12.0

      • removeExternalID

        boolean removeExternalID​(UUID uuid)
        Remove an id this slide has in some external system.
        Parameters:
        uuid - the external id
        Returns:
        true when the id existed and was removed
        Since:
        9.12.0

      • getExternalIds

        Set<UUID> getExternalIds()
        Returns all the external IDs for this slide.
        Returns:
        all the external IDs
        Since:
        9.12.0

      • getModifiedTimeInExternalSystem

        OffsetDateTime getModifiedTimeInExternalSystem()
        Get the time when the slide was modified in some external system.
        Returns:
        the modified time in an external system
        Since:
        9.12.0

      • setModifiedTimeInExternalSystem

        void setModifiedTimeInExternalSystem​(OffsetDateTime date)
        Set the modified time in some external system. The modified time is not guaranteed to be saved with sub-second accuracy. Practically this means that the returned modified time might be different from what is set here when it comes to milliseconds.
        Parameters:
        date - the modified time in an external system
        Since:
        9.12.0

      • addComment

        boolean addComment​(Comment comment)
        Adds the given comment to this slide.
        Parameters:
        comment - the new comment
        Returns:
        true if the comment didn't already exist in this slide, false otherwise
        Since:
        9.12.0

      • removeComment

        boolean removeComment​(Comment comment)
        Removes the given comment from this slide.
        Parameters:
        comment - the comment to remove
        Returns:
        true if the comments was removed, false if it didn't exist in this slide
        Since:
        9.12.0

      • hasLocalChanges

        boolean hasLocalChanges()
        Returns whether this local slide has been marked to have local-only changes that are not in sync with some remote. Solibri BCF Live Connector reads and updates this information. So while this can be safely read, when updating some care needs to be taken when using the information.
        Returns:
        true if local-only changes
        Since:
        9.12.3

      • setHasLocalChanges

        void setHasLocalChanges​(boolean localChanges)
        Set whether this local slide has local-only changes that are not in sync with some remote. If changing slide information through the API with fresh local information, this should be called to update the state of the slide.
        Parameters:
        localChanges - true if there are now local-only changes
        Since:
        9.12.3