Package org.kuali.rice.krms.impl.repository

Interface FunctionBoService

All Superinterfaces:
org.kuali.rice.krms.api.repository.function.FunctionRepositoryService
All Known Implementing Classes:
FunctionBoServiceImpl
public interface FunctionBoService extends org.kuali.rice.krms.api.repository.function.FunctionRepositoryService
This is the interface for accessing KRMS repository Function related bos
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Summary

    Modifier and Type
    Method
    Description
    org.kuali.rice.krms.api.repository.function.FunctionDefinition
    createFunction(org.kuali.rice.krms.api.repository.function.FunctionDefinition function)
    This will create a FunctionDefinition exactly like the function passed in.
    org.kuali.rice.krms.api.repository.function.FunctionDefinition
    getFunctionById(String functionId)
    Retrieves a Function from the repository based on the given function id.
    org.kuali.rice.krms.api.repository.function.FunctionDefinition
    getFunctionByNameAndNamespace(String name, String namespace)
    Retrieves a Function from the repository based on the provided function name and namespace.
    org.kuali.rice.krms.api.repository.function.FunctionDefinition
    updateFunction(org.kuali.rice.krms.api.repository.function.FunctionDefinition function)
    This will update an existing FunctionDefinition.

    Methods inherited from interface org.kuali.rice.krms.api.repository.function.FunctionRepositoryService

    getFunction, getFunctions

  • Method Details

    • createFunction

      org.kuali.rice.krms.api.repository.function.FunctionDefinition createFunction(org.kuali.rice.krms.api.repository.function.FunctionDefinition function)
      This will create a FunctionDefinition exactly like the function passed in.
      Parameters:
      function - The Function to create
      Throws:
      IllegalArgumentException - if the function is null
      IllegalStateException - if the function already exists in the system

    • updateFunction

      org.kuali.rice.krms.api.repository.function.FunctionDefinition updateFunction(org.kuali.rice.krms.api.repository.function.FunctionDefinition function)
      This will update an existing FunctionDefinition.
      Parameters:
      function - The Function to update
      Throws:
      IllegalArgumentException - if the function is null
      IllegalStateException - if the function does not exist in the system

    • getFunctionById

      org.kuali.rice.krms.api.repository.function.FunctionDefinition getFunctionById(String functionId)
      Retrieves a Function from the repository based on the given function id.
      Parameters:
      functionId - the id of the Function to retrieve
      Returns:
      a FunctionDefinition identified by the given functionId. A null reference is returned if an invalid or non-existent functionId is supplied.

    • getFunctionByNameAndNamespace

      org.kuali.rice.krms.api.repository.function.FunctionDefinition getFunctionByNameAndNamespace(String name, String namespace)
      Retrieves a Function from the repository based on the provided function name and namespace.
      Parameters:
      name - the name of the Function to retrieve.
      namespace - the namespace that the Function is under.
      Returns:
      a FunctionDefinition identified by the given name and namespace. A null reference is returned if an invalid or non-existent function name and namespace combination is supplied.