/*

  * Copyright 2005-2007 The Kuali Foundation

  * 

  * 

  * Licensed under the Educational Community License, Version 2.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/ecl2.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.rice.core.api.style;

 import java.util.List;

 import javax.jws.WebMethod;

 import javax.jws.WebParam;

 import javax.jws.WebResult;

 import javax.jws.WebService;

 import javax.jws.soap.SOAPBinding;

 import org.kuali.rice.core.api.CoreConstants;

 import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;

 /**

  * Service for interacting with {@link Style} data. This service primarily

  * consists of pure data-access operations on a repository of styles which are

  * accessible based on their name or id which are both unique.

  * 

  * @author Kuali Rice Team (rice.collab@kuali.org)

  */

 @WebService(name = "styleRepositoryServiceSoap", targetNamespace = CoreConstants.Namespaces.CORE_NAMESPACE_2_0)

 @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)

 public interface StyleRepositoryService {

         /**

          * Returns the style with the given name.  If no style with the given name

          * can be found, this method will return null.

          * 

          * @param styleName the name of the style to retrieve, must not be null or

          * blank

          * 

          * @return the style with the given name, or null if no style with the given

          * name could be found

          * 

          * @throws IllegalArgumentException if the given styleName is null or blank

          */

         @WebMethod(operationName = "getStyle")

         @WebResult(name = "style")

         public Style getStyle(@WebParam(name = "styleName") String styleName) throws RiceIllegalArgumentException;

         /**

          * Creates or updates the Style represented by the given record.  If the

          * styleId on the style is not null, then it will update the existing

          * style record which has that id.  Otherwise it will create a new style in

          * the repository.

          * 

          * <p>When updating an existing style, the caller needs to ensure that the

          * styleId, versionNumber, and objectId values are set on the given Style

          * object.

          * 

          * @param style the style data to create or update in the repository

          * 

          * @return the style with the given name, or null if no style with the given

          * name could be found

          * 

          * @throws IllegalArgumentException if the given style is null

          */

         @WebMethod(operationName = "saveStyle")

         public void saveStyle(@WebParam(name = "style") Style style) throws RiceIllegalArgumentException;

         /**

          * Returns a list of the names for all active styles in the repository. If

          * there are no active styles, this list will be empty.  It will never

          * return null.

          * 

          * @return the list of names for all active styles

          */

         @WebMethod(operationName="getStyleNames")

     @WebResult(name = "styleNames")

     public List<String> getAllStyleNames();

 }