PATH |
EOStoredProcedure
Inherits from: Object
Implements: EOPropertyListEncoding
Package: com.webobjects.eoaccess
Class Description
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 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.
Interfaces Implemented
EOPropertyListEncodingawakeWithPropertyList encodeIntoPropertyList
Method Types
Constructors EOStoredProcedure 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
Constructors
EOStoredProcedure
public EOStoredProcedure(String name)
public EOStoredProcedure( NSDictionary propertyList, Object owner)
See Also: encodeIntoPropertyList (EOPropertyListEncoding) setName, name
Creates and returns a new EOStoredProcedure named name.Instance Methods
arguments
public NSArray arguments()
null
if the stored procedure has no arguments.
awakeWithPropertyList
public void awakeWithPropertyList(NSDictionary pList)
beautifyName
public void beautifyName()
See Also: setArguments, beautifyNames (EOModel)
encodeIntoPropertyList
public void encodeIntoPropertyList(NSMutableDictionary pList)
externalName
public String externalName()
null
if the receiver doesn't have an external name.
See Also: setExternalName
model
public EOModel model()
See Also: addStoredProcedure (EOModel)
name
public String name()
See Also: setName, EOStoredProcedure constructor
setArguments
public void setArguments(NSArray arguments)
See Also: arguments
setExternalName
public void setExternalName(String name)
See Also: externalName
setName
public void setName(String name)
See Also: name, EOStoredProcedure constructor
setUserInfo
public void setUserInfo(NSDictionary dictionary)
See Also: userInfo
toString
public String toString()
userInfo
public NSDictionary userInfo()
See Also: setUserInfo
© 2001 Apple Computer, Inc. (Last Published April 13, 2001)