java.fedora.server.resourceIndex.MethodInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fcrepo-client Show documentation

The Fedora Client is a Java Library that allows API access to a Fedora Repository. The client is typically one part of a full Fedora installation.

The newest version!

/*
 * -----------------------------------------------------------------------------
 *
 * License and Copyright: The contents of this file are subject to 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.fedora-commons.org/licenses.
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
 * the specific language governing rights and limitations under the License.
 *
 * The entire file consists of original code.
 * Copyright © 2008 Fedora Commons, Inc.

 * 
Copyright © 2002-2007 The Rector and Visitors of the University of 
 * Virginia and Cornell University
 
 * All rights reserved.
 *
 * -----------------------------------------------------------------------------
 */
package fedora.server.resourceIndex;

import java.util.Set;

/**
 * Key information about an implemented service method.
 *
 * @author [email protected]
 */
public class MethodInfo {

    private String _name;

    private Set _bindingKeys;

    private Set _returnTypes;

    private Set _permutations;

    public MethodInfo(String name,
                      Set bindingKeys,
                      Set returnTypes,
                      Set permutations) {
        _name = name;
        _bindingKeys = bindingKeys;
        _returnTypes = returnTypes;
        _permutations = permutations;
    }

    public String getName() {
        return _name;
    }

    public Set getBindingKeys() {
        return _bindingKeys;
    }

    public Set getReturnTypes() {
        return _returnTypes;
    }

    /**
     * Return all permutations of the method.
     *
     * A "permutation" is a known runtime method invocation, and is formatted
     * as in the following examples:
     * 
     *    methodName
     *    methodName?parm1=val1&parm2=val1
     *    methodName?parm1=val1&parm2=val2
     *    methodName?parm1=val2&parm2=val1
     *    methodName?parm1=val2&parm2=val2
     * 
     *
     * @return the set of invokable permutations for the method.
     */
    public Set getPermutations() {
        return _permutations;
    }

}