Package org.intermine.api.profile

Interface TagChecker

  • public interface TagChecker
    An interface for checking the validity of tags.
    Author:
    Kim Rutherford

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void isValid​(java.lang.String tagName, java.lang.String type, java.lang.String objectIdentifier, UserProfile userProfile)
      Returns true if and only the given arguments are valid fields for a tag of this type.

    • Method Detail

      • isValid

        void isValid​(java.lang.String tagName,
             java.lang.String type,
             java.lang.String objectIdentifier,
             UserProfile userProfile)
        Returns true if and only the given arguments are valid fields for a tag of this type.
        Parameters:
        tagName - the name of the new tag
        type - the tag type (eg. "collection", "bag")
        objectIdentifier - the String version of the identifier of the object to tag (eg. "Department.name")
        userProfile - the UserProfile to associate this tag with
        Throws:
        java.lang.RuntimeException - if the this parameters are inconsistent