Class ServiceKey

    • Method Detail

      • forName

        public static ServiceKey forName​(String serviceName)
        Returns the identifier of a service defined in a data model (user service on datasets or records, for more information see the class comment).
        Parameters:
        serviceName - name of the service in the data model (as defined by the attribute /xs:schema/xs:complexType/@name)
        See Also:
        isIdentifierInDataModel()
      • forModuleServiceName

        public static ServiceKey forModuleServiceName​(String moduleName,
                                                      String serviceName)
        Returns the identifier of a service defined in a module (user service on branches or versions, for more information see the class comment).
        Parameters:
        moduleName - name of the module (as defined by the element /module/name in the document located at /WEB-INF/ebx/module.xml).
        serviceName - name of the service in the module (as defined by the attribute /module/services/service/@name in the document /WEB-INF/ebx/module.xml).
      • parse

        public static ServiceKey parse​(String aString)
        Returns the service key that corresponds to the specified string.

        The specified string is generally generated by the method format().

        Throws:
        IllegalArgumentException - if specified string is incorrect.
      • isBuiltInService

        public boolean isBuiltInService()
        Returns true if this instance identifies a built-in service.
      • isIdentifierInDataModel

        public boolean isIdentifierInDataModel()
        Returns true if this key identifies a service declared in a data model.
        Since:
        5.7.0
        See Also:
        forName(String)
      • getModuleName

        public String getModuleName()
      • getServiceName

        public String getServiceName()
        Returns the local name of the service, by removing the prefix before and including the '@' character.
      • getName

        public String getName()
        Returns the full name of the service.
      • format

        public String format()
        Returns a persistent identifier for this service key.

        The service key can be re-obtained by parsing this persistent identifier using the method parse(String).

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object