# $Id$
# $URL$
from PLC.Faults import *
from PLC.Method import Method
from PLC.Parameter import Parameter, Mixed
from PLC.Filter import Filter
from PLC.Routes import Route, Routes
from PLC.Auth import Auth

class GetRoutes(Method):
    """
    Returns an array of structs containing details about routes.
    If interfaces_filter is specified and is an array of
    interface identifiers, or a struct of interface fields and
    values, only interfaces matching the filter will be
    returned.

    If return_fields is given, only the specified details will be returned.
    """

    roles = ['admin', 'pi', 'user', 'tech', 'node', 'anonymous']

    accepts = [
        Auth(),
        Mixed([Mixed(Route.fields['route_id'])],
              Parameter (int, "route id"),
              Filter(Route.fields)),
        Parameter([str], "List of fields to return", nullok = True)
        ]

    returns = [Route.fields]

    def call(self, auth, route_filter = None, return_fields = None):
        return Routes(self.api, route_filter, return_fields)