org.globus.ws.enumeration
Class IterationConstraints

java.lang.Object
  org.globus.ws.enumeration.IterationConstraints

public class IterationConstraints
extends java.lang.Object

Represents the iteration constraints that can be specified on the pull operation of WS-Enumeration.

Field Summary

static IterationConstraints	DEFAULT_CONSTRAINTS Default constraints (maxElements set to 1, no maxTime limit and no maxCharacters limit).
private static org.globus.util.I18n	i18n
private int	maxCharacters
private int	maxElements
private org.apache.axis.types.Duration	maxTime

Constructor Summary

IterationConstraints()
Creates IterationConstraints with the default settings (maxElements set to 1, no maxTime limit and no maxCharacters limit).

IterationConstraints(int maxElements, int maxCharacters, org.apache.axis.types.Duration maxTime)
Creates IterationConstraints with the specified settings.

Method Summary

int	getMaxCharacters() Returns the maximum number of characters (in Unicode) that the consumer can accept.
int	getMaxElements() Returns the maximum number of elements that the consumer can accept.
org.apache.axis.types.Duration	getMaxTime() Returns the maximum amount of time the consumer is willing to wait for a response.

Methods inherited from class java.lang.Object

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

Field Detail

i18n

private static org.globus.util.I18n i18n

DEFAULT_CONSTRAINTS

public static final IterationConstraints DEFAULT_CONSTRAINTS

Default constraints (maxElements set to 1, no maxTime limit and no maxCharacters limit).

maxElements

private int maxElements

maxCharacters

private int maxCharacters

maxTime

private org.apache.axis.types.Duration maxTime

Constructor Detail

IterationConstraints

public IterationConstraints()

Creates IterationConstraints with the default settings (maxElements set to 1, no maxTime limit and no maxCharacters limit).

IterationConstraints

public IterationConstraints(int maxElements,
                            int maxCharacters,
                            org.apache.axis.types.Duration maxTime)

Creates IterationConstraints with the specified settings.

Parameters:

maxElements - the maxiumum number of elements that the consumer can accept.

maxCharacters - the maximum number of characters (in Unicode) that the consumer can accept.

maxTime - the maximum amount of time that the consumer is willing to wait for a response.

Throws:

java.lang.IllegalArgumentException - if any of the parameters values is invalid

Method Detail

getMaxElements

public int getMaxElements()

Returns the maximum number of elements that the consumer can accept.

Returns:

the maximum number of elements that the consumer can accept.

getMaxCharacters

public int getMaxCharacters()

Returns the maximum number of characters (in Unicode) that the consumer can accept.

Returns:

the maximum number of characters (in Unicode) that the consumer can accept. Returns less then 0 if not set (no limit on size).

getMaxTime

public org.apache.axis.types.Duration getMaxTime()

Returns the maximum amount of time the consumer is willing to wait for a response.

Returns:

the maximum amount of time the consumer is willing to wait for a response. Returns less then 0 if not set (no time limit).