fedora.client.objecteditor.types
Class MethodDefinition

java.lang.Object
  fedora.client.objecteditor.types.MethodDefinition

public class MethodDefinition
extends java.lang.Object

Defines a method that an object exposes via Fedora. A behavior definition object specifies this.

Constructor Summary

MethodDefinition(java.lang.String name, java.lang.String label, java.util.List parameterDefinitions)
Initialize a MethodDefinition object with all values.

Method Summary

java.lang.String	getLabel() Get a short description of the method.
java.lang.String	getName() Get the name of the method.
java.util.List	parameterDefinitions() Get the method's list of ParameterDefinitions.
static java.util.List	parse(java.io.InputStream xml) Parse a stream of XML and return the list of method definitions defined therein.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MethodDefinition

public MethodDefinition(java.lang.String name,
                        java.lang.String label,
                        java.util.List parameterDefinitions)

Initialize a MethodDefinition object with all values.

Method Detail

parse

public static java.util.List parse(java.io.InputStream xml)
                            throws java.io.IOException

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.

 <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>
 

Throws:

java.io.IOException

getName

public java.lang.String getName()

Get the name of the method.

getLabel

public java.lang.String getLabel()

Get a short description of the method. This may be null.

parameterDefinitions

public java.util.List parameterDefinitions()

Get the method's list of ParameterDefinitions. If the method takes no parameters, this will be an empty list.