KimTypeInfoService

• getKimType
• findKimTypeByNameAndNamespace
• findAllKimTypes

• KimType

Method	getKimType
Description	Gets a {@link KimType} from a kim type id. This method will return null if the kim type does not exist.
Parameters	String	id	the id to retrieve the kim type by. cannot be null.
Return	KimType		a {@link KimType} or null
Errors	RiceIllegalArgumentException		if the id is null

Back to Operations

Method	findKimTypeByNameAndNamespace
Description	Gets a {@link 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	String	namespaceCode	the namespaceCode to retrieve the kim type by. cannot be null.
	String	name	the name to retrieve the kim type by. cannot be null.
Return	KimType		a {@link KimType} or null
Errors	RiceIllegalArgumentException		if the namespaceCode or name is null

Back to Operations

Method	findAllKimTypes
Description	Gets all the {@link KimType KimTypes}. This method will always return an immutable Collection even when no values exist. This method will only return active kim types.
Parameters	None	None	No Parameters
Return	KimTypeList		an immutable collection of kim types
Errors	NONE		No Errors

Back to Operations