All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.kuali.coeus.s2sgen.impl.print.S2SPrintable Maven / Gradle / Ivy

/*
 * Kuali Coeus, a comprehensive research administration system for higher education.
 * 
 * Copyright 2005-2015 Kuali, Inc.
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package org.kuali.coeus.s2sgen.impl.print;


import javax.xml.transform.Source;
import java.util.List;
import java.util.Map;

/**
 *
 * This interface marks reports, notifications, BOs and Documents as printable
 * in Kuali-Coeus. KC Docs & BOs that will be printed via KC printing services
 * should implement this interface.
 */
public interface S2SPrintable {

    /**
     *
     * This method provides a way to get the XSL Transform(s) for the KC
     * generated XML. This XSLT will create a transformed XML-FO stream that
     * will be converted to PDF. Note that multiple transforms are possible on
     * this data.
     */
    List getXSLTemplates();

    Map getXSLTemplateWithBookmarks();

    /**
     *
     * This method will provide the either reflected or XML-Bean based XML for
     * input to the Transform into XML-FO.
     */
    Map renderXML();

    /**
     * This method will return the PDF attachments specific to the printable.
     * During printing the attachments will be added as bookmarks to the output.
     * The Key in the map is used as the name of the bookmark.
     * @return Map of Attachment pdf bytes with bookmark names.
     */
    Map getAttachments();
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy