DataDictionaryService

Name	DataDictionary
Version	1.0 (Dev)
Included Services
Java Package	org.kuali.student.r2.common.datadictionary.service

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.

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://student.kuali.org/wsdl/luService/CluInfo will be the
objectTypeURI for the CluInfo structure The refObjectURI has
three parts:

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

Parameters ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation

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

Errors OperationFailedException unable to complete request

MissingParameterException contextInfo is missing or null

PermissionDeniedException an authorization failure occurred

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://student.kuali.org/wsdl/luService/CluInfo will be the objectTypeURI for the CluInfo structure The refObjectURI has three parts: http://student.kuali.org/wsdl -- which is fixed luService -- which should match the namespace of the service in which the object is defined CluInfo -- which should match the java class's simple name
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StringList	a list of all the known data dictionary entry keys in the ref object URI structure.
Errors	OperationFailedException	unable to complete request
MissingParameterException	contextInfo is missing or null
PermissionDeniedException	an authorization failure occurred

Back to Operations

Method getDataDictionaryEntry

Description Get the data dictionary entry for the specified entry key.

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

ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation

Return DictionaryEntryInfo the data dictionary entry requested

Errors OperationFailedException unable to complete request

MissingParameterException entryKey or contextInfo is
missing or null

PermissionDeniedException an authorization failure occurred

DoesNotExistException entryKey is not found

Method	getDataDictionaryEntry
Description	Get the data dictionary entry for the specified entry key.
Parameters	String	entryKey	the identifier for the dictionary entry, this is done by specifying a refObjectURI
ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	DictionaryEntryInfo	the data dictionary entry requested
Errors	OperationFailedException	unable to complete request
MissingParameterException	entryKey or contextInfo is missing or null
PermissionDeniedException	an authorization failure occurred
DoesNotExistException	entryKey is not found

Back to Operations