Package com.solibri.smc.api.bcflive

Interface BCFCoordinationValues

public interface BCFCoordinationValues
This interface provides the collections of valid BCF topic coordination values that are used in Solibri issue coordination editor. Use BcfApi.setCoordinationValues(BCFCoordinationValues) to set the coordination values.
Since:
9.12.0

  • Method Summary

    Modifier and Type Method Description
    Collection<String> getLabels()
    Returns the collection of all valid labels used in the coordination.
    Collection<String> getPriorities()
    Returns the collection of all valid priorities used in the coordination.
    Collection<String> getStages()
    Returns the collection of all valid stages used in the coordination.
    Collection<String> getTopicStatuses()
    Returns the collection of all valid topic statuses used in the coordination.
    Collection<String> getTopicTypes()
    Returns the collection of all valid topic types used in the coordination.
    Collection<String> getUserIDs()
    Returns the collection of all valid user IDs used in coordination.
    default boolean isAllowAnyLabel()
    Returns true if any label value is allowed in the coordination else false.
    default boolean isAllowAnyPriority()
    Returns true if any priority value is allowed in the coordination else false.
    default boolean isAllowAnyStage()
    Returns true if any stage value is allowed in the coordination else false.
    default boolean isAllowAnyTopicStatus()
    Returns true if any topic status value is allowed in the coordination else false.
    default boolean isAllowAnyTopicType()
    Returns true if any topic type value is allowed in the coordination else false.
    default boolean isAllowAnyUserID()
    Returns true if any user ID value is allowed in the coordination else false.

  • Method Details

    • getLabels

      Collection<String> getLabels()
      Returns the collection of all valid labels used in the coordination.
      Returns:
      the labels
      Since:
      9.12.0

    • getPriorities

      Collection<String> getPriorities()
      Returns the collection of all valid priorities used in the coordination.
      Returns:
      the priorities
      Since:
      9.12.0

    • getStages

      Collection<String> getStages()
      Returns the collection of all valid stages used in the coordination.
      Returns:
      the stages
      Since:
      9.12.0

    • getTopicStatuses

      Collection<String> getTopicStatuses()
      Returns the collection of all valid topic statuses used in the coordination.
      Returns:
      the topic statuses
      Since:
      9.12.0

    • getTopicTypes

      Collection<String> getTopicTypes()
      Returns the collection of all valid topic types used in the coordination.
      Returns:
      the topic types
      Since:
      9.12.0

    • getUserIDs

      Collection<String> getUserIDs()
      Returns the collection of all valid user IDs used in coordination. The user IDs are recommended to be in email format as to uniquely identify users throughout multiple systems.
      Returns:
      the user IDs
      Since:
      9.12.0

    • isAllowAnyLabel

      default boolean isAllowAnyLabel()
      Returns true if any label value is allowed in the coordination else false.
      Returns:
      true if any label value is allowed else false
      Since:
      9.12.0

    • isAllowAnyPriority

      default boolean isAllowAnyPriority()
      Returns true if any priority value is allowed in the coordination else false.
      Returns:
      true if any priority value is allowed else false
      Since:
      9.12.0

    • isAllowAnyStage

      default boolean isAllowAnyStage()
      Returns true if any stage value is allowed in the coordination else false.
      Returns:
      true if any stage value is allowed else false
      Since:
      9.12.0

    • isAllowAnyTopicStatus

      default boolean isAllowAnyTopicStatus()
      Returns true if any topic status value is allowed in the coordination else false.
      Returns:
      true if any topic status value is allowed else false
      Since:
      9.12.0

    • isAllowAnyTopicType

      default boolean isAllowAnyTopicType()
      Returns true if any topic type value is allowed in the coordination else false.
      Returns:
      true if any topic type value is allowed else false
      Since:
      9.12.0

    • isAllowAnyUserID

      default boolean isAllowAnyUserID()
      Returns true if any user ID value is allowed in the coordination else false.
      Returns:
      true if any user ID value is allowed else false
      Since:
      9.12.0