sbIDatetimePropertyInfo Interface Reference

The property information specific to date/time fields. More...

import"sbIPropertyInfo.idl";

Inheritance diagram for sbIDatetimePropertyInfo:
[legend]
Collaboration diagram for sbIDatetimePropertyInfo:
[legend]

Public Attributes

readonly attribute AString OPERATOR_INTHELAST
 
readonly attribute AString OPERATOR_NOTINTHELAST
 
readonly attribute AString OPERATOR_ONDATE
 
readonly attribute AString OPERATOR_NOTONDATE
 
readonly attribute AString OPERATOR_BEFOREDATE
 
readonly attribute AString OPERATOR_BEFOREORONDATE
 
readonly attribute AString OPERATOR_AFTERDATE
 
readonly attribute AString OPERATOR_AFTERORONDATE
 
readonly attribute AString OPERATOR_BETWEENDATES
 
const long TIMETYPE_UNINITIALIZED = -1
 
const long TIMETYPE_DATE = 0
 2007-03-28 , in localized format More...
 
const long TIMETYPE_TIME = 1
 HH:mm:ss.ms, in localized format. Limited to 24 hour days. More...
 
const long TIMETYPE_DATETIME = 2
 Long date format, 2007-03-28 12:33:01 , no milliseconds. More...
 
const long TIMETYPE_TIMESTAMP = 4
 Timestamp format, respects unix time, microsecond format. More...
 
attribute long timeType
 You must initialize this attribute before using this object. If you do not, all methods on this object will return NS_ERROR_NOT_INITIALIZED. More...
 
attribute long long minDateTime
 A minimum datetime value to enforce when validating. If you do not wish to use this, set it to 0. More...
 
attribute long long maxDateTime
 A maximum datetime value to enforce when validating. If you do not wish to use this, set it to 0. More...
 
- Public Attributes inherited from sbIPropertyInfo
readonly attribute AString OPERATOR_EQUALS
 
readonly attribute AString OPERATOR_NOTEQUALS
 
readonly attribute AString OPERATOR_GREATER
 
readonly attribute AString OPERATOR_GREATEREQUAL
 
readonly attribute AString OPERATOR_LESS
 
readonly attribute AString OPERATOR_LESSEQUAL
 
readonly attribute AString OPERATOR_CONTAINS
 
readonly attribute AString OPERATOR_NOTCONTAINS
 
readonly attribute AString OPERATOR_BEGINSWITH
 
readonly attribute AString OPERATOR_NOTBEGINSWITH
 
readonly attribute AString OPERATOR_ENDSWITH
 
readonly attribute AString OPERATOR_NOTENDSWITH
 
readonly attribute AString OPERATOR_BETWEEN
 
readonly attribute AString OPERATOR_ISSET
 
readonly attribute AString OPERATOR_ISNOTSET
 
const unsigned long SORT_NULL_SMALL = 0
 Causes null values to be infinitely small. This is the default. More...
 
const unsigned long SORT_NULL_BIG = 1
 Causes null values to be infinitely large. More...
 
const unsigned long SORT_NULL_FIRST = 2
 Null values always first. More...
 
const unsigned long SORT_NULL_LAST = 3
 Null values always last. More...
 
attribute unsigned long nullSort
 Set where NULL values get sorted to. More...
 
attribute sbIPropertyArray secondarySort
 When sorting by this property, additionally sort by the following properties. More...
 
attribute AString id
 Unique ID for this property. More...
 
attribute AString type
 The type property. More...
 
attribute AString displayName
 Localized display name of this property. More...
 
attribute AString localizationKey
 Key used to find related localization strings. More...
 
attribute boolean userViewable
 A user may view this property. This does not impede reading the value, it's merely meant as a guideline. More...
 
attribute boolean userEditable
 A user may edit this property. This does not impede editing the value, it's merely meant as a guideline. More...
 
attribute boolean remoteReadable
 A web site may read the value of this property. More...
 
attribute boolean remoteWritable
 A web site may write the value of this property. More...
 
attribute boolean usedInIdentity
 This attribute indicates that changing this property may change the computed hash for the item. If a property with usedInIdentity of true is changed, the identity is recalculated. More...
 
attribute nsISimpleEnumerator operators
 True if this property has a selection list. More...
 
readonly attribute
sbIPropertyUnitConverter 
unitConverter
 A unit converter to convert to and from the units in which the property can be expressed. More...
 

Additional Inherited Members

- Public Member Functions inherited from sbIPropertyInfo
sbIPropertyOperator getOperator (in AString aOperator)
 Get the sbIPropertyOperator for the given operator string. More...
 
boolean validate (in AString aValue)
 Validates the string for this property type. More...
 
AString sanitize (in AString aValue)
 Sanitize a value so that it passes validation. More...
 
AString format (in AString aValue)
 Formats the value for display. More...
 
AString makeSortable (in AString aValue)
 Transforms the string into its sortable collation data equivalent. More...
 
AString makeSearchable (in AString aValue)
 Formats the value to enable proper search. More...
 

Detailed Description

The property information specific to date/time fields.

See Also
sbIPropertyInfo

Definition at line 329 of file sbIPropertyInfo.idl.

Member Data Documentation

attribute long long sbIDatetimePropertyInfo::maxDateTime

A maximum datetime value to enforce when validating. If you do not wish to use this, set it to 0.

You must set this attribute in order for this object to function properly. If you do not, all methods on this object will return NS_ERROR_NOT_INITIALIZED.

Definition at line 389 of file sbIPropertyInfo.idl.

attribute long long sbIDatetimePropertyInfo::minDateTime

A minimum datetime value to enforce when validating. If you do not wish to use this, set it to 0.

You must set this attribute in order for this object to function properly. If you do not, all methods on this object will return NS_ERROR_NOT_INITIALIZED.

Definition at line 379 of file sbIPropertyInfo.idl.

readonly attribute AString sbIDatetimePropertyInfo::OPERATOR_AFTERDATE

Definition at line 337 of file sbIPropertyInfo.idl.

readonly attribute AString sbIDatetimePropertyInfo::OPERATOR_AFTERORONDATE

Definition at line 338 of file sbIPropertyInfo.idl.

readonly attribute AString sbIDatetimePropertyInfo::OPERATOR_BEFOREDATE

Definition at line 335 of file sbIPropertyInfo.idl.

readonly attribute AString sbIDatetimePropertyInfo::OPERATOR_BEFOREORONDATE

Definition at line 336 of file sbIPropertyInfo.idl.

readonly attribute AString sbIDatetimePropertyInfo::OPERATOR_BETWEENDATES

Definition at line 339 of file sbIPropertyInfo.idl.

readonly attribute AString sbIDatetimePropertyInfo::OPERATOR_INTHELAST

Definition at line 331 of file sbIPropertyInfo.idl.

readonly attribute AString sbIDatetimePropertyInfo::OPERATOR_NOTINTHELAST

Definition at line 332 of file sbIPropertyInfo.idl.

readonly attribute AString sbIDatetimePropertyInfo::OPERATOR_NOTONDATE

Definition at line 334 of file sbIPropertyInfo.idl.

readonly attribute AString sbIDatetimePropertyInfo::OPERATOR_ONDATE

Definition at line 333 of file sbIPropertyInfo.idl.

attribute long sbIDatetimePropertyInfo::timeType

You must initialize this attribute before using this object. If you do not, all methods on this object will return NS_ERROR_NOT_INITIALIZED.

Definition at line 369 of file sbIPropertyInfo.idl.

const long sbIDatetimePropertyInfo::TIMETYPE_DATE = 0

2007-03-28 , in localized format

Definition at line 346 of file sbIPropertyInfo.idl.

const long sbIDatetimePropertyInfo::TIMETYPE_DATETIME = 2

Long date format, 2007-03-28 12:33:01 , no milliseconds.

Definition at line 356 of file sbIPropertyInfo.idl.

const long sbIDatetimePropertyInfo::TIMETYPE_TIME = 1

HH:mm:ss.ms, in localized format. Limited to 24 hour days.

Definition at line 351 of file sbIPropertyInfo.idl.

const long sbIDatetimePropertyInfo::TIMETYPE_TIMESTAMP = 4

Timestamp format, respects unix time, microsecond format.

Note
This is also the internal storage type for this property.

Definition at line 362 of file sbIPropertyInfo.idl.

const long sbIDatetimePropertyInfo::TIMETYPE_UNINITIALIZED = -1

Definition at line 341 of file sbIPropertyInfo.idl.


The documentation for this interface was generated from the following file: