org.kuali.student.r2.common.datadictionary.service

Interface DataDictionaryService

All Known Implementing Classes:

DataDictionaryServiceImpl

public interface DataDictionaryService

Data Dictionary Service Provides a read-only view of meta data about the objects and fields on those objects that are known to the service for which the data dictionary is included. The dictionary service is aligned with Rice's KRAD dictionary, as such the dictionary structures should match up field for field. The Data Dictionary Service is an "included" service in that it is not expected to be a web service on it's own but instead it's methods simply appear (are "included") on the service that includes it. Version: 1.0 (Dev)

Author:

nwright

Method Summary

Methods

Modifier and Type	Method and Description
DictionaryEntryInfo	getDataDictionaryEntry(String entryKey, ContextInfo contextInfo) Get the data dictionary entry for the specified entry key.
List<String>	getDataDictionaryEntryKeys(ContextInfo contextInfo) Get the list of entry keys in this dictionary.

Method Detail

getDataDictionaryEntryKeys

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

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

Parameters:

contextInfo - 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

getDataDictionaryEntry

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

Get the data dictionary entry for the specified entry key.

Parameters:

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

contextInfo - 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

DoesNotExistException - entryKey is not found

PermissionDeniedException - an authorization failure occurred