| Package | ga.util |
| Interface | public interface IConnectionService |
| Implementors | Wrapper, WrapperHostBase |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
The connection was closed. | IConnectionService | ||
The connection was made, if success=false, the connection attempt failed
| IConnectionService | ||
Return the form's Active data, either from the Guide or the PDF. | IConnectionService | ||
Return the form's data
| IConnectionService | ||
Return the guides draft data including state information (Data is retrieved from the PDF if PDF is active. | IConnectionService | ||
Returns a field's value as an Object
| IConnectionService | ||
Return the requested property. | IConnectionService | ||
Set the data into the form - returns false if failed. | IConnectionService | ||
Sets a field's value, returns success true or false
| IConnectionService | ||
Set the property, returns false if the operation failed
| IConnectionService | ||
Performs the submit action based on the value of the Submit From
option in the Guide Design perspective within Adobe Digital Enterprise Platform Document Services - Workbench 10.0. | IConnectionService | ||
Submits the data to the server - return true if the submit was performed
- returns false if validations fail
| IConnectionService | ||
Method Detail
connectionClosed | () | method |
public function connectionClosed():void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The connection was closed.
connectionOpened | () | method |
public function connectionOpened(success:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The connection was made, if success=false, the connection attempt failed
Parameters
success:Boolean — the status of the open request
|
getActiveData | () | method |
public function getActiveData(callback:Function = null):String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Return the form's Active data, either from the Guide or the PDF. PDF requires a callback.
Parameters
callback:Function (default = null) |
String — String
|
getData | () | method |
getDraftData | () | method |
public function getDraftData(callback:Function = null):String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Return the guides draft data including state information (Data is retrieved from the PDF if PDF is active. PDF requires a callback).
Parameters
callback:Function (default = null) |
String — String
|
getFieldValue | () | method |
public function getFieldValue(som:String):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Returns a field's value as an Object
Parameters
som:String — the identifier of the field to retrieve the data from. eg. "EntityRoot.Client[1].Address.City" or for xfa - #som("form1.subform[1].Address.City")
|
Object — Object
|
getProperty | () | method |
public function getProperty(property:String):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Return the requested property. Sypported properties are: showSubmitButton = "true"|"false"
Parameters
property:String — the name of the property to retieve a value from
|
Object — Object
|
setData | () | method |
public function setData(data:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Set the data into the form - returns false if failed. Throws an exception if the data is not valid XML.
Parameters
data:String — the content to be used as the current data
|
setFieldValue | () | method |
public function setFieldValue(som:String, value:Object):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Sets a field's value, returns success true or false
Parameters
som:String — the identifier of the field to retrieve the data from. eg. "EntityRoot.Client[1].Address.City" or for xfa - #som("form1.subform[1].Address.City")
| |
value:Object — the value to assign to the targeted item
|
Boolean — Boolean
|
setProperty | () | method |
public function setProperty(property:String, value:Object):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Set the property, returns false if the operation failed
Parameters
property:String — the name of the property to retieve a value from
| |
value:Object — the value to set the provided property with. Object types must match
|
Boolean — Boolean
|
submitData | () | method |
public function submitData():Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Performs the submit action based on the value of the Submit From option in the Guide Design perspective within Adobe Digital Enterprise Platform Document Services - Workbench 10.0. This method returns true if the submission performs successfully.
| SubmitFrom option | Behavior |
|---|---|
| Guide | Submits the Guide data to the Document Server. |
| Displays the PDF rendition of the Guide. A user then clicks the appropriate submit button on the PDF form. | |
| Printed Form | Displays the PDF rendition of the Guide. A user then prints the PDF and submits the form manually. |
| Hosted Application | The submit button does not display on the last panel of the Guide. This option transfer control of the Guide submission to the hosting application. In this case, a user clicks a button within the hosting application, for example the Complete button within Adobe Digital Enterprise Platform Document Services - Workspace 10.0, to submit the Guide data. |
Boolean — Boolean
|
submitDataWithCB | () | method |
public function submitDataWithCB(callback:Function):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 SP2 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Submits the data to the server - return true if the submit was performed - returns false if validations fail
Parameters
callback:Function — the function to be called when the submit is an asynchronous operation (default)
|
Boolean — Boolean
|
Mon Apr 10 2017, 12:28 PM -07:00