com.sage.orion.sdata.servlet
Class SDataConstants

java.lang.Object
  extended by com.sage.orion.sdata.servlet.SDataConstants

public final class SDataConstants
extends java.lang.Object

Constants in the SData system


Nested Class Summary
static class SDataConstants.KeyDirection
          The possible directions for key-based indexing
 
Field Summary
static java.lang.String AND_OPERATOR
          and
static java.nio.charset.Charset ASCII_CHARSET
          The ASCII character set
static java.lang.String BASE_BATCH
          batch, the term used for a resource kind batch operation, without the $ decoration
static java.lang.String BASE_SCHEMA
          schema, the term used for a resource kind schema operation, without the $ decoration
static java.lang.String BASE_SERVICE
          service, the term used for a resource kind service operation, without the $ decoration
static java.lang.String BASE_TEMPLATE
          template, the term used for the template resource kind, without the $ decoration
static java.lang.String BATCH
          $batch, the term used for a resource kind batch operation
static java.lang.String CACHE_HEADER
          The tag for setting the cache control in the HTTP response header
static java.lang.String CHILDREN
          $children, the term used to signify all child resources in the Include request parameter
static java.lang.String COMMA_OPERATOR
          comma operator
static java.lang.String COUNT_PARAMETER
          count
static java.lang.String DDASH
          The separator used in forming schema element names
static java.lang.String DDASH_ENUM
          The addition used in forming enum names in schemas
static java.lang.String DDASH_LIST
          The addition used in forming list names in schemas
static java.lang.String DDASH_TYPE
          The addition used in forming type names in schemas
static java.lang.String DEFAULT_CACHE_CONTROL
          By default we will not ask the browser to cache the HTTP response
static char DEFAULT_DATASET
          The hyphen symbol used to denote the default dataset in a URL
static java.lang.String DESCRIPTORS
           
static java.lang.String EQUALS_OPERATOR
          equals
static java.lang.String FALSE_VALUE
          false
static java.lang.String FORMAT_PARAMETER
          format
static java.lang.String GREATER_THAN_OPERATOR
          greater than
static java.lang.String GREATER_THAN_OR_EQUAL_OPERATOR
          greater than or equal
static java.lang.String HTTP_HEADER_APPLICATION_GUID
          The HTTP header name reserved for a GUID that is associated with some sort of application-specific material.
static java.lang.String HTTP_HEADER_BASE
          The base value for all HTTP headers used in SData that are not standard HTTP headers.
static java.lang.String HTTP_HEADER_SSO_GUID
          The HTTP header name reserved for a GUID that is associated with a Single Sign-on token.
static java.lang.String IF_MATCH
          the name of the HTTP header used for concurrency handling.
static java.lang.String IN_OPERATOR
          in
static java.lang.String INCLUDE_PARAMETER
          include
static java.lang.String KEYDIRECTION_PARAMETER
          key direction
static java.lang.String LANGUAGE_PARAMETER
          language
static java.lang.String LEFT_BRACE_OPERATOR
          left brace operator
static java.lang.String LESS_THAN_OPERATOR
          less than operator
static java.lang.String LESS_THAN_OR_EQUAL_OPERATOR
          less then or equal
static java.lang.String LIKE_OPERATOR
          like
static java.lang.String MINIUS_OPERATOR
          minus
static java.lang.String MULTIPLY_OPERATOR
          multiply
static java.lang.String NO_VALUE
          no value
static java.lang.String NOT_EQUALS_OPERATOR
          not equals
static java.lang.String NOT_OPERATOR
          not
static java.lang.String OR_OPERATOR
          or
static java.lang.String ORDERBY_DESC_PARAMETER
          order descending
static java.lang.String ORDERBY_PARAMETER
          order by
static java.lang.String PLUS_OPERATOR
          plus
static java.lang.String PRECEDENCE_PARAMETER
          precedence
static java.lang.String REQUEST_TAG
          Request tag
static java.lang.String REQUEST_TYPE_TAG
          Request type tag
static java.lang.String RESPONSE_TAG
          Response tag
static java.lang.String RESPONSE_TYPE_TAG
          Response type tag
static java.lang.String RETURN_DELTA_PARAMETER
          return delta
static java.lang.String RIGHT_BRACE_OPERATOR
          right brace operator
static java.lang.String SCHEMA
          $schema, the term used for a resource kind schema operation
static java.lang.String SDATA
          The term 'sdata' which is used in a couple of places
static java.lang.String SDATA_HTTP_IFMATCH
          the tag name for the SData Atom Extension http:ifMatch, which can be specified in an entry of a batch request feed to provide the IF_MATCH value for the entry.
static java.lang.String SDATA_NAMESPACE_TAG
          xmlns:sdata
static java.lang.String SDATA_NAMESPACE_VALUE
          the value for tag "xmlns:sdata"
static java.lang.String SDATA_PART_TAG
          :sdata
static java.lang.String SEARCH_PARAMETER
          search
static java.lang.String SELECT_PARAMETER
          select
static java.lang.String SERVICE
          $service, the term used for a resource kind service operation
static java.lang.String SERVICE_OPERATION_TAG
          Service Operation tag
static char SPECIAL
          The dollar symbol used to flag an SData term as special
static java.lang.String STARTINDEX_PARAMETER
          start index
static java.lang.String STARTKEY_PARAMETER
          Non- SData Parameters ...
static java.lang.String SYSTEM
          $system, the term used for the system resource kinds
static java.lang.String TEMPLATE
          $template, the term used for the special template resource kind
static java.lang.String TRACKINGID_PARAMETER
          tracking id
static java.lang.String TRUE_VALUE
          true
static java.lang.String VERSION_PARAMETER
          version
static java.lang.String WHERE_PARAMETER
          where
static java.lang.String WITH_SCHEMA_PARAMETER
          include schema
static java.lang.String XML_NAMESPACE_TAG
          xmlns
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CACHE_HEADER

public static final java.lang.String CACHE_HEADER
The tag for setting the cache control in the HTTP response header

See Also:
Constant Field Values

DEFAULT_CACHE_CONTROL

public static final java.lang.String DEFAULT_CACHE_CONTROL
By default we will not ask the browser to cache the HTTP response

See Also:
Constant Field Values

ASCII_CHARSET

public static final java.nio.charset.Charset ASCII_CHARSET
The ASCII character set


SDATA

public static final java.lang.String SDATA
The term 'sdata' which is used in a couple of places

See Also:
Constant Field Values

DEFAULT_DATASET

public static final char DEFAULT_DATASET
The hyphen symbol used to denote the default dataset in a URL

See Also:
Constant Field Values

SPECIAL

public static final char SPECIAL
The dollar symbol used to flag an SData term as special

See Also:
Constant Field Values

BASE_TEMPLATE

public static final java.lang.String BASE_TEMPLATE
template, the term used for the template resource kind, without the $ decoration

See Also:
Constant Field Values

TEMPLATE

public static final java.lang.String TEMPLATE
$template, the term used for the special template resource kind

See Also:
Constant Field Values

BASE_SERVICE

public static final java.lang.String BASE_SERVICE
service, the term used for a resource kind service operation, without the $ decoration

See Also:
Constant Field Values

SERVICE

public static final java.lang.String SERVICE
$service, the term used for a resource kind service operation

See Also:
Constant Field Values

BASE_SCHEMA

public static final java.lang.String BASE_SCHEMA
schema, the term used for a resource kind schema operation, without the $ decoration

See Also:
Constant Field Values

SCHEMA

public static final java.lang.String SCHEMA
$schema, the term used for a resource kind schema operation

See Also:
Constant Field Values

BASE_BATCH

public static final java.lang.String BASE_BATCH
batch, the term used for a resource kind batch operation, without the $ decoration

See Also:
BATCH, Constant Field Values

BATCH

public static final java.lang.String BATCH
$batch, the term used for a resource kind batch operation

See Also:
Constant Field Values

CHILDREN

public static final java.lang.String CHILDREN
$children, the term used to signify all child resources in the Include request parameter

See Also:
Constant Field Values

DESCRIPTORS

public static final java.lang.String DESCRIPTORS
See Also:
Constant Field Values

SYSTEM

public static final java.lang.String SYSTEM
$system, the term used for the system resource kinds

See Also:
Constant Field Values

XML_NAMESPACE_TAG

public static final java.lang.String XML_NAMESPACE_TAG
xmlns

See Also:
Constant Field Values

SDATA_PART_TAG

public static final java.lang.String SDATA_PART_TAG
:sdata

See Also:
Constant Field Values

SDATA_NAMESPACE_TAG

public static final java.lang.String SDATA_NAMESPACE_TAG
xmlns:sdata

See Also:
Constant Field Values

SDATA_NAMESPACE_VALUE

public static final java.lang.String SDATA_NAMESPACE_VALUE
the value for tag "xmlns:sdata"

See Also:
Constant Field Values

DDASH

public static final java.lang.String DDASH
The separator used in forming schema element names

See Also:
Constant Field Values

DDASH_LIST

public static final java.lang.String DDASH_LIST
The addition used in forming list names in schemas

See Also:
Constant Field Values

DDASH_TYPE

public static final java.lang.String DDASH_TYPE
The addition used in forming type names in schemas

See Also:
Constant Field Values

DDASH_ENUM

public static final java.lang.String DDASH_ENUM
The addition used in forming enum names in schemas

See Also:
Constant Field Values

SERVICE_OPERATION_TAG

public static final java.lang.String SERVICE_OPERATION_TAG
Service Operation tag

See Also:
Constant Field Values

REQUEST_TAG

public static final java.lang.String REQUEST_TAG
Request tag

See Also:
Constant Field Values

RESPONSE_TAG

public static final java.lang.String RESPONSE_TAG
Response tag

See Also:
Constant Field Values

REQUEST_TYPE_TAG

public static final java.lang.String REQUEST_TYPE_TAG
Request type tag

See Also:
Constant Field Values

RESPONSE_TYPE_TAG

public static final java.lang.String RESPONSE_TYPE_TAG
Response type tag

See Also:
Constant Field Values

GREATER_THAN_OR_EQUAL_OPERATOR

public static final java.lang.String GREATER_THAN_OR_EQUAL_OPERATOR
greater than or equal

See Also:
Constant Field Values

GREATER_THAN_OPERATOR

public static final java.lang.String GREATER_THAN_OPERATOR
greater than

See Also:
Constant Field Values

LESS_THAN_OR_EQUAL_OPERATOR

public static final java.lang.String LESS_THAN_OR_EQUAL_OPERATOR
less then or equal

See Also:
Constant Field Values

LESS_THAN_OPERATOR

public static final java.lang.String LESS_THAN_OPERATOR
less than operator

See Also:
Constant Field Values

COMMA_OPERATOR

public static final java.lang.String COMMA_OPERATOR
comma operator

See Also:
Constant Field Values

RIGHT_BRACE_OPERATOR

public static final java.lang.String RIGHT_BRACE_OPERATOR
right brace operator

See Also:
Constant Field Values

LEFT_BRACE_OPERATOR

public static final java.lang.String LEFT_BRACE_OPERATOR
left brace operator

See Also:
Constant Field Values

OR_OPERATOR

public static final java.lang.String OR_OPERATOR
or

See Also:
Constant Field Values

AND_OPERATOR

public static final java.lang.String AND_OPERATOR
and

See Also:
Constant Field Values

NOT_OPERATOR

public static final java.lang.String NOT_OPERATOR
not

See Also:
Constant Field Values

MULTIPLY_OPERATOR

public static final java.lang.String MULTIPLY_OPERATOR
multiply

See Also:
Constant Field Values

PLUS_OPERATOR

public static final java.lang.String PLUS_OPERATOR
plus

See Also:
Constant Field Values

MINIUS_OPERATOR

public static final java.lang.String MINIUS_OPERATOR
minus

See Also:
Constant Field Values

EQUALS_OPERATOR

public static final java.lang.String EQUALS_OPERATOR
equals

See Also:
Constant Field Values

NOT_EQUALS_OPERATOR

public static final java.lang.String NOT_EQUALS_OPERATOR
not equals

See Also:
Constant Field Values

LIKE_OPERATOR

public static final java.lang.String LIKE_OPERATOR
like

See Also:
Constant Field Values

IN_OPERATOR

public static final java.lang.String IN_OPERATOR
in

See Also:
Constant Field Values

STARTINDEX_PARAMETER

public static final java.lang.String STARTINDEX_PARAMETER
start index

See Also:
Constant Field Values

COUNT_PARAMETER

public static final java.lang.String COUNT_PARAMETER
count

See Also:
Constant Field Values

WHERE_PARAMETER

public static final java.lang.String WHERE_PARAMETER
where

See Also:
Constant Field Values

ORDERBY_PARAMETER

public static final java.lang.String ORDERBY_PARAMETER
order by

See Also:
Constant Field Values

SEARCH_PARAMETER

public static final java.lang.String SEARCH_PARAMETER
search

See Also:
Constant Field Values

INCLUDE_PARAMETER

public static final java.lang.String INCLUDE_PARAMETER
include

See Also:
Constant Field Values

PRECEDENCE_PARAMETER

public static final java.lang.String PRECEDENCE_PARAMETER
precedence

See Also:
Constant Field Values

FORMAT_PARAMETER

public static final java.lang.String FORMAT_PARAMETER
format

See Also:
Constant Field Values

LANGUAGE_PARAMETER

public static final java.lang.String LANGUAGE_PARAMETER
language

See Also:
Constant Field Values

VERSION_PARAMETER

public static final java.lang.String VERSION_PARAMETER
version

See Also:
Constant Field Values

TRACKINGID_PARAMETER

public static final java.lang.String TRACKINGID_PARAMETER
tracking id

See Also:
Constant Field Values

SELECT_PARAMETER

public static final java.lang.String SELECT_PARAMETER
select

See Also:
Constant Field Values

ORDERBY_DESC_PARAMETER

public static final java.lang.String ORDERBY_DESC_PARAMETER
order descending

See Also:
Constant Field Values

WITH_SCHEMA_PARAMETER

public static final java.lang.String WITH_SCHEMA_PARAMETER
include schema

See Also:
Constant Field Values

RETURN_DELTA_PARAMETER

public static final java.lang.String RETURN_DELTA_PARAMETER
return delta

See Also:
Constant Field Values

STARTKEY_PARAMETER

public static final java.lang.String STARTKEY_PARAMETER
Non- SData Parameters ... yet .. should be moved into the spec eventually.

See Also:
Constant Field Values

KEYDIRECTION_PARAMETER

public static final java.lang.String KEYDIRECTION_PARAMETER
key direction

See Also:
Constant Field Values

HTTP_HEADER_BASE

public static final java.lang.String HTTP_HEADER_BASE
The base value for all HTTP headers used in SData that are not standard HTTP headers.

This is currently subject to change during discussion with the SData working group.

See Also:
Constant Field Values

HTTP_HEADER_SSO_GUID

public static final java.lang.String HTTP_HEADER_SSO_GUID
The HTTP header name reserved for a GUID that is associated with a Single Sign-on token.

It is not clear yet if this will be required. We might simply pass the token itself each time. However the consequence of loss is greater than merely losing a GUID.

See Also:
Constant Field Values

HTTP_HEADER_APPLICATION_GUID

public static final java.lang.String HTTP_HEADER_APPLICATION_GUID
The HTTP header name reserved for a GUID that is associated with some sort of application-specific material.

Such a token allows for greater flexibility in application design, allowing for multiple application sessions under a single We session.

See Also:
Constant Field Values

TRUE_VALUE

public static final java.lang.String TRUE_VALUE
true

See Also:
Constant Field Values

FALSE_VALUE

public static final java.lang.String FALSE_VALUE
false

See Also:
Constant Field Values

NO_VALUE

public static final java.lang.String NO_VALUE
no value

See Also:
Constant Field Values

IF_MATCH

public static final java.lang.String IF_MATCH
the name of the HTTP header used for concurrency handling. The caller provides the value of the eTag of the record.

See Also:
SDataHelper.E_TAG, SDATA_HTTP_IFMATCH, Constant Field Values

SDATA_HTTP_IFMATCH

public static final java.lang.String SDATA_HTTP_IFMATCH
the tag name for the SData Atom Extension http:ifMatch, which can be specified in an entry of a batch request feed to provide the IF_MATCH value for the entry.

This entry can be present in a normal update entry but is ignored; the IF_MATCH HTTP header is the value that is used.

See Also:
IF_MATCH, Constant Field Values


Copyright © 2011 Sage Software, Inc. All rights reserved.