| Package | com.ericfeminella.application |
| Interface | public interface IQueryString |
| Implementors | QueryString |
| Property | Defined by | ||
|---|---|---|---|
| isProvided : Boolean [read-only]
Determines if parameters have been provided to the application
| IQueryString | ||
| Method | Defined by | ||
|---|---|---|---|
|
addParameter(name:String, value:*):void
Adds a new parameter ( name / value ) pair to the querystring
If the parameter name which has been specified currently exists in the querystring then it is simply ignored. | IQueryString | ||
|
appendToURL(url:String, decode:Boolean = false):String
Appends the current state of the
querystring
to a URL
| IQueryString | ||
|
containsParameter(name:String):Boolean
Determines if the specified parameter has been provided to
the query string
| IQueryString | ||
|
containsValue(value:*):Boolean
Determines if the specified value has been provided to the
query string
| IQueryString | ||
|
getName(value:String):String
Retrieves a specific parameter name based on the parameters
value
| IQueryString | ||
|
getNames():Array
Retrieves the parameter names provided to the application
| IQueryString | ||
|
getParameters():IMap
Retrieves each name / value pair provided to the application and
returns an Array of Objects which contain each parameter name
and value
| IQueryString | ||
|
getQueryString(decode:Boolean = false):String
Retrieves the raw query string provided to the application
| IQueryString | ||
|
getValue(name:String):String
Retrieves the value of the specified parameter name.
| IQueryString | ||
|
getValues():Array
Retrieves the parameter values provided to the application
| IQueryString | ||
|
length():int
Determines the length of the query string based on the amount
of name value pairs which have been supplied to the QueryString
| IQueryString | ||
|
removeParameter(name:String):void
Removes an existing parameter from the querystring
| IQueryString | ||
|
setValue(name:String, value:*):void
Assigns a new value to the specified querystring parameter
| IQueryString | ||
| isProvided | property |
isProvided:Boolean [read-only]Determines if parameters have been provided to the application
Implementation public function get isProvided():Boolean
| addParameter | () | method |
public function addParameter(name:String, value:*):voidAdds a new parameter ( name / value ) pair to the querystring
If the parameter name which has been specified currently exists in the querystring then it is simply ignored.
If you need to overwrite an existing parameter or modify the value
of an existing parameter use setValue instead
name:String — the name of the parameter
|
|
value:* — the value to assigned to the specified parameter name
|
| appendToURL | () | method |
public function appendToURL(url:String, decode:Boolean = false):String
Appends the current state of the querystring
to a URL
url:String — the url to which the querystring is to be appended
|
|
decode:Boolean (default = false) |
String — the specified url with the querystring appended
|
| containsParameter | () | method |
public function containsParameter(name:String):BooleanDetermines if the specified parameter has been provided to the query string
Parametersname:String — the paramter to determine
|
Boolean — true if supplied, false if not
|
| containsValue | () | method |
public function containsValue(value:*):BooleanDetermines if the specified value has been provided to the query string
Parametersvalue:* — the value in which to determine
|
Boolean — true if the value has been provided, false if not
|
| getName | () | method |
public function getName(value:String):StringRetrieves a specific parameter name based on the parameters value
Parametersvalue:String — the value of the parameter which is to be located
|
String — parameter name to which the specified value has been assigned
|
| getNames | () | method |
public function getNames():ArrayRetrieves the parameter names provided to the application
ReturnsArray — each query string parameter name
|
| getParameters | () | method |
public function getParameters():IMapRetrieves each name / value pair provided to the application and returns an Array of Objects which contain each parameter name and value
ReturnsIMap — IMap containing key / values as specified in the querystring
|
| getQueryString | () | method |
public function getQueryString(decode:Boolean = false):StringRetrieves the raw query string provided to the application
Parametersdecode:Boolean (default = false) |
String — the raw query string which has been supplied / modified
|
| getValue | () | method |
public function getValue(name:String):StringRetrieves the value of the specified parameter name. If the parameter does not exist a null value is returned. If the name has not been provided in the querystring then a null value is returned
Parametersname:String — the name of the parameter
|
String — the value of the specified paramter name
|
| getValues | () | method |
public function getValues():ArrayRetrieves the parameter values provided to the application
ReturnsArray — each query string parameter value
|
| length | () | method |
public function length():intDetermines the length of the query string based on the amount of name value pairs which have been supplied to the QueryString
Returnsint — the length of the query string
|
| removeParameter | () | method |
public function removeParameter(name:String):voidRemoves an existing parameter from the querystring
Parametersname:String — the name of the parameter which is to b removed
|
| setValue | () | method |
public function setValue(name:String, value:*):voidAssigns a new value to the specified querystring parameter
Parametersname:String — the name of the parameter
|
|
value:* — the value to assigned to the specified parameter name
|