BASIC INFORMATION
STANDARD INFORMATION
Name: datagateway (org.changemedia.impart.api.datagateway)
Hint: The default dataGateway 
Last Modified: March 21, 2005 23:06:46 UTC
METHOD SUMMARY
PUBLIC METHODS
saveCategory( any category )
Inserts or updates an category, as appropriate
    return type: void
    [detail on: saveCategory()]
getAllCategories( )
get all categories for a blog
    return type: struct
    [detail on: getAllCategories()]
getDefaultAuthor( )
Returns the default author
    return type: any
    [detail on: getDefaultAuthor()]
entryExists( string id )
Given a string, tells whether an entry with that ID exists
    return type: boolean
    [detail on: entryExists()]
deleteCategory( string categoryId )
Deletes an existing category in a given blog
    return type: void
    [detail on: deleteCategory()]
saveEntry( any entry )
Inserts or updates an entry, as appropriate
    return type: void
    [detail on: saveEntry()]
newEntry( [string id=] )
Returns an entry
    return type: any
    [detail on: newEntry()]
getEntry( string entryID [, any entry] [, string onNotFound=throw] )
Gets an entry based on ID. If the entry does not exist, it returns a new entry.
    return type: any
    [detail on: getEntry()]
getAllEntries( )
get all entries for a blog
    return type: array
    [detail on: getAllEntries()]
deleteEntry( string entryId )
Deletes an existing entry in a given blog
    return type: void
    [detail on: deleteEntry()]
newComment( )
Returns a comment
    return type: any
    [detail on: newComment()]
getCategory( string categoryID [, any category] [, string onNotFound=throw] )
Gets an category based on ID. If the category does not exist, it returns a new category.
    return type: any
    [detail on: getCategory()]
newCategory( [string id=] )
Returns an category
    return type: any
    [detail on: newCategory()]
init( string blogID , any persister , any dataFactory , any authorGateway [, any cache] )
initialize the datagateway
    return type: datagateway
    [detail on: init()]
categoryExists( string id )
Given a string, tells whether an category with that ID exists
    return type: boolean
    [detail on: categoryExists()]
METHOD DETAILS
saveCategory    [top]
Hint: Inserts or updates an category, as appropriate
Access: public
Return Type: void
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
category
Hint: The category instance to save
Type: any
Required: Yes
getAllCategories    [top]
Hint: get all categories for a blog
Access: public
Return Type: struct
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
newCategory    [top]
Hint: Returns an category
Access: public
Return Type: any
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
id
Hint:
Type: string
Required: No
Default:
entryExists    [top]
Hint: Given a string, tells whether an entry with that ID exists
Access: public
Return Type: boolean
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
id
Hint:
Type: string
Required: Yes
getDefaultAuthor    [top]
Hint: Returns the default author
Access: public
Return Type: any
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
getEntry    [top]
Hint: Gets an entry based on ID. If the entry does not exist, it returns a new entry.
Access: public
Return Type: any
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
entryID
Hint:
Type: string
Required: Yes
entry
Hint:
Type: any
Required: No
onNotFound
Hint:
Type: string
Required: No
Default: throw
newEntry    [top]
Hint: Returns an entry
Access: public
Return Type: any
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
id
Hint:
Type: string
Required: No
Default:
deleteCategory    [top]
Hint: Deletes an existing category in a given blog
Access: public
Return Type: void
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
categoryId
Hint: The unique ID of the category to delete
Type: string
Required: Yes
getAllEntries    [top]
Hint: get all entries for a blog
Access: public
Return Type: array
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
deleteEntry    [top]
Hint: Deletes an existing entry in a given blog
Access: public
Return Type: void
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
entryId
Hint: The unique ID of the entry to delete
Type: string
Required: Yes
newComment    [top]
Hint: Returns a comment
Access: public
Return Type: any
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
getCategory    [top]
Hint: Gets an category based on ID. If the category does not exist, it returns a new category.
Access: public
Return Type: any
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
categoryID
Hint:
Type: string
Required: Yes
category
Hint:
Type: any
Required: No
onNotFound
Hint:
Type: string
Required: No
Default: throw
saveEntry    [top]
Hint: Inserts or updates an entry, as appropriate
Access: public
Return Type: void
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
entry
Hint: The entry instance to save
Type: any
Required: Yes
init    [top]
Hint: initialize the datagateway
Access: public
Return Type: datagateway
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
blogID
Hint:
Type: string
Required: Yes
persister
Hint:
Type: any
Required: Yes
dataFactory
Hint:
Type: any
Required: Yes
authorGateway
Hint:
Type: any
Required: Yes
cache
Hint:
Type: any
Required: No
categoryExists    [top]
Hint: Given a string, tells whether an category with that ID exists
Access: public
Return Type: boolean
Output: no
Implemented In: org.changemedia.impart.api.datagateway
Arguments:
id
Hint:
Type: string
Required: Yes
This Document Created With CFCDocumenter by Nathan Dintenfass.
Unauthorized use of the content on this page is strictly prohibited.