// Generated on: Tue May 05 2015 14:39:54 GMT-0700 (Pacific Daylight Time)
intellisense.annotate(breeze.core, {
'Enum': function() {
///
///
/// Base class for all Breeze enumerations, such as EntityState, DataType, FetchStrategy, MergeStrategy etc. }
/// A Breeze Enum is a namespaced set of constant values. Each Enum consists of a group of related constants, called 'symbols'. }
/// Unlike enums in some other environments, each 'symbol' can have both methods and properties. }
///
///
///
///
},
'EnumSymbol': function() {
///
///
/// One of the constant values that is generated by the 'Enum' 'addSymbol' method. EnumSymbols should ONLY be created via }
/// the Enum.addSymbol method. }
///
///
},
'Event': function() {
///
///
/// Class to support basic event publication and subscription semantics. }
///
///
/// The object that will be doing the publication. i.e. the object to which this event is attached.
/// If omitted then subscriber notification failures will be ignored.
///
},
});
intellisense.annotate(breeze.core.Enum.prototype, {
'fromName': function() {
///
///
/// Returns an Enum symbol given its name. }
///
/// Name for which an enum symbol should be returned.
/// The symbol that matches the name or 'undefined' if not found.
///
}, 'addSymbol': function() {
///
///
/// Adds a new symbol to an Enum. }
///
/// A collection of properties that should be added to the new symbol. In other words, the 'propertiesObj' is any state that should be held by the symbol.
/// The new symbol
///
}, 'resolveSymbols': function() {
///
///
/// Seals this enum so that no more symbols may be added to it. This should only be called after all symbols }
/// have already been added to the Enum. }
///
///
}, 'getSymbols': function() {
///
///
/// Returns all of the symbols contained within this Enum. }
///
/// All of the symbols contained within this Enum.
///
}, 'getNames': function() {
///
///
/// Returns the names of all of the symbols contained within this Enum. }
///
/// All of the names of the symbols contained within this Enum.
///
}, 'contains': function() {
///
///
/// Returns whether an Enum contains a specified symbol. }
///
/// or symbol to test.
/// Whether this Enum contains the specified symbol.
///
},
});
intellisense.annotate(breeze.core.Enum, {
'isSymbol': function() {
///
///
/// Checks if an object is an Enum 'symbol'. }
///
/// The 'Enum' to which this symbol belongs. __readOnly__
'parentEnum': null,
});
intellisense.annotate(breeze.core.EnumSymbol, {
});
intellisense.annotate(breeze.core.Event.prototype, {
'publish': function() {
///
///
/// Publish data for this event. }
///
/// Data to publish
/// Whether to publish asynchonously or not.
/// Will be called for any errors that occur during publication. If omitted, errors will be eaten.
/// false if event is disabled; true otherwise.
///
}, 'publishAsync': function() {
///
///
/// Publish data for this event asynchronously. }
///
/// Data to publish
/// Will be called for any errors that occur during publication. If omitted, errors will be eaten.
///
}, 'subscribe': function() {
///
///
/// Subscribe to this event. }
///
/// Will be called whenever 'data' is published for this event.
/// This is a key for 'unsubscription'. It can be passed to the 'unsubscribe' method.
///
}, 'unsubscribe': function() {
///
///
/// Unsubscribe from this event. }
///
/// The value returned from the 'subscribe' method may be used to unsubscribe here.
/// Whether unsubscription occured. This will return false if already unsubscribed or if the key simply cannot be found.
///
},
});
intellisense.annotate(breeze.core.Event, {
'enable': function() {
///
///
/// Enables or disables the named event for an object and all of its children. }
///
/// The name of the event.
/// The object at which enabling or disabling will occur. All event notifications that occur to this object or children of this object will be enabled or disabled.
/// A boolean, a null or a function that returns either a boolean or a null.
///
}, 'isEnabled': function() {
///
///
/// Returns whether for a specific event and a specific object and its children, notification is enabled or disabled or not set. }
///
/// The name of the event.
/// The object for which we want to know if notifications are enabled.
/// The name of this validator.
/// A function to perform validation.
/// A free form object whose properties will made available during the validation and error message creation process. This object will be passed into the Validator's validation function whenever 'validate' is called. See above for a description of additional properties that will be automatically added to this object if not otherwise specified.
///
},
'ValidationError': function() {
///
///
/// A ValidationError is used to describe a failed validation. }
///
/// The Validator used to create this error, if any.
/// The Context object used in conjunction with the Validator to create this error.
/// The actual error message
/// An optional key used to define a key for this error. One will be created automatically if not provided here.
///
},
'ValidationOptions': function() {
///
///
/// A ValidationOptions instance is used to specify the conditions under which validation will be executed. }
///
///
///
},
'EntityAction': function() {
///
///
/// EntityAction is an 'Enum' containing all of the valid actions that can occur to an 'Entity'. }
///
///
},
'EntityAspect': function() {
///
///
/// An EntityAspect instance is associated with every attached entity and is accessed via the entity's 'entityAspect' property. }
///
///
},
'ComplexAspect': function() {
///
///
/// An ComplexAspect instance is associated with every complex object instance and is accessed via the complex object's 'complexAspect' property. }
///
///
},
'EntityKey': function() {
///
///
/// An EntityKey is an object that represents the unique identity of an entity. EntityKey's are immutable. }
///
/// The 'EntityType' of the entity.
/// A single value or an array of values.
///
},
'EntityState': function() {
///
///
/// EntityState is an 'Enum' containing all of the valid states for an 'Entity'. }
///
///
},
'DataType': function() {
///
///
/// DataType is an 'Enum' containing all of the supported data types. }
///
///
},
'DataService': function() {
///
///
/// A DataService instance is used to encapsulate the details of a single 'service'; this includes a serviceName, a dataService adapterInstance, }
/// and whether the service has server side metadata. }
///
///
///
},
'JsonResultsAdapter': function() {
///
///
/// A JsonResultsAdapter instance is used to provide custom extraction and parsing logic on the json results returned by any web service. }
/// This facility makes it possible for breeze to talk to virtually any web service and return objects that will be first class 'breeze' citizens. }
///
///
///
},
'MetadataStore': function() {
///
///
/// An instance of the MetadataStore contains all of the metadata about a collection of 'EntityType''s. }
/// MetadataStores may be shared across 'EntityManager''s. If an EntityManager is created without an }
/// explicit MetadataStore, the MetadataStore from the MetadataStore.defaultInstance property will be used. }
///
/// Configuration settings .
///
},
'EntityType': function() {
///
///
/// Container for all of the metadata about a specific type of Entity. }
///
/// Configuration settings or a MetadataStore. If this parameter is just a MetadataStore then what will be created is an 'anonymous' type that will never be communicated to or from the server. It is purely for client side use and will be given an automatically generated name. Normally, however, you will use a configuration object.
///
},
'ComplexType': function() {
///
///
/// Container for all of the metadata about a specific type of Complex object. }
///
/// Configuration settings
///
},
'DataProperty': function() {
///
///
/// A DataProperty describes the metadata for a single property of an 'EntityType' that contains simple data. }
///
///
///
},
'NavigationProperty': function() {
///
///
/// A NavigationProperty describes the metadata for a single property of an 'EntityType' that return instances of other EntityTypes. }
///
///
///
},
'AutoGeneratedKeyType': function() {
///
///
/// AutoGeneratedKeyType is an 'Enum' containing all of the valid states for an automatically generated key. }
///
///
},
'LocalQueryComparisonOptions': function() {
///
///
/// A LocalQueryComparisonOptions instance is used to specify the 'comparison rules' used when performing 'local queries' in order }
/// to match the semantics of these same queries when executed against a remote service. These options should be set based on the }
/// manner in which your remote service interprets certain comparison operations. }
///
///
///
},
'NamingConvention': function() {
///
///
/// A NamingConvention instance is used to specify the naming conventions under which a MetadataStore }
/// will translate property names between the server and the javascript client. }
///
///
///
},
'Predicate': function() {
///
///
/// Used to define a 'where' predicate for an EntityQuery. Predicates are immutable, which means that any }
/// method that would modify a Predicate actually returns a new Predicate. }
///
/// A property name, a nested property name or an expression involving a property name.
///
/// - This will be treated as either a property expression or a literal depending on context. In general, if the value can be interpreted as a property expression it will be, otherwise it will be treated as a literal. In most cases this works well, but you can also force the interpretation by making the value argument itself an object with a 'value' property and an 'isLiteral' property set to either true or false. Breeze also tries to infer the dataType of any literal based on context, if this fails you can force this inference by making the value argument an object with a 'value' property and a 'dataType' property set to one of the breeze.DataType enumeration instances.
///
},
'EntityQuery': function() {
///
///
/// An EntityQuery instance is used to query entities either from a remote datasource or from a local 'EntityManager'. }
///
///
///
},
'FilterQueryOp': function() {
///
///
/// FilterQueryOp is an 'Enum' containing all of the valid 'Predicate' }
/// filter operators for an 'EntityQuery'. }
///
///
},
'MergeStrategy': function() {
///
///
/// MergeStrategy is an 'Enum' that determines how entities are merged into an EntityManager. }
///
///
},
'FetchStrategy': function() {
///
///
/// FetchStrategy is an 'Enum' that determines how and where entities are retrieved from as a result of a query. }
///
///
},
'QueryOptions': function() {
///
///
/// A QueryOptions instance is used to specify the 'options' under which a query will occur. }
///
///
///
},
'EntityManager': function() {
///
///
/// Instances of the EntityManager contain and manage collections of entities, either retrieved from a backend datastore or created on the client. }
///
/// Configuration settings or a service name.
///
},
'SaveOptions': function() {
///
///
/// A SaveOptions instance is used to specify the 'options' under which a save will occur. }
///
///
///
},
'HttpResponse': function() {
///
///
/// A generic wrapper for any Http response returned by a server. }
///
///
},
'Promise': function() {
///
///
/// This is an simply api documentation for the CommonJS A Promises specification as it is used within Breeze. }
///
///
},
});
intellisense.annotate(breeze.breeze.config.prototype, {
'setProperties': function() {
///
///
/// This method is now OBSOLETE. Use the 'initializeAdapterInstances' to accomplish the same result. }
///
///
///
}, 'registerAdapter': function() {
///
///
/// Method use to register implementations of standard breeze interfaces. Calls to this method are usually }
/// made as the last step within an adapter implementation. }
///
/// - one of the following interface names 'ajax', 'dataService' or 'modelLibrary'
/// - an ctor function that returns an instance of the specified interface.
///
}, 'getAdapter': function() {
///
///
/// Returns the ctor function used to implement a specific interface with a specific adapter name. }
///
/// One of the following interface names 'ajax', 'dataService' or 'modelLibrary'
/// The name of any previously registered adapter. If this parameter is omitted then this method returns the 'default' adapter for this interface. If there is no default adapter, then a null is returned.
/// Returns either a ctor function or null.
///
}, 'initializeAdapterInstances': function() {
///
///
/// Initializes a collection of adapter implementations and makes each one the default for its corresponding interface. }
///
///
/// [array of instances]
///
}, 'initializeAdapterInstance': function() {
///
///
/// Initializes a single adapter implementation. Initialization means either newing a instance of the }
/// specified interface and then calling 'initialize' on it or simply calling 'initialize' on the instance }
/// if it already exists. }
///
/// The name of the interface to which the adapter to initialize belongs.
/// - The name of a previously registered adapter to initialize.
/// - Whether to make this the default 'adapter' for this interface.
///
///
}, 'getAdapterInstance': function() {
///
///
/// Returns the adapter instance corresponding to the specified interface and adapter names. }
///
/// The name of the interface.
/// - The name of a previously registered adapter. If this parameter is omitted then the default implementation of the specified interface is returned. If there is no defaultInstance of this interface, then the first registered instance of this interface is returned.
///
///
},
});
intellisense.annotate(breeze.breeze.config, {
});
intellisense.annotate(breeze.breeze.Validator.prototype, {
'validate': function() {
///
///
/// Run this validator against the specified value. This method will usually be called internally either }
/// automatically by an property change, entity attach, query or save operation, or manually as a result of }
/// a validateEntity call on the EntityAspect. The resulting ValidationResults are available via the }
/// EntityAspect.getValidationErrors method. }
///
/// Value to validate
/// Any additional contextual information that the Validator can make use of.
/// A ValidationError if validation fails, null otherwise
///
}, 'getMessage': function() {
///
///
/// Returns the message generated by the most recent execution of this Validator. }
///
///
///
},
/// The name of this validator.
'name': null,
/// The context for this validator.
'context': null,
});
intellisense.annotate(breeze.breeze.Validator, {
'fromJSON': function() {
///
///
/// Creates a validator instance from a JSON object or an array of instances from an array of JSON objects. }
///
/// JSON object that represents the serialized version of a validator.
///
}, 'register': function() {
///
///
/// Register a validator instance so that any deserialized metadata can reference it. }
///
/// Validator to register.
///
}, 'registerFactory': function() {
///
///
/// Register a validator factory so that any deserialized metadata can reference it. }
///
/// A function that optionally takes a context property and returns a Validator instance.
/// The name of the validator.
///
}, 'required': function() {
///
///
/// Returns a standard 'required value' Validator }
///
///
///
///
/// A new Validator
///
}, 'guid': function() {
///
///
/// Returns a Guid data type Validator. }
///
/// A new Validator
///
}, 'number': function() {
///
///
/// Returns a standard numeric data type Validator. }
///
/// A new Validator
///
}, 'int32': function() {
///
///
/// Returns a standard 32 bit integer data type Validator. }
///
/// A new Validator
///
}, 'byte': function() {
///
///
/// Returns a standard byte data type Validator. (This is a integer between 0 and 255 inclusive for js purposes). }
///
/// A new Validator
///
}, 'date': function() {
///
///
/// Returns a standard date data type Validator. }
///
/// optional parameters to pass through to validation constructor
///
/// optional parameters to pass through to validation constructor
/// optional parameters to pass through to validation constructor
/// optional parameters to pass through to validation constructor
/// name of this validator
/// regular expression to apply
/// default message for failed validations
/// optional parameters to pass through to validation constructor
/// Map of standard error message templates keyed by validator name. You can add to or modify this object to customize the template used for any validation error message.
'messageTemplates': null,
});
intellisense.annotate(breeze.breeze.ValidationError.prototype, {
/// The Validator associated with this ValidationError.
'validator': null,
/// A 'context' object associated with this ValidationError.
'context': null,
/// The DataProperty or NavigationProperty associated with this ValidationError.
'property': null,
/// The property name associated with this ValidationError. This will be a 'property path' for any properties of a complex object.
'propertyName': null,
/// The error message associated with the ValidationError.
'errorMessage': null,
/// The key by which this validation error may be removed from a collection of ValidationErrors.
'key': null,
/// Whether this is a server error.
'isServerError': null,
});
intellisense.annotate(breeze.breeze.ValidationError, {
'getKey': function() {
///
///
/// Composes a ValidationError 'key' given a validator or an errorName and an optional propertyName }
///
/// A Validator or an 'error name' if no validator is available.
/// A property name
/// The object to apply to create a new QueryOptions.
///
///
}, 'setAsDefault': function() {
///
///
/// Sets the 'defaultInstance' by creating a copy of the current 'defaultInstance' and then applying all of the properties of the current instance. }
/// The current instance is returned unchanged. }
///
///
},
/// Whether entity and property level validation should occur when entities are attached to the EntityManager other than via a query.
'validateOnAttach': null,
/// Whether entity and property level validation should occur before entities are saved. A failed validation will force the save to fail early.
'validateOnSave': null,
/// Whether entity and property level validation should occur after entities are queried from a remote server.
'validateOnQuery': null,
/// Whether property level validation should occur after entities are modified.
'validateOnPropertyChange': null,
});
intellisense.annotate(breeze.breeze.ValidationOptions, {
/// The default value whenever ValidationOptions are not specified.
'defaultInstance': null,
});
intellisense.annotate(breeze.breeze.EntityAction.prototype, {
});
intellisense.annotate(breeze.breeze.EntityAction, {
/// Attach - Entity was attached via an AttachEntity call.
'Attach': null,
/// AttachOnQuery - Entity was attached as a result of a query.
'AttachOnQuery': null,
/// AttachOnImport - Entity was attached as a result of an import.
'AttachOnImport': null,
/// Detach - Entity was detached.
'Detach': null,
/// MergeOnQuery - Properties on the entity were merged as a result of a query.
'MergeOnQuery': null,
/// MergeOnImport - Properties on the entity were merged as a result of an import.
'MergeOnImport': null,
/// MergeOnSave - Properties on the entity were merged as a result of a save
'MergeOnSave': null,
/// PropertyChange - A property on the entity was changed.
'PropertyChange': null,
/// EntityStateChange - The EntityState of the entity was changed.
'EntityStateChange': null,
/// AcceptChanges - AcceptChanges was called on the entity, or its entityState was set to Unmodified.
'AcceptChanges': null,
/// RejectChanges - RejectChanges was called on the entity.
'RejectChanges': null,
/// Clear - The EntityManager was cleared. All entities detached.
'Clear': null,
});
intellisense.annotate(breeze.breeze.EntityAspect.prototype, {
'getKey': function() {
///
///
/// Returns the 'EntityKey' for this Entity. }
///
/// Forces the recalculation of the key. This should normally be unnecessary.
/// The 'EntityKey' associated with this Entity.
///
}, 'acceptChanges': function() {
///
///
/// Returns the entity to an 'EntityState' of 'Unchanged' by committing all changes made since the entity was last queried }
/// had 'acceptChanges' called on it. }
///
///
}, 'rejectChanges': function() {
///
///
/// Returns the entity to an EntityState of 'Unchanged' by rejecting all changes made to it since the entity was last queried }
/// had 'rejectChanges' called on it. }
///
///
}, 'setAdded': function() {
///
///
/// Sets the entity to an EntityState of 'Added'. This is NOT the equivalent of calling 'EntityManager/addEntity' }
/// because no key generation will occur for autogenerated keys as a result of this operation. As a result this operation can be problematic }
/// unless you are certain that the entity being marked 'Added' does not already exist in the database and does not have an autogenerated key. }
/// The same operation can be performed by calling 'EntityAspect/setEntityState'. }
///
///
}, 'setUnchanged': function() {
///
///
/// Sets the entity to an EntityState of 'Unchanged'. This is also the equivalent of calling 'EntityAspect/acceptChanges'. }
/// The same operation can be performed by calling 'EntityAspect/setEntityState'. }
///
///
}, 'setModified': function() {
///
///
/// Sets the entity to an EntityState of 'Modified'. This can also be achieved by changing the value of any property on an 'Unchanged' entity. }
/// The same operation can be performed by calling 'EntityAspect/setEntityState'. }
///
///
}, 'setDeleted': function() {
///
///
/// Sets the entity to an EntityState of 'Deleted'. This both marks the entity as being scheduled for deletion during the next 'Save' call }
/// but also removes the entity from all of its related entities. }
/// The same operation can be performed by calling 'EntityAspect/setEntityState'. }
///
///
}, 'setDetached': function() {
///
///
/// Sets the entity to an EntityState of 'Detached'. This removes the entity from all of its related entities, but does NOT change the EntityState of any existing entities. }
/// The same operation can be performed by calling 'EntityAspect/setEntityState'. }
///
///
}, 'setEntityState': function() {
///
///
/// Sets the entity to the specified EntityState. See also 'setUnchanged', 'setModified', 'setDetached', etc. }
///
///
}, 'loadNavigationProperty': function() {
///
///
/// Performs a query for the value of a specified 'NavigationProperty'. }
///
/// The NavigationProperty or the name of the NavigationProperty to 'load'.
/// Function to call on success.
/// Function to call on failure.
/// - properties of success promise - results {Array of Entity} - query {EntityQuery} The original query - httpResponse {httpResponse} The HttpResponse returned from the server.
///
}, 'markAsLoaded': function() {
///
///
/// Marks this navigationProperty on this entity as already having been loaded. }
///
/// The NavigationProperty or name of NavigationProperty to 'load'.
///
}, 'isNavigationPropertyLoaded': function() {
///
///
/// Determines whether a navigationProperty on this entity has already been loaded. }
///
/// The NavigationProperty or name of NavigationProperty to 'load'.
///
}, 'validateEntity': function() {
///
///
/// Performs validation on the entity, any errors encountered during the validation are available via the }
/// 'EntityAspect.getValidationErrors' method. Validating an entity means executing }
/// all of the validators on both the entity itself as well as those on each of its properties. }
///
/// Whether the entity passed validation.
///
}, 'validateProperty': function() {
///
///
/// Performs validation on a specific property of this entity, any errors encountered during the validation are available via the }
/// 'EntityAspect.getValidationErrors' method. Validating a property means executing }
/// all of the validators on the specified property. This call is also made automatically anytime a property }
/// of an entity is changed. }
///
/// The 'DataProperty' or 'NavigationProperty' to validate or a string with the name of the property or a property path with the path to a property of a complex object.
/// A context object used to pass additional information to each 'Validator'
/// Whether the entity passed validation.
///
}, 'getValidationErrors': function() {
///
///
/// Returns the validation errors associated with either the entire entity or any specified property. }
///
/// The property for which validation errors should be retrieved. If omitted, all of the validation errors for this entity will be returned.
///
///
}, 'addValidationError': function() {
///
///
/// Adds a validation error. }
///
///
///
}, 'removeValidationError': function() {
///
///
/// Removes a validation error. }
///
/// Either a ValidationError or a ValidationError 'key' value
///
}, 'clearValidationErrors': function() {
///
///
/// Removes all of the validation errors for a specified entity }
///
///
},
/// The Entity that this aspect is associated with.
'entity': null,
/// The 'EntityManager' that contains this entity.
'entityManager': null,
/// The 'EntityState' of this entity.
'entityState': null,
/// Extra metadata about this entity such as the entity's etag. You may extend this object with your own metadata information. Breeze (de)serializes this object when importing/exporting the entity.
'extraMetadata': null,
/// Whether this entity is in the process of being saved.
'isBeingSaved': null,
/// Whether this entity has any validation errors.
'hasValidationErrors': null,
/// The 'original values' of this entity where they are different from the 'current values'. This is a map where the key is a property name and the value is the 'original value' of the property.
'originalValues': null,
});
intellisense.annotate(breeze.breeze.EntityAspect, {
});
intellisense.annotate(breeze.breeze.ComplexAspect.prototype, {
'getEntityAspect': function() {
///
///
/// Returns the EntityAspect for the top level entity tht contains this complex object. }
///
///
///
}, 'getPropertyPath': function() {
///
///
/// Executes the specified query against this EntityManager's local cache. }
///
/// The property name of a property on this complex aspect for which we want the full path.
/// The 'property path' from the top level entity that contains this complex object to this object.
///
},
/// The complex object that this aspect is associated with.
'complexObject': null,
/// The parent object that to which this aspect belongs; this will either be an entity or another complex object.
'parent': null,
/// The 'DataProperty' on the 'parent' that contains this complex object.
'parentProperty': null,
/// The 'original values' of this complex object where they are different from the 'current values'. This is a map where the key is a property name and the value is the 'original value' of the property.
'originalValues': null,
});
intellisense.annotate(breeze.breeze.ComplexAspect, {
});
intellisense.annotate(breeze.breeze.EntityKey.prototype, {
'equals': function() {
///
///
/// Used to compare EntityKeys are determine if they refer to the same Entity. }
/// There is also an static version of 'equals' with the same functionality. }
///
///
///
},
/// The 'EntityType' that this is a key for.
'entityType': null,
/// An array of the values for this key. This will usually only have a single element, unless the entity type has a multipart key.
'values': null,
});
intellisense.annotate(breeze.breeze.EntityKey, {
'equals': function() {
///
///
/// Used to compare EntityKeys are determine if they refer to the same Entity. }
/// There is also an instance version of 'equals' with the same functionality. }
///
///
///
///
},
});
intellisense.annotate(breeze.breeze.EntityState.prototype, {
'isUnchanged': function() {
///
///
///
/// Whether an entityState instance is EntityState.Unchanged.
///
}, 'isAdded': function() {
///
///
///
/// Whether an entityState instance is EntityState.Added.
///
}, 'isModified': function() {
///
///
///
/// Whether an entityState instance is EntityState.Modified.
///
}, 'isDeleted': function() {
///
///
///
/// Whether an entityState instance is EntityState.Deleted.
///
}, 'isDetached': function() {
///
///
///
/// Whether an entityState instance is EntityState.Detached.
///
}, 'isUnchangedOrModified': function() {
///
///
///
/// Whether an entityState instance is EntityState.Unchanged or EntityState.Modified.
///
}, 'isAddedModifiedOrDeleted': function() {
///
///
///
/// Whether an entityState instance is EntityState.Unchanged or EntityState.Modified or EntityState.Deleted.
///
},
});
intellisense.annotate(breeze.breeze.EntityState, {
/// The 'Unchanged' state.
'Unchanged': null,
/// The 'Added' state.
'Added': null,
/// The 'Modified' state.
'Modified': null,
/// The 'Deleted' state.
'Deleted': null,
/// The 'Detached' state.
'Detached': null,
});
intellisense.annotate(breeze.breeze.DataType.prototype, {
/// The default value of this DataType.
'defaultValue': null,
/// Whether this is a 'numeric' DataType.
'isNumeric': null,
});
intellisense.annotate(breeze.breeze.DataType, {
'fromEdmDataType': function() {
///
///
/// Returns the DataType for a specified EDM type name. }
///
///
///
'String': null,
///
'Int64': null,
///
'Int32': null,
///
'Int16': null,
///
'Byte': null,
///
'Decimal': null,
///
'Double': null,
///
'Single': null,
///
'DateTime': null,
///
'DateTimeOffset': null,
///
'Time': null,
///
'Boolean': null,
///
'Guid': null,
///
'Binary': null,
///
'Undefined': null,
});
intellisense.annotate(breeze.breeze.DataService.prototype, {
'using': function() {
///
///
/// Returns a copy of this DataService with the specified properties applied. }
///
/// The object to apply to create a new DataService.
///
///
}, 'qualifyUrl': function() {
///
///
/// Returns a url for this dataService with the specified suffix. This method handles dataService names either }
/// with or without trailing '/'s. }
///
/// The resulting url.
///
///
},
/// The serviceName for this DataService.
'serviceName': null,
/// The adapter name for the dataServiceAdapter to be used with this service.
'adapterName': null,
/// The 'dataService' adapter implementation instance associated with this EntityManager.
'adapterInstance': null,
/// Whether the server can provide metadata for this service.
'hasServerMetadata': null,
/// The JsonResultsAdapter used to process the results of any query against this DataService.
'jsonResultsAdapter': null,
/// Whether to use JSONP when performing a 'GET' request against this service.
'useJsonP': null,
});
intellisense.annotate(breeze.breeze.DataService, {
});
intellisense.annotate(breeze.breeze.JsonResultsAdapter.prototype, {
});
intellisense.annotate(breeze.breeze.JsonResultsAdapter, {
});
intellisense.annotate(breeze.breeze.MetadataStore.prototype, {
'setQ': function() {
///
///
/// (Re)set Q with a promises implementation suitable for Breeze internal use. Note: This API is likely to change. }
///
/// - a 'thenable' promises implementation like Q.js with the API that Breeze requires internally.
///
}, 'setProperties': function() {
///
///
/// General purpose property set method }
///
/// [object]
///
}, 'addDataService': function() {
///
///
/// Adds a DataService to this MetadataStore. If a DataService with the same serviceName is already }
/// in the MetadataStore an exception will be thrown. }
///
/// The DataService to add
/// Permit overwrite of existing DataService rather than throw exception
///
}, 'addEntityType': function() {
///
///
/// Adds an EntityType to this MetadataStore. No additional properties may be added to the EntityType after its has }
/// been added to the MetadataStore. }
///
/// The EntityType or ComplexType to add
///
}, 'exportMetadata': function() {
///
///
/// Exports this MetadataStore to a serialized string appropriate for local storage. This operation is also called }
/// internally when exporting an EntityManager. }
///
/// A serialized version of this MetadataStore that may be stored locally and later restored.
///
}, 'importMetadata': function() {
///
///
/// Imports a previously exported serialized MetadataStore into this MetadataStore. }
///
/// A previously exported MetadataStore.
/// Allows custom metadata to be merged into existing metadata types.
/// This MetadataStore.
///
}, 'hasMetadataFor': function() {
///
///
/// Returns whether Metadata has been retrieved for a specified service name. }
///
/// The service name.
///
///
}, 'getDataService': function() {
///
///
/// Returns the DataService for a specified service name }
///
/// The service name.
///
///
}, 'fetchMetadata': function() {
///
///
/// Fetches the metadata for a specified 'service'. This method is automatically called }
/// internally by an EntityManager before its first query against a new service. }
///
/// Either a DataService or just the name of the DataService to fetch metadata for.
/// Function called on success.
/// Function called on failure.
/// Promise
///
}, 'trackUnmappedType': function() {
///
///
/// Used to register a constructor for an EntityType that is not known via standard Metadata discovery; }
/// i.e. an unmapped type. }
///
/// The constructor for the 'unmapped' type.
/// A function
///
}, 'registerEntityTypeCtor': function() {
///
///
/// Provides a mechanism to register a 'custom' constructor to be used when creating new instances }
/// of the specified entity type. If this call is not made, a default constructor is created for }
/// the entity as needed. }
/// This call may be made before or after the corresponding EntityType has been discovered via }
/// Metadata discovery. }
///
/// The name of the EntityType o0r ComplexType.
/// The constructor for this EntityType or ComplexType; may be null if all you want to do is set the next parameter.
/// A function or the name of a function on the entity that is to be executed immediately after the entity has been created and populated with any initial values. initFn(entity)
/// A function that is executed immediately after a noTracking entity has been created and whose return value will be used in place of the noTracking entity.
///
/// The entityType that the 'entity' parameter would be if we were tracking
///
}, 'isEmpty': function() {
///
///
/// Returns whether this MetadataStore contains any metadata yet. }
///
///
///
}, 'getEntityType': function() {
///
///
/// Returns an 'EntityType' or a 'ComplexType' given its name. }
///
/// Either the fully qualified name or a short name may be used. If a short name is specified and multiple types share that same short name an exception will be thrown.
/// Whether to throw an error if the specified EntityType is not found.
/// The EntityType. ComplexType or 'undefined' if not not found.
///
}, 'getEntityTypes': function() {
///
///
/// Returns an array containing all of the 'EntityType's or 'ComplexType's in this MetadataStore. }
///
///
///
}, 'getEntityTypeNameForResourceName': function() {
///
///
/// Returns a fully qualified entityTypeName for a specified resource name. The reverse of this operation }
/// can be obtained via the 'EntityType' 'defaultResourceName' property }
///
///
///
}, 'setEntityTypeForResourceName': function() {
///
///
/// Associates a resourceName with an entityType. }
///
///
/// If passing a string either the fully qualified name or a short name may be used. If a short name is specified and multiple types share that same short name an exception will be thrown. If the entityType has not yet been discovered then a fully qualified name must be used.
///
},
/// The 'NamingConvention' associated with this MetadataStore.
'namingConvention': null,
});
intellisense.annotate(breeze.breeze.MetadataStore, {
'importMetadata': function() {
///
///
/// Creates a new MetadataStore from a previously exported serialized MetadataStore }
///
/// A previously exported MetadataStore.
/// [object]
///
}, 'isSubtypeOf': function() {
///
///
/// Returns whether this type is a subtype of a specified type. }
///
/// [EntityType]
///
}, 'getSelfAndSubtypes': function() {
///
///
/// Returns an array containing this type and any/all subtypes of this type down thru the hierarchy. }
///
///
}, 'addProperty': function() {
///
///
/// Adds a 'DataProperty' or a 'NavigationProperty' to this EntityType. }
///
///
///
}, 'createEntity': function() {
///
///
/// Create a new entity of this type. }
///
/// - Configuration object of the properties to set immediately after creation.
/// The new entity.
///
}, 'getCtor ( or obsolete getEntityCtor)': function() {
///
///
/// Returns the constructor for this EntityType. }
///
/// The constructor for this EntityType.
///
}, 'addValidator': function() {
///
///
/// Adds either an entity or property level validator to this EntityType. }
///
/// Validator to add.
/// Property to add this validator to. If omitted, the validator is assumed to be an entity level validator and is added to the EntityType's 'validators'.
///
}, 'getProperties': function() {
///
///
/// Returns all of the properties ( dataProperties and navigationProperties) for this EntityType. }
///
/// Array of Data and Navigation properties.
///
}, 'getPropertyNames': function() {
///
///
/// Returns all of the property names ( for both dataProperties and navigationProperties) for this EntityType. }
///
///
///
}, 'getDataProperty': function() {
///
///
/// Returns a data property with the specified name or null. }
///
///
/// Will be null if not found.
///
}, 'getNavigationProperty': function() {
///
///
/// Returns a navigation property with the specified name or null. }
///
///
/// Will be null if not found.
///
}, 'getProperty': function() {
///
///
/// Returns either a DataProperty or a NavigationProperty with the specified name or null. }
///
///
/// Whether to throw an exception if not found.
/// Will be null if not found.
///
}, 'toString': function() {
///
///
/// Returns a string representation of this EntityType. }
///
///
///
},
/// The 'MetadataStore' that contains this EntityType
'metadataStore': null,
/// The DataProperties (see 'DataProperty') associated with this EntityType.
'dataProperties': null,
/// The NavigationProperties (see 'NavigationProperty') associated with this EntityType.
'navigationProperties': null,
/// The DataProperties for this EntityType that contain instances of a ComplexType (see 'ComplexType').
'complexProperties': null,
/// The DataProperties associated with this EntityType that make up it's 'EntityKey'.
'keyProperties': null,
/// The DataProperties associated with this EntityType that are foreign key properties.
'foreignKeyProperties': null,
/// The DataProperties associated with this EntityType that are concurrency properties.
'concurrencyProperties': null,
/// The DataProperties associated with this EntityType that are not mapped to any backend datastore. These are effectively free standing properties.
'unmappedProperties': null,
/// The default resource name associated with this EntityType. An EntityType may be queried via a variety of 'resource names' but this one is used as the default when no resource name is provided. This will occur when calling 'EntityAspect/loadNavigationProperty' or when executing any 'EntityQuery' that was created via an 'EntityKey'.
'defaultResourceName': null,
/// The fully qualified name of this EntityType.
'name': null,
/// The short, unqualified, name for this EntityType.
'shortName': null,
/// The namespace for this EntityType.
'namespace': null,
/// The base EntityType (if any) for this EntityType.
'baseEntityType': null,
/// Whether this EntityType is abstract.
'isAbstract': null,
/// The 'AutoGeneratedKeyType' for this EntityType.
'autoGeneratedKeyType': null,
/// The entity level validators associated with this EntityType. Validators can be added and removed from this collection.
'validators': null,
/// A free form object that can be used to define any custom metadata for this EntityType.
'custom': null,
});
intellisense.annotate(breeze.breeze.EntityType, {
});
intellisense.annotate(breeze.breeze.ComplexType.prototype, {
'setProperties': function() {
///
///
/// General purpose property set method }
///
/// [object]
///
}, 'createInstance': function() {
///
///
/// Creates a new non-attached instance of this ComplexType. }
///
/// Configuration object containing initial values for the instance.
///
}, 'addValidator': function() {
///
///
/// See 'EntityType.addValidator' }
///
/// Validator to add.
/// Property to add this validator to. If omitted, the validator is assumed to be an entity level validator and is added to the EntityType's 'validators'.
///
}, 'getProperty': function() {
///
///
/// See 'EntityType.getProperty' }
///
///
}, 'getPropertyNames': function() {
///
///
/// See 'EntityType.getPropertyNames' }
///
///
}, 'getCtor': function() {
///
///
/// See 'EntityType.getEntityCtor' }
///
///
},
/// The DataProperties (see 'DataProperty') associated with this ComplexType.
'dataProperties': null,
/// The DataProperties for this ComplexType that contain instances of a ComplexType (see 'ComplexType').
'complexProperties': null,
/// The DataProperties associated with this ComplexType that are not mapped to any backend datastore. These are effectively free standing properties.
'unmappedProperties': null,
/// The fully qualifed name of this ComplexType.
'name': null,
/// The short, unqualified, name for this ComplexType.
'shortName': null,
/// The namespace for this ComplexType.
'namespace': null,
/// The entity level validators associated with this ComplexType. Validators can be added and removed from this collection.
'validators': null,
/// A free form object that can be used to define any custom metadata for this ComplexType.
'custom': null,
});
intellisense.annotate(breeze.breeze.ComplexType, {
});
intellisense.annotate(breeze.breeze.DataProperty.prototype, {
'setProperties': function() {
///
///
/// General purpose property set method }
///
/// [object]
///
},
/// The name of this property
'name': null,
/// The parent type that this property belongs to - will be either a 'EntityType' or a 'ComplexType'.
'parentType': null,
/// The 'DataType' of this property.
'dataType': null,
/// The name of the 'ComplexType' associated with this property; may be null.
'complexTypeName': null,
/// Whether the contents of this property is an instance of a 'ComplexType'.
'isComplexProperty': null,
/// Whether this property is nullable.
'isNullable': null,
/// Whether this property is scalar (i.e., returns a single value).
'isScalar': null,
/// Property on the base type that this property is inherited from. Will be null if the property is not on the base type.
'baseProperty': null,
/// Whether this property is a 'key' property.
'isPartOfKey': null,
/// Whether this property is an 'unmapped' property.
'isUnmapped': null,
/// __Describe this__
'concurrencyMode': null,
/// The maximum length for the value of this property.
'maxLength': null,
/// The 'Validator's that are associated with this property. Validators can be added and removed from this collection.
'validators': null,
/// The default value for this property.
'defaultValue': null,
/// The navigation property related to this property. Will only be set if this is a foreign key property.
'relatedNavigationProperty': null,
/// A free form object that can be used to define any custom metadata for this DataProperty.
'custom': null,
/// Is this a DataProperty? - always true here Allows polymorphic treatment of DataProperties and NavigationProperties.
'isDataProperty': null,
/// Is this a NavigationProperty? - always false here Allows polymorphic treatment of DataProperties and NavigationProperties.
'isNavigationProperty': null,
});
intellisense.annotate(breeze.breeze.DataProperty, {
});
intellisense.annotate(breeze.breeze.NavigationProperty.prototype, {
'setProperties': function() {
///
///
/// General purpose property set method }
///
/// [object]
///
},
/// The 'EntityType' that this property belongs to. ( same as parentEntityType). __readOnly__
'parentType': null,
/// The 'EntityType' that this property belongs to. __readOnly__
'parentEntityType': null,
/// The name of this property
'name': null,
/// The 'EntityType' returned by this property.
'entityType': null,
/// Whether this property returns a single entity or an array of entities.
'isScalar': null,
/// Property on the base type that this property is inherited from. Will be null if the property is not on the base type.
'baseProperty': null,
/// The name of the association to which that this property belongs. This associationName will be shared with this properties 'inverse'.
'associationName': null,
/// The names of the foreign key DataProperties associated with this NavigationProperty. There will usually only be a single DataProperty associated with a Navigation property except in the case of entities with multipart keys.
'foreignKeyNames': null,
/// The 'foreign key' DataProperties associated with this NavigationProperty. There will usually only be a single DataProperty associated with a Navigation property except in the case of entities with multipart keys.
'relatedDataProperties': null,
/// The inverse of this NavigationProperty. The NavigationProperty that represents a navigation in the opposite direction to this NavigationProperty.
'inverse': null,
/// The 'Validator's that are associated with this property. Validators can be added and removed from this collection.
'validators': null,
/// A free form object that can be used to define any custom metadata for this NavigationProperty.
'custom': null,
/// Is this a DataProperty? - always false here Allows polymorphic treatment of DataProperties and NavigationProperties.
'isDataProperty': null,
/// Is this a NavigationProperty? - always true here Allows polymorphic treatment of DataProperties and NavigationProperties.
'isNavigationProperty': null,
});
intellisense.annotate(breeze.breeze.NavigationProperty, {
});
intellisense.annotate(breeze.breeze.AutoGeneratedKeyType.prototype, {
});
intellisense.annotate(breeze.breeze.AutoGeneratedKeyType, {
/// This entity does not have an autogenerated key. The client must set the key before adding the entity to the EntityManager
'None': null,
/// This entity's key is an Identity column and is set by the backend database. Keys for new entities will be temporary until the entities are saved at which point the keys will be converted to their 'real' versions.
'Identity': null,
/// This entity's key is generated by a KeyGenerator and is set by the backend database. Keys for new entities will be temporary until the entities are saved at which point the keys will be converted to their 'real' versions.
'KeyGenerator': null,
});
intellisense.annotate(breeze.breeze.LocalQueryComparisonOptions.prototype, {
'setAsDefault': function() {
///
///
/// Sets the 'defaultInstance' by creating a copy of the current 'defaultInstance' and then applying all of the properties of the current instance. }
/// The current instance is returned unchanged. }
///
///
},
});
intellisense.annotate(breeze.breeze.LocalQueryComparisonOptions, {
/// Case insensitive SQL compliant options - this is also the default unless otherwise changed.
'caseInsensitiveSQL': null,
/// The default value whenever LocalQueryComparisonOptions are not specified. By default this is 'caseInsensitiveSQL'.
'defaultInstance': null,
});
intellisense.annotate(breeze.breeze.NamingConvention.prototype, {
'serverPropertyNameToClient': function() {
///
///
/// The function used to convert server side property names to client side property names. }
///
///
/// The actual DataProperty or NavigationProperty corresponding to the property name.
/// The client side property name.
///
}, 'clientPropertyNameToServer': function() {
///
///
/// The function used to convert client side property names to server side property names. }
///
///
/// The actual DataProperty or NavigationProperty corresponding to the property name.
/// The server side property name.
///
}, 'setAsDefault': function() {
///
///
/// Sets the 'defaultInstance' by creating a copy of the current 'defaultInstance' and then applying all of the properties of the current instance. }
/// The current instance is returned unchanged. }
///
///
},
});
intellisense.annotate(breeze.breeze.NamingConvention, {
/// A noop naming convention - This is the default unless another is specified.
'none': null,
/// The 'camelCase' naming convention - This implementation only lowercases the first character of the server property name but leaves the rest of the property name intact. If a more complicated version is needed then one should be created via the ctor.
'camelCase': null,
/// The default value whenever NamingConventions are not specified.
'defaultInstance': null,
});
intellisense.annotate(breeze.breeze.Predicate.prototype, {
'and': function() {
///
///
/// 'And's this Predicate with one or more other Predicates and returns a new 'composite' Predicate }
///
/// Any null or undefined values passed in will be automatically filtered out before constructing the composite predicate.
///
}, 'or': function() {
///
///
/// 'Or's this Predicate with one or more other Predicates and returns a new 'composite' Predicate }
///
/// Any null or undefined values passed in will be automatically filtered out before constructing the composite predicate.
///
}, 'not': function() {
///
///
/// Returns the 'negated' version of this Predicate }
///
///
},
});
intellisense.annotate(breeze.breeze.Predicate, {
'create': function() {
///
///
/// Same as using the ctor. }
///
/// A property name, a nested property name or an expression involving a property name.
///
/// - This will be treated as either a property expression or a literal depending on context. In general, if the value can be interpreted as a property expression it will be, otherwise it will be treated as a literal. In most cases this works well, but you can also force the interpretation by making the value argument itself an object with a 'value' property and an 'isLiteral' property set to either true or false. Breeze also tries to infer the dataType of any literal based on context, if this fails you can force this inference by making the value argument an object with a 'value' property and a 'dataType' property set to one of the breeze.DataType enumeration instances.
///
}, 'and': function() {
///
///
/// Creates a 'composite' Predicate by 'and'ing a set of specified Predicates together. }
///
/// Any null or undefined values passed in will be automatically filtered out before constructing the composite predicate.
///
}, 'or': function() {
///
///
/// Creates a 'composite' Predicate by 'or'ing a set of specified Predicates together. }
///
/// Any null or undefined values passed in will be automatically filtered out before constructing the composite predicate.
///
}, 'not': function() {
///
///
/// Creates a 'composite' Predicate by 'negating' a specified predicate. }
///
///
///
},
});
intellisense.annotate(breeze.breeze.EntityQuery.prototype, {
'from': function() {
///
///
/// Specifies the resource to query for this EntityQuery. }
///
/// The resource to query.
///
///
}, 'toType': function() {
///
///
/// Specifies the top level EntityType that this query will return. Only needed when a query returns a json result that does not include type information. }
///
/// The top level entityType that this query will return. This method is only needed when a query returns a json result that does not include type information. If the json result consists of more than a simple entity or array of entities, consider using a JsonResultsAdapter instead.
///
///
}, 'where': function() {
///
///
/// Returns a new query with an added filter criteria; Can be called multiple times which means to 'and' with any existing }
/// Predicate or can be called with null to clear all predicates. }
///
/// Can be either
///
///
}, 'orderBy': function() {
///
///
/// Returns a new query that orders the results of the query by property name. By default sorting occurs is ascending order, but sorting in descending order is supported as well. }
/// OrderBy clauses may be chained. }
///
/// A comma-separated (',') string of property paths or an array of property paths. Each property path can optionally end with ' desc' to force a descending sort order. If 'propertyPaths' is either null or omitted then all ordering is removed.
/// - If specified, overrides all of the embedded 'desc' tags in the previously specified property paths.
///
///
}, 'orderByDesc': function() {
///
///
/// Returns a new query that orders the results of the query by property name in descending order. }
///
/// A comma-separated (',') string of property paths or an array of property paths. If 'propertyPaths' is either null or omitted then all ordering is removed.
///
///
}, 'select': function() {
///
///
/// Returns a new query that selects a list of properties from the results of the original query and returns the values of just these properties. This }
/// will be referred to as a projection. }
/// If the result of this selection 'projection' contains entities, these entities will automatically be added to EntityManager's cache and will }
/// be made 'observable'. }
/// Any simple properties, i.e. strings, numbers or dates within a projection will not be cached are will NOT be made 'observable'. }
///
/// A comma-separated (',') string of property paths or an array of property paths. If 'propertyPaths' is either null or omitted then any existing projection on the query is removed.
///
///
}, 'skip': function() {
///
///
/// Returns a new query that skips the specified number of entities when returning results. }
/// Any existing 'skip' can be cleared by calling 'skip' with no arguments. }
///
/// The number of entities to return. If omitted or null any existing skip count on the query is removed.
///
///
}, 'top': function() {
///
///
/// Returns a new query that returns only the specified number of entities when returning results. - Same as 'take'. }
/// Any existing 'top' can be cleared by calling 'top' with no arguments. }
///
/// The number of entities to return. If 'count' is either null or omitted then any existing 'top' count on the query is removed.
///
///
}, 'take': function() {
///
///
/// Returns a new query that returns only the specified number of entities when returning results - Same as 'top'. }
/// Any existing take can be cleared by calling take with no arguments. }
///
/// The number of entities to return. If 'count' is either null or omitted then any existing 'take' count on the query is removed.
///
///
}, 'expand': function() {
///
///
/// Returns a new query that will return related entities nested within its results. The expand method allows you to identify related entities, via navigation property }
/// names such that a graph of entities may be retrieved with a single request. Any filtering occurs before the results are 'expanded'. }
///
/// A comma-separated list of navigation property names or an array of navigation property names. Each Navigation Property name can be followed by a '.' and another navigation property name to enable identifying a multi-level relationship. If 'propertyPaths' is either null or omitted then any existing 'expand' clause on the query is removed.
///
///
}, 'withParameters': function() {
///
///
/// Returns a new query that includes a collection of parameters to pass to the server. }
///
/// A parameters object where the keys are the parameter names and the values are the parameter values.
///
///
}, 'inlineCount': function() {
///
///
/// Returns a query with the 'inlineCount' capability either enabled or disabled. With 'inlineCount' enabled, an additional 'inlineCount' property }
/// will be returned with the query results that will contain the number of entities that would have been returned by this }
/// query with only the 'where'/'filter' clauses applied, i.e. without any 'skip'/'take' operators applied. For local queries this clause is ignored. }
///
/// Whether or not inlineCount capability should be enabled. If this parameter is omitted, true is assumed.
///
///
}, 'noTracking': function() {
///
///
/// Returns a query with the 'noTracking' capability either enabled or disabled. With 'noTracking' enabled, the results of this query }
/// will not be coerced into entities but will instead look like raw javascript projections. i.e. simple javascript objects. }
///
/// Whether or not the noTracking capability should be enabled. If this parameter is omitted, true is assumed.
///
///
}, 'using': function() {
///
///
/// Returns a copy of this EntityQuery with the specified 'EntityManager', 'DataService', }
/// 'JsonResultsAdapter', 'MergeStrategy' or 'FetchStrategy' applied. }
///
/// The object to update in creating a new EntityQuery from an existing one.
///
///
}, 'execute': function() {
///
///
/// Executes this query. This method requires that an EntityManager has been previously specified via the 'using' method. }
///
/// Function called on success.
/// Function called on failure.
///
///
}, 'executeLocally': function() {
///
///
/// Executes this query against the local cache. This method requires that an EntityManager have been previously specified via the 'using' method. }
///
///
},
/// The resource name used by this query.
'resourceName': null,
/// The entityType that is associated with the 'from' clause ( resourceName) of the query. This is only guaranteed to be be set AFTER the query has been executed because it depends on the MetadataStore associated with the EntityManager that the query was executed against. This value may be null if the entityType cannot be associated with a resourceName.
'fromEntityType': null,
/// The entityType that will be returned by this query. This property will only be set if the 'toType' method was called.
'resultEntityType': null,
/// The 'where' predicate used by this query.
'wherePredicate': null,
/// The 'OrderByClause' used by this query.
'orderByClause': null,
/// The number of entities to 'skip' for this query.
'skipCount': null,
/// The number of entities to 'take' for this query.
'takeCount': null,
/// Any additional parameters that were added to the query via the 'withParameters' method.
'parameters': null,
/// The 'QueryOptions' for this query.
'queryOptions': null,
/// The 'EntityManager' for this query. This may be null and can be set via the 'using' method.
'entityManager': null,
});
intellisense.annotate(breeze.breeze.EntityQuery, {
'from': function() {
///
///
/// This is a static version of the 'from' method and it creates a 'base' entityQuery for the specified resource name. }
///
/// The resource to query.
/// The entities for which we want to create an EntityQuery.
/// The 'EntityKey' for which a query will be created.
/// The Entity whose navigation property will be queried.
/// The 'NavigationProperty' or name of the NavigationProperty to be queried.
/// Aliases: 'eq', '=='
'Equals': null,
/// Aliases: 'ne', '!='
'NotEquals': null,
/// Aliases: 'gt', '>'
'GreaterThan': null,
/// Aliases: 'lt', '<'
'LessThan': null,
/// Aliases: 'ge', '>='
'GreaterThanOrEqual': null,
/// Aliases: 'le', '<='
'LessThanOrEqual': null,
/// String operation: Is a string a substring of another string. Aliases: 'substringof'
'Contains': null,
///
'StartsWith': null,
///
'EndsWith': null,
/// Aliases: 'some'
'Any': null,
/// Aliases: 'every'
'All': null,
});
intellisense.annotate(breeze.breeze.MergeStrategy.prototype, {
});
intellisense.annotate(breeze.breeze.MergeStrategy, {
/// MergeStrategy.PreserveChanges updates the cached entity with the incoming values unless the cached entity is in a changed state (added, modified, deleted) in which case the incoming values are ignored. The updated cached entity’s EntityState will remain 'EntityState/Unchanged' unless you’re importing entities in which case the new EntityState will be that of the imported entities.
'PreserveChanges': null,
/// MergeStrategy.OverwriteChanges always updates the cached entity with incoming values even if the entity is in a changed state (added, modified, deleted). After the merge, the pending changes are lost. The new EntityState will be 'EntityState/Unchanged' unless you’re importing entities in which case the new EntityState will be that of the imported entities.
'OverwriteChanges': null,
/// SkipMerge is used to ignore incoming values. Adds the incoming entity to the cache only if there is no cached entity with the same key. This is the fastest merge strategy but your existing cached data will remain “stale”.
'SkipMerge': null,
/// Disallowed is used to throw an exception if there is an incoming entity with the same key as an entity already in the cache. Use this strategy when you want to be sure that the incoming entity is not already in cache. This is the default strategy for EntityManager.attachEntity.
'Disallowed': null,
});
intellisense.annotate(breeze.breeze.FetchStrategy.prototype, {
});
intellisense.annotate(breeze.breeze.FetchStrategy, {
/// FromServer is used to tell the query to execute the query against a remote data source on the server.
'FromServer': null,
/// FromLocalCache is used to tell the query to execute the query against a local EntityManager instead of going to a remote server.
'FromLocalCache': null,
});
intellisense.annotate(breeze.breeze.QueryOptions.prototype, {
'using': function() {
///
///
/// Returns a copy of this QueryOptions with the specified 'MergeStrategy', }
/// 'FetchStrategy', or 'includeDeleted' option applied. }
///
/// The object to apply to create a new QueryOptions.
///
///
}, 'setAsDefault': function() {
///
///
/// Sets the 'defaultInstance' by creating a copy of the current 'defaultInstance' and then applying all of the properties of the current instance. }
/// The current instance is returned unchanged. }
///
///
},
/// A 'FetchStrategy' __readOnly__
'fetchStrategy': null,
/// A 'MergeStrategy' __readOnly__
'mergeStrategy': null,
/// Whether to include cached deleted entities in a query result (false by default).
'includeDeleted': null,
});
intellisense.annotate(breeze.breeze.QueryOptions, {
/// The default value whenever QueryOptions are not specified.
'defaultInstance': null,
});
intellisense.annotate(breeze.breeze.EntityManager.prototype, {
'setProperties': function() {
///
///
/// General purpose property set method. Any of the properties documented below }
/// may be set. }
///
///
///
}, 'createEntity': function() {
///
///
/// Creates a new entity of a specified type and optionally initializes it. By default the new entity is created with an EntityState of Added }
/// but you can also optionally specify an EntityState. An EntityState of 'Detached' will insure that the entity is created but not yet added }
/// to the EntityManager. }
///
/// The EntityType or the name of the type for which an instance should be created.
/// - Configuration object of the properties to set immediately after creation.
/// - The EntityState of the entity after being created and added to this EntityManager.
/// - How to handle conflicts if an entity with the same key already exists within this EntityManager.
/// A new Entity of the specified type.
///
}, 'acceptChanges': function() {
///
///
/// Calls EntityAspect.acceptChanges on every changed entity in this EntityManager. }
///
///
}, 'exportEntities': function() {
///
///
/// Exports selected entities, all entities of selected types, or an entire EntityManager cache. }
///
/// The entities to export or the EntityType(s) of the entities to export; all entities are exported if this parameter is omitted or null.
/// Export configuration options
/// The export bundle either serialized (default) or as a JSON object. The bundle contains the metadata (unless excluded) and the entity data grouped by type. The entity data include property values, change-state, and temporary key mappings (if any).
///
}, 'importEntities': function() {
///
///
/// Imports a previously exported result into this EntityManager. }
///
/// The result of a previous 'export' call.
/// A configuration object.
/// A function that takes two arguments ( the current metadataVersion and the imported store's 'name'} and may be used to perform version checking.
/// result
///
}, 'clear': function() {
///
///
/// Clears this EntityManager's cache but keeps all other settings. Note that this }
/// method is not as fast as creating a new EntityManager via 'new EntityManager'. }
/// This is because clear actually detaches all of the entities from the EntityManager. }
///
///
}, 'createEmptyCopy': function() {
///
///
/// Creates an empty copy of this EntityManager }
///
/// A new EntityManager.
///
}, 'addEntity': function() {
///
///
/// Attaches an entity to this EntityManager with an 'EntityState' of 'Added'. }
///
/// The entity to add.
/// The added entity.
///
}, 'attachEntity': function() {
///
///
/// Attaches an entity to this EntityManager with a specified 'EntityState'. }
///
/// The entity to add.
/// The EntityState of the newly attached entity. If omitted this defaults to EntityState.Unchanged.
/// How the specified entity should be merged into the EntityManager if this EntityManager already contains an entity with the same key.
/// The attached entity.
///
}, 'detachEntity': function() {
///
///
/// Detaches an entity from this EntityManager. }
///
/// The entity to detach.
/// Whether the entity could be detached. This will return false if the entity is already detached or was never attached.
///
}, 'fetchMetadata': function() {
///
///
/// Fetches the metadata associated with the EntityManager's current 'serviceName'. This call }
/// occurs internally before the first query to any service if the metadata hasn't already been }
/// loaded. }
///
/// Function called on success.
/// Function called on failure.
/// - Properties on the promise success result - schema {Object} The raw Schema object from metadata provider - Because this schema will differ depending on the metadata provider it is usually better to access metadata via the 'metadataStore' property of the EntityManager instead of using this 'raw' data.
///
}, 'executeQuery': function() {
///
///
/// Executes the specified query. }
///
/// The 'EntityQuery' or OData query string to execute.
/// Function called on success.
/// Function called on failure.
/// - Properties on the promise success result - results {Array of Entity} - query {EntityQuery} The original query - entityManager {EntityManager} The EntityManager. - httpResponse {HttpResponse} The HttpResponse returned from the server. - [inlineCount] {Integer} Only available if 'inlineCount(true)' was applied to the query. Returns the count of items that would have been returned by the query before applying any skip or take operators, but after any filter/where predicates would have been applied.
///
}, 'executeQueryLocally': function() {
///
///
/// Executes the specified query against this EntityManager's local cache. }
///
/// The 'EntityQuery' to execute.
/// Array of entities from cache that satisfy the query
///
}, 'saveChanges': function() {
///
///
/// Saves either a list of specified entities or all changed entities within this EntityManager. If there are no changes to any of the entities }
/// specified then there will be no server side call made but a valid 'empty' saveResult will still be returned. }
///
/// The list of entities to save. Every entity in that list will be sent to the server, whether changed or unchanged, as long as it is attached to this EntityManager. If this parameter is omitted, null or empty (the usual case), every entity with pending changes in this EntityManager will be saved.
/// 'SaveOptions' for the save - will default to 'EntityManager/saveOptions' if null.
/// Function called on success.
/// Function called on failure.
/// Promise
///
}, 'saveChangesValidateOnClient': function() {
///
///
/// Run the 'saveChanges' pre-save client validation logic. }
///
/// The list of entities to save (to validate).
/// Validation error or null if no error
///
}, 'getEntityByKey': function() {
///
///
/// Attempts to locate an entity within this EntityManager by its key. }
///
/// The EntityType or EntityType name for this key.
/// The values for this key - will usually just be a single value; an array is only needed for multipart keys.
/// An Entity or null;
///
}, 'getEntityByKey - overload': function() {
///
///
/// Attempts to locate an entity within this EntityManager by its 'EntityKey'. }
///
/// The 'EntityKey' of the Entity to be located.
/// An Entity or null;
///
}, 'fetchEntityByKey': function() {
///
///
/// Attempts to fetch an entity from the server by its key with }
/// an option to check the local cache first. Note the this EntityManager's queryOptions.mergeStrategy }
/// will be used to merge any server side entity returned by this method. }
///
/// The EntityType or EntityType name for this key.
/// The values for this key - will usually just be a single value; an array is only needed for multipart keys.
/// Whether to check this EntityManager first before going to the server. By default, the query will NOT do this.
/// - Properties on the promise success result - entity {Object} The entity returned or null - entityKey {EntityKey} The entityKey of the entity to fetch. - fromCache {Boolean} Whether this entity was fetched from the server or was found in the local cache.
///
}, 'fetchEntityByKey - overload': function() {
///
///
/// Attempts to fetch an entity from the server by its 'EntityKey' with }
/// an option to check the local cache first. }
///
/// The 'EntityKey' of the Entity to be located.
/// Whether to check this EntityManager first before going to the server. By default, the query will NOT do this.
/// - Properties on the promise success result - entity {Object} The entity returned or null - entityKey {EntityKey} The entityKey of the entity to fetch. - fromCache {Boolean} Whether this entity was fetched from the server or was found in the local cache.
///
}, 'findEntityByKey': function() {
///
///
/// [Deprecated] - Attempts to locate an entity within this EntityManager by its 'EntityKey'. }
///
/// The 'EntityKey' of the Entity to be located.
/// An Entity or null;
///
}, 'generateTempKeyValue': function() {
///
///
/// Generates a temporary key for the specified entity. This is used to insure that newly }
/// created entities have unique keys and to register that these keys are temporary and }
/// need to be automatically replaced with 'real' key values once these entities are saved. }
///
/// The Entity to generate a key for.
/// The new key value
///
}, 'hasChanges': function() {
///
///
/// Returns whether there are any changed entities of the specified 'EntityType's. A 'changed' Entity has }
/// has an 'EntityState' of either Added, Modified or Deleted. }
///
/// The 'EntityType's for which 'changed' entities will be found. If this parameter is omitted, all EntityTypes are searched. String parameters are treated as EntityType names.
/// Whether there were any changed entities.
///
}, 'getChanges': function() {
///
///
/// Returns a array of all changed entities of the specified 'EntityType's. A 'changed' Entity has }
/// has an 'EntityState' of either Added, Modified or Deleted. }
///
/// The 'EntityType's for which 'changed' entities will be found. If this parameter is omitted, all EntityTypes are searched. String parameters are treated as EntityType names.
/// Array of Entities
///
}, 'rejectChanges': function() {
///
///
/// Rejects (reverses the effects) all of the additions, modifications and deletes from this EntityManager. }
/// Calls EntityAspect.rejectChanges on every changed entity in this EntityManager. }
///
/// The entities whose changes were rejected. These entities will all have EntityStates of either 'Unchanged' or 'Detached'
///
}, 'getEntities': function() {
///
///
/// Returns a array of all entities of the specified 'EntityType's with the specified 'EntityState's. }
///
/// The 'EntityType's for which entities will be found. If this parameter is omitted, all EntityTypes are searched. String parameters are treated as EntityType names.
/// The 'EntityState's for which entities will be found. If this parameter is omitted, entities of all EntityStates are returned.
/// Array of Entities
///
},
/// The service name associated with this EntityManager.
'serviceName': null,
/// The DataService name associated with this EntityManager.
'dataService': null,
/// The 'MetadataStore' associated with this EntityManager.
'metadataStore': null,
/// The 'QueryOptions' associated with this EntityManager.
'queryOptions': null,
/// The 'SaveOptions' associated with this EntityManager.
'saveOptions': null,
/// The 'ValidationOptions' associated with this EntityManager.
'validationOptions': null,
/// The 'KeyGenerator' constructor associated with this EntityManager.
'keyGeneratorCtor': null,
});
intellisense.annotate(breeze.breeze.EntityManager, {
'importEntities': function() {
///
///
/// Creates a new EntityManager and imports a previously exported result into it. }
///
/// The result of a previous 'exportEntities' call.
/// A configuration object.
/// A function that takes two arguments ( the current metadataVersion and the imported store's 'name'} and may be used to perform version checking.
/// The object to apply to create a new SaveOptions.
///
},
/// Whether another save can be occuring at the same time as this one - default is false.
'allowConcurrentSaves': null,
/// A 'DataService'. __readOnly__
'dataService': null,
/// The resource name to call to perform the save. __readOnly__
'resourceName': null,
/// A free form value that will be sent to the server.
'tag': null,
});
intellisense.annotate(breeze.breeze.SaveOptions, {
/// The default value whenever SaveOptions are not specified.
'defaultInstance': null,
});
intellisense.annotate(breeze.breeze.HttpResponse.prototype, {
'getHeader': function() {
///
///
/// A function to retrieve headers - a null headerName will return all headers. }
///
///
///
},
/// The response body.
'data': null,
/// HTTP status code of the response.
'status': null,
/// The configuration object that was used to generate the request.
'config': null,
});
intellisense.annotate(breeze.breeze.HttpResponse, {
});
intellisense.annotate(breeze.breeze.Promise.prototype, {
'then': function() {
///
///
/// Used to handle the sucessfull return of data from a promise }
///
///
///
}, 'fail': function() {
///
///
/// Used to handle any errors encountered wheh processing the promise. }
///
///
///
}, 'fin': function() {
///
///
/// A callback that is called regardless of the success or failure of the promise. }
///
///
///
},
});
intellisense.annotate(breeze.breeze.Promise, {
});