cfboom.http

Class RequestParam

lucee.Component
    extended by cfboom.lang.Object
      extended by cfboom.http.RequestParam

I represent an http request parameter.

Class Attributes:
  • output : false
  •  
  • displayname : Class RequestParam
  •  
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
  • author : Joel Tobey
  •  
    Property Summary
    type property default serializable required
    string encoded


    • access = public
    • returntype = any
    true false
    string file


    • access = public
    • returntype = any
    true false
    string mimeType


    • access = public
    • returntype = any
    true false
    string name


    • access = public
    • returntype = any
    true false
    string type


    • access = public
    • returntype = any
    • validateparams = {pattern=header|CGI|body|XML|file|URL|formfield|cookie}
    • validate = regex
    true false
    string value


    • access = public
    • returntype = any
    true false
    Constructor Summary
    init([string name], [string value], [string type='URL'])
    Method Summary
    string getEncoded()
    string getFile()
    string getMimeType()
    string getName()
    string getType()
    string getValue()
    any setEncoded(string encoded)
    any setFile(string file)
    any setMimeType(string mimeType)
    any setName(string name)
    any setType(string type)
    any setValue(string value)
    string toString()
     
    Methods inherited from class cfboom.lang.Object
    $equals, getComponentName, getIdentityHashCode, getIdentityString, getMeta, hashCode
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init([string name], [string value], [string type='URL'])

    Parameters:
    name
    value
    type

    Property Detail

    encoded

    property string encoded

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    file

    property string file

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    mimeType

    property string mimeType

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    name

    property string name

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    type

    property string type

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    validateparams - {pattern=header|CGI|body|XML|file|URL|formfield|cookie}
    validate - regex

    value

    property string value

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    Method Detail

    getEncoded

    public string getEncoded()


    getFile

    public string getFile()


    getMimeType

    public string getMimeType()


    getName

    public string getName()


    getType

    public string getType()


    getValue

    public string getValue()


    setEncoded

    public any setEncoded(string encoded)

    Parameters:
    encoded

    setFile

    public any setFile(string file)

    Parameters:
    file

    setMimeType

    public any setMimeType(string mimeType)

    Parameters:
    mimeType

    setName

    public any setName(string name)

    Parameters:
    name

    setType

    public any setType(string type)

    Parameters:
    type

    setValue

    public any setValue(string value)

    Parameters:
    value

    toString

    public string toString()

    Overrides:
    toString in class cfboom.lang.Object