Inherits from: NSObject
Conforms to: EOPropertyListEncoding
Declared in: EOAccess/EOStoredProcedure.h
An EOStoredProcedure represents a stored procedure defined in a database, and associates a name internal to the Framework with an external name by which the stored procedure is known to the database. If a stored procedure has arguments, its EOStoredProcedure object also maintains a group of EOAttributes which represent the stored procedure's arguments. See the EOAttribute class specification for more information
You usually define stored procedures in your EOModel with the EOModeler application, which is documented in the Enterprise Objects Framework Developer's Guide. EOStoredProcedures are primarily used by the Enterprise Objects Framework to map operations for an EOEntity to stored procedures (see the description for EOEntity's setStoredProcedure:forOperation: method). You can assign stored procedures to an entity for any of the following scenarios:
- Fetching all the objects for the entity
- Fetching a single object by its primary key
- Inserting a new object
- Deleting an object
- Generating a new primary key
Your code probably won't use EOStoredProcedures unless you're working at the adaptor level.
Like the other major modeling classes, EOStoredProcedure provides a user dictionary for your application to store any application-specific information related to the stored procedure.
- awakeWithPropertyList - encodeIntoPropertyList:
- Creating a new EOStoredProcedure
- - initWithName:
- Accessing the model
- - model
- Accessing the name
- - setName:
- - beautifyName
- - name
- Accessing the external name
- - setExternalName:
- - externalName
- Accessing the arguments
- - setArguments:
- - arguments
- Accessing the user dictionary
- - setUserInfo:
- - userInfo
Returns the EOAttribute objects that describe
the stored procedure's arguments or nil if the stored procedure
has no arguments.
- (NSArray *)arguments
Renames the receiver's name and its arguments
to conform to the Framework's naming conventions. For example,
"NAME" is renamed "name" and "FIRST_NAME" is renamed
"firstName". This method is used in reverse-engineering a model.
See Also: - setArguments:, - beautifyNames (EOModel)
Returns the name of the stored procedure as
it is defined in the database, or nil if the receiver doesn't have
an external name.
- (NSString *)externalName
See Also: - setExternalName:
The designated initializer for EOStoredProcedure,
this method initializes a new EOStoredProcedure object and sets
its name to name. Returns self.
- (EOStoredProcedure *)initWithName:(NSString
See Also: - setName:, - name
Returns the model to which the receiver belongs.
- (EOModel *)model
See Also: - addStoredProcedure: (EOModel)
Returns the name of the receiver.
- (NSString *)name
See Also: - setName:, - initWithName:
Sets arguments as
the array of EOAttributes that describe the receiver's arguments.
The EOAttribute objects in arguments must
be ordered to match the database stored procedure definition.
See Also: - arguments
Sets the external name of the stored procedure
to name. name should
be the name of the stored procedure as it is defined in the database.
See Also: - externalName
Sets the name of the receiver.
See Also: - name, - initWithName:
Sets the dictionary of
auxiliary data, which your application can use for whatever it needs. dictionary can
only contain property list data types (that is, NSString, NSDictionary,
NSArray, and NSData).
See Also: - userInfo
Returns a dictionary of user data. Your application
can use this to store any auxiliary information it needs.
- (NSDictionary *)userInfo
See Also: - setUserInfo: