Child pages
  • Integrating the Courses Portlet with Your SIS and/or LMS
Skip to end of metadata
Go to start of metadata

Pluggable, Interface-Based Abstraction

Data sources for portlets in the Courses Portlet project leverage a common paradigm in Apereo portlet development – a pluggable, interface-based abstraction.  The interface for the contained portlet named 'Courses' (for example) is ICoursesDao...

ICoursesDao as of 2014/08/12
/**
 * Licensed to Jasig under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Jasig licenses this file to you under the Apache 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.apache.org/licenses/LICENSE-2.0
 *
 * 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.jasig.portlet.courses.dao;

import javax.portlet.PortletRequest;

import org.jasig.portlet.courses.model.xml.TermList;
import org.jasig.portlet.courses.model.xml.personal.CoursesByTerm;

/**
 * ICoursesDao represents a data access interface for retrieving course and
 * grade data for a particular user.
 * 
 * @author Jen Bourey, jennifer.bourey@gmail.com
 * @version $Revision$
 */
public interface ICoursesDao {

    /**
     * Get a term list for the current user
     * 
     * @param request
     * @return
     */
    public TermList getTermList(PortletRequest request);

    /**
     * Get courses for a term for the current user
     * 
     * @param request
     * @return
     */
    public CoursesByTerm getCoursesByTerm(PortletRequest request, String termCode);
    
}

You can integrate the 'Courses' portlet with any SIS and/or LMS by providing a custom implementation of this Java interface and wiring it appropriately in the applicationContext.xml Spring configuration file for the webapp.  Define a Spring <bean> based on your implementation class and add it as a child of the 'courseDaos' (list) bean.  A couple examples are provided in the file to illustrate the process. 

  • No labels