/* The contents of this file are subject to the license and copyright terms
 * detailed in the license directory at the root of the source tree (also 
 * available online at http://fedora-commons.org/license/).
 */
package fedora.client.objecteditor.types;

import java.io.IOException;
import java.io.InputStream;

import java.util.List;

/**
 * Defines a method that an object exposes via Fedora. A service definition
 * object specifies this.
 */
public class MethodDefinition {

    private final String m_name;

    private final String m_label;

    private final List m_parameterDefinitions;

    /**
     * Initialize a MethodDefinition object with all values.
     */
    public MethodDefinition(String name, String label, List parameterDefinitions) {
        m_name = name;
        m_label = label;
        m_parameterDefinitions = parameterDefinitions;
    }

    /**
     * Parse a stream of XML and return the list of method definitions defined
     * therein. The parsing is very relaxed. The xml may, but needn't be
     * namespace-qualified, and will only be validated according to the rules
     * implied below in parentheses.
     * 
     * <pre>
     * <Method operationName="METHOD_NAME" 
     *                 label="METHOD_LABEL"(0-1)>
     *     <UserInputParm parmName="PARAMETER_NAME" 
     *                       label="PARAMETER_LABEL"(0-1)
     *                    required="IS_REQUIRED"
     *                defaultValue="DEFAULT_VALUE">
     *         <ValidParmValues>(0-1)
     *             <ValidParm value="VALID_VALUE_1"/>(0-)
     *         </ValidParmValues>
     *     </UserInputParm>(0-) 
     * </Method>
     * </pre>
     */
    public static List parse(InputStream xml) throws IOException {
        return new MethodDefinitionsDeserializer(xml).getResult();
    }

    /**
     * Get the name of the method.
     */
    public String getName() {
        return m_name;
    }

    /**
     * Get a short description of the method. This may be null.
     */
    public String getLabel() {
        return m_label;
    }

    /**
     * Get the method's list of <code>ParameterDefinition</code>s. If the
     * method takes no parameters, this will be an empty list.
     */
    public List parameterDefinitions() {
        return m_parameterDefinitions;
    }

}