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

Interface KrmsTypeBoService

public interface KrmsTypeBoService

  • Method Details

    • createKrmsType

      KrmsTypeDefinition createKrmsType(KrmsTypeDefinition krmsType) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException, org.kuali.rice.core.api.exception.RiceIllegalStateException
      This will create a KrmsTypeDefinition exactly like the parameter passed in.
      Parameters:
      krmsType - - KrmsType
      Throws:
      IllegalArgumentException - if the krmsType is +
      IllegalStateException - if the KrmsType already exists in the system
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      org.kuali.rice.core.api.exception.RiceIllegalStateException

    • updateKrmsType

      KrmsTypeDefinition updateKrmsType(KrmsTypeDefinition krmsType) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException, org.kuali.rice.core.api.exception.RiceIllegalStateException
      This will update an existing KrmsTypeDefinition
      Parameters:
      krmsType - - KrmsType
      Throws:
      IllegalArgumentException - if the krmsType is null
      IllegalStateException - if the KrmsType does not exist in the system
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      org.kuali.rice.core.api.exception.RiceIllegalStateException

    • getTypeById

      KrmsTypeDefinition getTypeById(String id) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Lookup a krms type based on the given id.
      Parameters:
      id - the given KRMS type id
      Returns:
      a KRMS KrmsType object with the given id. A null reference is returned if an invalid or non-existant id is supplied.
      Throws:
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException

    • getTypeByName

      KrmsTypeDefinition getTypeByName(String namespaceCode, String name) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException, org.kuali.rice.core.api.exception.RiceIllegalStateException
      Get a krms type object based on name and namespace
      Parameters:
      namespaceCode - the given type namespace
      name - the given type name
      Returns:
      A krms type object with the given namespace and name if one with that name and namespace exists. Otherwise, null is returned.
      Throws:
      IllegalArgumentException - if the given namespaceCode or name is a null or blank value
      IllegalStateException - if multiple krms types exist with the same name and namespace
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      org.kuali.rice.core.api.exception.RiceIllegalStateException

    • findAllTypesByNamespace

      List<KrmsTypeDefinition> findAllTypesByNamespace(String namespaceCode) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Returns all KRMS types that for a given namespace.
      Returns:
      all KRMS types for a namespace
      Throws:
      IllegalArgumentException - if the given namespaceCode is a null or blank value
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException

    • findAllTypesByServiceName

      List<KrmsTypeDefinition> findAllTypesByServiceName(String serviceName) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Returns all KRMS types that for a given serviceName.
      Returns:
      all KRMS types for a serviceName
      Throws:
      IllegalArgumentException - if the given serviceName is a null or blank value
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException

    • findAllTypes

      List<KrmsTypeDefinition> findAllTypes()
      Returns all KRMS types
      Returns:
      all KRMS types

    • findAllAgendaTypesByContextId

      List<KrmsTypeDefinition> findAllAgendaTypesByContextId(String contextId) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Returns all agenda types for the given contextId.
      Parameters:
      contextId - the id of the context
      Returns:
      all agenda types for the given contextId
      Throws:
      IllegalArgumentException - if the given contextId is a null or blank value
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException

    • getAgendaTypeByAgendaTypeIdAndContextId

      KrmsTypeDefinition getAgendaTypeByAgendaTypeIdAndContextId(String agendaTypeId, String contextId) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Return the agenda type by agendaItemId for the given contextId.
      Parameters:
      agendaTypeId - the id of the agendaType
      contextId - the id of the context
      Returns:
      agendaType or null if none is found
      Throws:
      IllegalArgumentException - if the given agendaTypeId or contextId is a null or blank value
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException

    • findAllRuleTypesByContextId

      List<KrmsTypeDefinition> findAllRuleTypesByContextId(String contextId) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Returns all rule types for the given contextId.
      Parameters:
      contextId - the id of the context
      Returns:
      all rule types for the given contextId
      Throws:
      IllegalArgumentException - if the given contextId is a null or blank value
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException

    • getRuleTypeByRuleTypeIdAndContextId

      KrmsTypeDefinition getRuleTypeByRuleTypeIdAndContextId(String ruleTypeId, String contextId) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Return the rule type by ruleItemId for the given contextId.
      Parameters:
      ruleTypeId - the id of the ruleType
      contextId - the id of the context
      Returns:
      ruleType or null if none is found
      Throws:
      IllegalArgumentException - if the given ruleTypeId or contextId is a null or blank value
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException

    • findAllActionTypesByContextId

      List<KrmsTypeDefinition> findAllActionTypesByContextId(String contextId) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Returns all action types for the given contextId.
      Parameters:
      contextId - the id of the context
      Returns:
      all action types for the given contextId
      Throws:
      IllegalArgumentException - if the given contextId is a null or blank value
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException

    • getActionTypeByActionTypeIdAndContextId

      KrmsTypeDefinition getActionTypeByActionTypeIdAndContextId(String actionTypeId, String contextId) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Return the action type by actionItemId for the given contextId.
      Parameters:
      actionTypeId - the id of the actionType
      contextId - the id of the context
      Returns:
      actionType or null if none is found
      Throws:
      IllegalArgumentException - if the given actionTypeId or contextId is a null or blank value
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException

    • getAttributeDefinitionById

      KrmsAttributeDefinition getAttributeDefinitionById(String attributeDefinitionId) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Retrieves an attribute definition for the given id.
      Parameters:
      attributeDefinitionId - the id of the attribute definition to retrieve
      Returns:
      the attribute definition matching the given id, or null if no corresponding attribute definition could be found with the given id value
      Throws:
      IllegalArgumentException - if the given attributeDefinitionId is a null or blank value
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException

    • getAttributeDefinitionByName

      KrmsAttributeDefinition getAttributeDefinitionByName(String namespaceCode, String name) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Retrieves an attribute definition for the given namespace code and name.
      Parameters:
      namespaceCode - the namespace under which to locate the attribute definition
      name - the name of the attribute definition to retrieve
      Returns:
      the attribute definition matching the give namespace code and name, or null if no corresponding attribute definition could be located
      Throws:
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if the given namespaceCode or name is a null or blank value