com.sage.orion.sdata.servlet
Class IncludeSpecification

java.lang.Object
  com.sage.orion.sdata.servlet.IncludeSpecification

Deprecated. Use the QueryPayloadControl directly

@Deprecated
public class IncludeSpecification
extends java.lang.Object

An IncludeSpecification is the specification of which related resources should be included in a response. It embodies the include parameter of the request and is used in building payloads to decide what gets included. Call the saysInclude(String) to ask if a specific resource should be included.

Constructor Summary

IncludeSpecification(java.lang.String parameterValue)
Deprecated. Constructs an instance of the IncludeSpecification class based upon the request parameter.

Method Summary

boolean

saysInclude(java.lang.String path) Deprecated. Returns whether or not the related resource specified by the given resource path should be included in the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeSpecification

public IncludeSpecification(java.lang.String parameterValue)

Deprecated.

Constructs an instance of the IncludeSpecification class based upon the request parameter.

The parameter must already have been converted to a normal string form; any HTTP encoding etc. must already have been processed.

Parameters:

parameterValue - the value of the include parameter, suitably decoded, or null if there is none.

Method Detail

saysInclude

public boolean saysInclude(java.lang.String path)

Deprecated.

Returns whether or not the related resource specified by the given resource path should be included in the response.

Parameters:

path - the resource path to be checked.

Returns:

true if the resource specified by the path should be included in the response, false otherwise