org.kuali.rice.kim.api.type
Interface KimTypeInfoService

All Known Implementing Classes:
KimTypeInfoServiceImpl

public interface KimTypeInfoService

This service provides read operations for KimType

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

Method Summary
 Collection<KimType> findAllKimTypes()
          Gets all the KimTypes.
 KimType findKimTypeByNameAndNamespace(String namespaceCode, String name)
          Gets a KimType from a kim type name and namespace code.
 KimType getKimType(String id)
          Gets a KimType from a kim type id.
 

Method Detail

getKimType

@Cacheable(value="http://rice.kuali.org/kim/v2_0/KimTypeType",
           key="\'id=\' + #p0")
KimType getKimType(String id)
                   throws RiceIllegalArgumentException
Gets a KimType from a kim type id.

This method will return null if the kim type does not exist.

Parameters:
id - the id to retrieve the kim type by. cannot be null.
Returns:
a KimType or null
Throws:
RiceIllegalArgumentException - if the id is null

findKimTypeByNameAndNamespace

@Cacheable(value="http://rice.kuali.org/kim/v2_0/KimTypeType",
           key="\'namespaceCode=\' + #p0 + \'|\' + \'name=\' + #p1")
KimType findKimTypeByNameAndNamespace(String namespaceCode,
                                                String name)
                                      throws RiceIllegalArgumentException
Gets a KimType from a kim type name and namespace code.

This method will return null if the kim type does not exist.

This method will only return active kim types.

Parameters:
namespaceCode - the namespaceCode to retrieve the kim type by. cannot be null.
name - the name to retrieve the kim type by. cannot be null.
Returns:
a KimType or null
Throws:
RiceIllegalArgumentException - if the namespaceCode or name is null
IllegalStateException - if multiple active results are found for a namespaceCode and name

findAllKimTypes

@Cacheable(value="http://rice.kuali.org/kim/v2_0/KimTypeType",
           key="\'all\'")
Collection<KimType> findAllKimTypes()
Gets all the KimTypes.

This method will always return an immutable Collection even when no values exist.

This method will only return active kim types.

Returns:
an immutable collection of kim types


Copyright © 2005-2013 The Kuali Foundation. All Rights Reserved.