org.kuali.student.r2.common.datadictionary
Class DataDictionaryServiceImpl

java.lang.Object
  org.kuali.student.r2.common.datadictionary.DataDictionaryServiceImpl

All Implemented Interfaces:

RiceDataDictionaryServiceInfc, DataDictionaryService

public class DataDictionaryServiceImpl
extends Object
implements DataDictionaryService, RiceDataDictionaryServiceInfc

Dictionary Service implementation that reads the dictionary from the spring beans and feeds both the Student dictionary and the RICE dictionary

Author:

nwright

Constructor Summary

DataDictionaryServiceImpl()

Method Summary

DictionaryEntryInfo	getDataDictionaryEntry(String entryKey, ContextInfo context) Get the data dictionary entry for the specified entry key.
List<String>	getDataDictionaryEntryKeys(ContextInfo context) Get the list of entry keys in this dictionary.
DataObjectEntry	getDataObjectEntry(String entryKey) Get the RICE data object for the specified entry key
String	getServiceNamespaceSuffix()
void	setDictionaryLocations(List<String> locations)
void	setServiceNamespaceSuffix(String serviceNamespaceSuffix)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataDictionaryServiceImpl

public DataDictionaryServiceImpl()

Method Detail

getServiceNamespaceSuffix

public String getServiceNamespaceSuffix()

setServiceNamespaceSuffix

public void setServiceNamespaceSuffix(String serviceNamespaceSuffix)

setDictionaryLocations

public void setDictionaryLocations(List<String> locations)
                            throws IOException

Throws:

IOException

getDataDictionaryEntry

public DictionaryEntryInfo getDataDictionaryEntry(String entryKey,
                                                  ContextInfo context)
                                           throws OperationFailedException,
                                                  MissingParameterException,
                                                  PermissionDeniedException,
                                                  DoesNotExistException

Description copied from interface: DataDictionaryService

Get the data dictionary entry for the specified entry key.

Specified by:

getDataDictionaryEntry in interface DataDictionaryService

Parameters:

entryKey - the identifier for the dictionary entry, this is done by specifying a refObjectURI

context - information containing the principalId and locale information about the caller of service operation

Returns:

the data dictionary entry requested

Throws:

OperationFailedException - unable to complete request

MissingParameterException - entryKey or contextInfo is missing or null

PermissionDeniedException - an authorization failure occurred

DoesNotExistException - entryKey is not found

getDataDictionaryEntryKeys

public List<String> getDataDictionaryEntryKeys(ContextInfo context)
                                        throws OperationFailedException,
                                               MissingParameterException,
                                               PermissionDeniedException

Description copied from interface: DataDictionaryService

Get the list of entry keys in this dictionary. The list of keys is stored in the ref object URI strcture E.g http://student.kuali.org/wsdl/cluService/CluInfo will be the objectTypeURI for the CluInfo structure The refObjectURI has three parts:

1. http://student.kuali.org/wsdl -- which is fixed
2. cluService -- which should match the namespace of the service in which the object is defined
3. CluInfo -- which should match the java class's simple name

Specified by:

getDataDictionaryEntryKeys in interface DataDictionaryService

Parameters:

context - information containing the principalId and locale information about the caller of service operation

Returns:

a list of all the known data dictionary entry keys in the ref object URI structure.

Throws:

OperationFailedException - unable to complete request

MissingParameterException - contextInfo is missing or null

PermissionDeniedException - an authorization failure occurred

getDataObjectEntry

public DataObjectEntry getDataObjectEntry(String entryKey)

Description copied from interface: RiceDataDictionaryServiceInfc

Get the RICE data object for the specified entry key

Specified by:

getDataObjectEntry in interface RiceDataDictionaryServiceInfc

Returns:

null if entry key not found