001/*
002 * Copyright 2011 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 1.0 (the
005 * "License"); you may not use this file except in compliance with the
006 * License.  You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl1.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
013 * implied.  See the License for the specific language governing
014 * permissions and limitations under the License.
015 */
016
017package org.kuali.student.r2.common.datadictionary.service;
018
019import java.util.List;
020import javax.jws.WebParam;
021import javax.jws.WebService;
022import javax.jws.soap.SOAPBinding;
023
024import org.kuali.student.r2.common.datadictionary.dto.DictionaryEntryInfo;
025import org.kuali.student.r2.common.dto.ContextInfo;
026
027import org.kuali.student.r2.common.exceptions.DoesNotExistException;
028import org.kuali.student.r2.common.exceptions.MissingParameterException;
029import org.kuali.student.r2.common.exceptions.OperationFailedException;
030import org.kuali.student.r2.common.exceptions.PermissionDeniedException;
031import org.kuali.student.r2.common.util.constants.DataDictionaryServiceConstants;
032
033/**
034 * Data Dictionary Service
035 *
036 * Provides a read-only view of meta data about the objects and fields
037 * on those objects that are known to the service for which the data
038 * dictionary is included.
039 *
040 * The dictionary service is aligned with Rice's KRAD dictionary, as
041 * such the dictionary structures should match up field for field.
042 *
043 * The Data Dictionary Service is an "included" service in that it is
044 * not expected to be a web service on it's own but instead it's
045 * methods simply appear (are "included") on the service that includes
046 * it.
047 *
048 * @version 0.0.7
049 *
050 * @author nwright
051 */
052
053@WebService(name = "DataDictionaryService", targetNamespace = DataDictionaryServiceConstants.NAMESPACE)
054@SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
055
056public interface DataDictionaryService {
057
058    /**
059     * Get the list of entry keys in this dictionary.
060     *
061     * The list of keys is stored in the ref object URI strcture E.g
062     * http://student.kuali.org/wsdl/cluService/CluInfo will be the
063     * objectTypeURI for the CluInfo structure The refObjectURI has
064     * three parts:<ol> <li>http://student.kuali.org/wsdl -- which is
065     * fixed <li>cluService -- which should match the namespace of the
066     * service in which the object is defined <li>CluInfo -- which
067     * should match the java class's simple name </ol>
068     *
069     * @param contextInfo information containing the principalId and
070     *        locale information about the caller of service operation
071     * @return a list of all the known data dictionary entry keys in
072     *         the ref object URI structure.
073     * @throws OperationFailedException unable to complete request
074     * @throws MissingParameterException contextInfo is missing or null
075     * @throws PermissionDeniedException an authorization failure occurred
076     */
077    public List<String> getDataDictionaryEntryKeys(@WebParam(name = "contextInfo") ContextInfo contextInfo) throws OperationFailedException, MissingParameterException, PermissionDeniedException;
078
079    /**
080     * Get the data dictionary entry for the specified entry key.
081     * 
082     * @param entryKey the identifier for the dictionary entry, this
083     *        is done by specifying a refObjectURI
084     * @param contextInfo information containing the principalId and
085     *        locale information about the caller of service operation
086     * @return the data dictionary entry requested
087     * @throws OperationFailedException unable to complete request
088     * @throws MissingParameterException entryKey or contextInfo is
089     *         missing or null
090     * @throws DoesNotExistException entryKey is not found
091     * @throws PermissionDeniedException an authorization failure occurred
092     */
093    public DictionaryEntryInfo getDataDictionaryEntry(@WebParam(name = "entryKey") String entryKey, @WebParam(name = "contextInfo") ContextInfo contextInfo) throws OperationFailedException, MissingParameterException, PermissionDeniedException, DoesNotExistException;
094}