Site:Interfaces - Revision history

MetrixAdmin: /* BackgroundTask */

2012-07-01T23:06:04Z

‎BackgroundTask

2012-07-01T23:05:32Z

‎BackgroundTask

2012-07-01T23:05:21Z

‎BackgroundContext

2012-07-01T23:04:39Z

‎BackendQuery

2012-07-01T22:40:28Z

‎DatabaseContext

2012-07-01T22:40:04Z

‎TaskContext

2012-07-01T22:32:52Z

‎BackendOutput

2012-07-01T22:32:06Z

‎BackendQuery

2012-07-01T22:27:54Z

‎BackendContext

2012-07-01T22:27:36Z

‎BackendContext

@@ Line 115: / Line 115: @@
 : run the background task.
 ; getContext()
-: @return the [[Site:Intefaces#BackgroundContext|BackgroundContext]].
+: @return the [[#BackgroundContext|BackgroundContext]].
 == DatabaseContext ==

@@ Line 115: / Line 115: @@
 : run the background task.
 ; getContext()
-: @return the [[Site:Intefaces#BackgroundContext:BackgroundContext]].
+: @return the [[Site:Intefaces#BackgroundContext|BackgroundContext]].
 == DatabaseContext ==

@@ Line 90: / Line 90: @@
 == BackgroundContext ==
-The BackgroundContext is responsible for providing access to the various requirements of an background task.
+The BackgroundContext interface is responsible for providing access to the various requirements of an background task.
 ; getLicenseContext()
@@ Line 97: / Line 97: @@
 ; getDatabaseContext()
 : @return a [[#DatabaseContext|DatabaseContext]].
 == DatabaseContext ==

@@ Line 198: / Line 198: @@
 ; execute([[#BackendContext|BackendContext]] backend, [[#ScopeContext|ScopeContext]] scope)
-: @return an object representing the query execution. This result is later passed into the processResult function. This function must be overridden by each backend context.
+: @return an object representing the result of the query execution. This result is later passed into the processResult function. This function must be overridden by each backend context.
 ; processResult([[#BackendContext|BackendContext]] backend, [[#BackendOutputFactory|BackendOutputFactory]] outputFactory, result)

@@ Line 87: / Line 87: @@
 ; isModerator()
 : @return a boolean on whether or not the authenticated user is a moderator.
 == DatabaseContext ==

← Older revision		Revision as of 22:40, 1 July 2012
Line 299:		Line 299:
	; getError()		; getError()
	: @return a formatted message with all relevant error information for the previous query.		: @return a formatted message with all relevant error information for the previous query.
−
−	~~== TaskContext ==~~
−
−	~~The TaskContext is responsible for providing access to the various requirements of an background task.~~
−
−	~~; getLicenseContext()~~
−	~~: @return a [[#LicenseContext\|LicenseContext]].~~
−
−	~~; getDatabaseContext()~~
−	~~: @return a [[#DatabaseContext\|DatabaseContext]].~~

@@ Line 215: / Line 215: @@
 ; set(key, val)
-: store param:val into the iHDF via param:key.
+: store param:val into the BackendOutput via param:key.
-; merge(prefixKey, iHDF)
+; merge(prefixKey, BackendOutput)
-: merge another iHDF into the current iHDF and prefix all keys by the param:prefixKey.
+: merge another BackendOutput into the current BackendOutput and prefix all keys by the param:prefixKey.
 ; getHashMap()
-: @return an associative Array of all of the key/value pairs stored within this iHDF object.
+: @return an associative Array of all of the key/value pairs stored within this BackendOutput object.
 ; getScope()

@@ Line 164: / Line 164: @@
 ; getInternalName()
-: @return the internal name of this query. This value must be hard-coded inside this function and must be unique across all other BackendQueries.
+: @return the internal name of this query.
 ; getDisplayName()

@@ Line 159: / Line 159: @@
 : @return the context argument stored with the param:key.
 ; getConfigParam(key)
-: @return the configuration param. These params are used while processing a backend query result into an [[Site:Interfaces#BackendOutput|BackendOutput]] object. These params are usually specified in the METADATA CONTROLS panel of the site page. An example of one of these params would be to use a HTML filter on all content descriptions to escape bad HTML.
+: @return the configuration param stored with the param:key. These params are used while processing a backend query result into an [[Site:Interfaces#BackendOutput|BackendOutput]] object. These params are usually specified in the METADATA CONTROLS panel of the site page. An example of one of these params would be to use a HTML filter on all content descriptions to escape bad HTML.
 == BackendQuery ==

@@ Line 154: / Line 154: @@
 ; getUrlArgs()
 : @return the URL parameters for the current page.
-: hasContextArg(key)
+; hasContextArg(key)
 : @return whether or not a context argument exists.
-: getContextArg(key)
+; getContextArg(key)
 : @return the context argument stored with the param:key.
 ; getConfigParam(key)