Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
 /*
  * Copyright 2011 The Kuali Foundation
  *
  * Licensed under the Educational Community License, Version 1.0 (the
  * "License"); you may not use this file except in compliance with the
  * License.  You may obtain a copy of the License at
  *
  * http://www.opensource.org/licenses/ecl1.php
  *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied.  See the License for the specific language governing
 * permissions and limitations under the License.
 */
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.

Author(s):
nwright
Version:
0.0.7
@WebService(name = "DataDictionaryService", targetNamespace = .)
public 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

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:
org.kuali.student.r2.common.exceptions.OperationFailedException unable to complete request
org.kuali.student.r2.common.exceptions.MissingParameterException contextInfo is missing or null
org.kuali.student.r2.common.exceptions.PermissionDeniedException an authorization failure occurred
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:
org.kuali.student.r2.common.exceptions.OperationFailedException unable to complete request
org.kuali.student.r2.common.exceptions.MissingParameterException entryKey or contextInfo is missing or null
org.kuali.student.r2.common.exceptions.DoesNotExistException entryKey is not found
org.kuali.student.r2.common.exceptions.PermissionDeniedException an authorization failure occurred
    public DictionaryEntryInfo getDataDictionaryEntry(@WebParam(name = "entryKey"String entryKey, @WebParam(name = "contextInfo"ContextInfo contextInfothrows OperationFailedExceptionMissingParameterExceptionPermissionDeniedExceptionDoesNotExistException;
New to GrepCode? Check out our FAQ X