Package org.kuali.rice.krms.api.repository.term

Interface TermResolverDefinitionContract

All Superinterfaces:
org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned
All Known Implementing Classes:
TermResolverDefinition, TermResolverDefinition.Builder
public interface TermResolverDefinitionContract extends org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned

The contract for a TermResolverDefinition which defines a term resolver.

Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    getAttributes()
    Gets any attributes specified on the term resolver definition.
    String
    getName()
    Gets the name for the defined term resolver.
    String
    getNamespace()
    Gets the namespace for the defined term resolver.
    TermSpecificationDefinitionContract
    getOutput()
    Gets the term specification for the output of the defined term resolver.
    Set<String>
    getParameterNames()
    Gets the names of any parameters that the defined term resolver requires.
    Set<? extends TermSpecificationDefinitionContract>
    getPrerequisites()
    Gets the term specifications for any prerequisite terms of the defined term resolver.
    String
    getTypeId()
    Gets the type id for the defined term resolver.

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

    getId

    Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

    isActive

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

    getVersionNumber

  • Method Details

    • getNamespace

      String getNamespace()
      Gets the namespace for the defined term resolver. Will not be null or empty.
      Returns:
      the namespace

    • getName

      String getName()
      Gets the name for the defined term resolver. The namespace and name should uniquely identify a term resolver definition. Will not be null or empty.
      Returns:
      the name

    • getTypeId

      String getTypeId()
      Gets the type id for the defined term resolver. This id refers to a type which configures how the term resolver may be obtained. May be null, but never empty.
      Returns:
      the type id.

    • getOutput

      TermSpecificationDefinitionContract getOutput()
      Gets the term specification for the output of the defined term resolver. Will never be null.
      Returns:
      the output term's specification.

    • getPrerequisites

      Set<? extends TermSpecificationDefinitionContract> getPrerequisites()
      Gets the term specifications for any prerequisite terms of the defined term resolver. May be empty, but will never be null.
      Returns:
      any prerequisite terms.

    • getAttributes

      Map<String,String> getAttributes()
      Gets any attributes specified on the term resolver definition. May be empty, but never null.
      Returns:
      the attribute map for the term resolver definition.

    • getParameterNames

      Set<String> getParameterNames()
      Gets the names of any parameters that the defined term resolver requires. May be empty, but never null.
      Returns:
      the parameter names.