home

DataDictionaryService

Name DataDictionary
Version 1.0 (Dev)
Included Services  

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.

Operations
Main Message Structures

Method getDataDictionaryEntryKeys
Description Get the list of entry keys in this dictionary

The list of keys is stored in the ref object URI strcture
E.g http://stduent.kuali.org/LuService/CluInfo will be the objectTypeURI for the CluInfo structure
The refObjectURI has three parts:

  1. http://stduent.kuali.org/ -- which is fixed
  2. LuService -- 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 context information about the user and locale
Return StringList a list of all the known data dictionary entry keys in the ref object URI structure.
Errors OperationFailedException if could not complete the operation
MissingParameterException if entryKey is null
PermissionDeniedException if user does not have permission to call this method

Back to Operations

Method getDataDictionaryEntry
Description Get the data dictionary entry for the specified entry key
Parameters String entryKey that identifies the dictionary entry, this is done by specifying
a refObjectURI
ContextInfo context information about the user and locale
Return DictionaryEntryInfo the data dictionary entry key
Errors OperationFailedException if could not complete the operation
MissingParameterException if entryKey is null
PermissionDeniedException if user does not have permission to call this method
DoesNotExistException if entryKey does not exist in the dictionary

Back to Operations