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

Interface ContextBoService

All Known Implementing Classes:
ContextBoServiceImpl
public interface ContextBoService
This is the interface for accessing KRMS repository Context related bos
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Summary

    Modifier and Type
    Method
    Description
    org.kuali.rice.krms.api.repository.context.ContextDefinition
    createContext(org.kuali.rice.krms.api.repository.context.ContextDefinition context)
    This will create a ContextDefinition exactly like the parameter passed in.
    org.kuali.rice.krms.api.repository.context.ContextDefinition
    getContextByContextId(String contextId)
    Retrieves an Context from the repository based on the given context id.
    org.kuali.rice.krms.api.repository.context.ContextDefinition
    getContextByNameAndNamespace(String name, String namespace)
    Retrieves an Context from the repository based on the provided context name and namespace.
    org.kuali.rice.krms.api.repository.context.ContextDefinition
    updateContext(org.kuali.rice.krms.api.repository.context.ContextDefinition context)
    This will update an existing ContextDefinition.

  • Method Details

    • createContext

      @CacheEvict(value="http://rice.kuali.org/krms/v2_0/ContextDefinitionType", allEntries=true) org.kuali.rice.krms.api.repository.context.ContextDefinition createContext(org.kuali.rice.krms.api.repository.context.ContextDefinition context)
      This will create a ContextDefinition exactly like the parameter passed in.
      Parameters:
      context - The Context to create
      Throws:
      IllegalArgumentException - if the context is null
      IllegalStateException - if the context already exists in the system

    • updateContext

      @CacheEvict(value="http://rice.kuali.org/krms/v2_0/ContextDefinitionType", allEntries=true) org.kuali.rice.krms.api.repository.context.ContextDefinition updateContext(org.kuali.rice.krms.api.repository.context.ContextDefinition context)
      This will update an existing ContextDefinition.
      Parameters:
      context - The Context to update
      Throws:
      IllegalArgumentException - if the Context is null
      IllegalStateException - if the Context does not exists in the system

    • getContextByContextId

      @Cacheable(value="http://rice.kuali.org/krms/v2_0/ContextDefinitionType", key="\'actionId=\' + #p0") org.kuali.rice.krms.api.repository.context.ContextDefinition getContextByContextId(String contextId)
      Retrieves an Context from the repository based on the given context id.
      Parameters:
      contextId - the id of the Context to retrieve
      Returns:
      an ContextDefinition identified by the given contextId. A null reference is returned if an invalid or non-existent id is supplied.
      Throws:
      IllegalArgumentException - if the contextId is null or blank.

    • getContextByNameAndNamespace

      @Cacheable(value="http://rice.kuali.org/krms/v2_0/ContextDefinitionType", key="\'name=\' + #p0 + \'|\' + \'namespace=\' + #p1") org.kuali.rice.krms.api.repository.context.ContextDefinition getContextByNameAndNamespace(String name, String namespace)
      Retrieves an Context from the repository based on the provided context name and namespace.
      Parameters:
      name - the name of the Context to retrieve.
      namespace - the namespace that the context is under.
      Returns:
      an ContextDefinition identified by the given name and namespace. A null reference is returned if an invalid or non-existent name and namespace combination is supplied.
      Throws:
      IllegalArgumentException - if the either the name or the namespace is null or blank.