Namespace: OpenEdge.Net.HTTP
Class
ContentDispositionHeader
Parent classes:
Progress.Lang.Object
OpenEdge.Net.HTTP.HttpHeader
OpenEdge.Net.HTTP.ContentDispositionHeader

Inherits: OpenEdge.Net.HTTP.HttpHeader

Copyright (c) 2016, 2018 by Progress Software Corporation. All rights reserved.
File:ContentDispositionHeader
Author(s):pjudge
Created:2016-07-01
Notes:* Header per spec http://tools.ietf.org/html/rfc6266
/* Constructor




Method Summary
Options Name Purpose
ClearParams () /** Removes any parameter records for this header. */
Inherited from OpenEdge.Net.HTTP.HttpHeader
ExtractParameters () /** Extracts/separates any parameters from the header's value, and stores the 'clean' value. */
Inherited from OpenEdge.Net.HTTP.HttpHeader
CHARACTER GetBaseValue () /** Returns the unparameterised value for this header. @return character The value. */
Inherited from OpenEdge.Net.HTTP.HttpHeader
CHARACTER GetParameterValue (character) /** Returns a parameter from a (for example, 'charset' from Content-Type) header value @param character The name of the parameter value to retrieve @return character The charset paremeter value; blank/empty otherwise */
Inherited from OpenEdge.Net.HTTP.HttpHeader
CHARACTER GetParameterValues () /** Returns the unparameterised value for this header. @return character The value. */
Inherited from OpenEdge.Net.HTTP.HttpHeader
CHARACTER GetValue () /* Overridable accessor method @return character The Value */
Inherited from OpenEdge.Net.HTTP.HttpHeader
LOGICAL HasParameter (character) /** Indicates whether a parameter exists in the header @param character The name of the parameter to check. @return logical True if the parameter exists. */
Inherited from OpenEdge.Net.HTTP.HttpHeader
LOGICAL RemoveParameters (character) /* Removes all parameters in this header with a name @param character the parameter name @return logical TRUE if at least one parameter was removed. */
Inherited from OpenEdge.Net.HTTP.HttpHeader
LOGICAL SetParameterValue (character, character)
Overrides OpenEdge.Net.HTTP.HttpHeader:SetParameterValue (character, character)
SetValue (character) /* Overridable mutator method @param character The header value */
Inherited from OpenEdge.Net.HTTP.HttpHeader
CHARACTER ToString () /* Returns a stringified version of this header object @return character A stringified representation of this object */
Inherited from OpenEdge.Net.HTTP.HttpHeader
Validate (character) /* Validates a header value. Should throw an error if the value is not valid. @param character The (prospective) header value */
Inherited from OpenEdge.Net.HTTP.HttpHeader

Constructor Summary
Options Name Purpose
ContentDispositionHeader (character) /* Constructor @param character A non-empty header name */
ContentDispositionHeader (character, character) /* Constructor @param character A non-empty header name @param character A valid header value */

Property Summary
Options Name Purpose
CHARACTER Name
Inherited from OpenEdge.Net.HTTP.HttpHeader
OpenEdge.Net.HTTP.HttpHeader NullHeader
Inherited from OpenEdge.Net.HTTP.HttpHeader
CHARACTER ParamDelimiter
Inherited from OpenEdge.Net.HTTP.HttpHeader
CHARACTER Value
Inherited from OpenEdge.Net.HTTP.HttpHeader


Method Detail
Top

PROTECTED ClearParams ()
Inherited from OpenEdge.Net.HTTP.HttpHeader
Purpose: Removes any parameter records for this header.
Top

PUBLIC ExtractParameters ()
Inherited from OpenEdge.Net.HTTP.HttpHeader
Purpose: Extracts/separates any parameters from the header's value, and stores the 'clean' value.
Top

PUBLIC CHARACTER GetBaseValue ()
Inherited from OpenEdge.Net.HTTP.HttpHeader
Purpose: Returns the unparameterised value for this header.
Returns CHARACTER
character The value.
Top

PUBLIC CHARACTER GetParameterValue (character)
Inherited from OpenEdge.Net.HTTP.HttpHeader
Purpose: Returns a parameter from a (for example, 'charset' from Content-Type) header value
Parameters:
pcParamName CHARACTER
Returns CHARACTER
character The charset paremeter value; blank/empty otherwise
Top

PUBLIC CHARACTER GetParameterValues ()
Inherited from OpenEdge.Net.HTTP.HttpHeader
Purpose: Returns the unparameterised value for this header.
Returns CHARACTER
character The value.
Top

PROTECTED CHARACTER GetValue ()
Inherited from OpenEdge.Net.HTTP.HttpHeader
/* Overridable accessor method
Returns CHARACTER
character The Value
Top

PUBLIC LOGICAL HasParameter (character)
Inherited from OpenEdge.Net.HTTP.HttpHeader
Purpose: Indicates whether a parameter exists in the header
Parameters:
pcParamName CHARACTER
Returns LOGICAL
logical True if the parameter exists.
Top

PUBLIC LOGICAL RemoveParameters (character)
Inherited from OpenEdge.Net.HTTP.HttpHeader
/* Removes all parameters in this header with a name
Parameters:
pcParamName CHARACTER
Returns LOGICAL
logical TRUE if at least one parameter was removed.
Top

PUBLIC LOGICAL SetParameterValue (character, character)
Overrides OpenEdge.Net.HTTP.HttpHeader:SetParameterValue (character, character)
Parameters:
pcParamName CHARACTER
pcParamValue CHARACTER
Returns LOGICAL
Top

PROTECTED SetValue (character)
Inherited from OpenEdge.Net.HTTP.HttpHeader
/* Overridable mutator method
Parameters:
pcValue CHARACTER
Top

PUBLIC CHARACTER ToString ()
Inherited from OpenEdge.Net.HTTP.HttpHeader
/* Returns a stringified version of this header object
Returns CHARACTER
character A stringified representation of this object
Top

PROTECTED Validate (character)
Inherited from OpenEdge.Net.HTTP.HttpHeader
/* Validates a header value. Should throw an error if the value
is not valid.
Parameters:
pcValue CHARACTER


Constructor Detail
Top

PUBLIC ContentDispositionHeader (character)
/* Constructor
Parameters:
pcName CHARACTER
Top

PUBLIC ContentDispositionHeader (character, character)
/* Constructor
Parameters:
pcName CHARACTER
pcValue CHARACTER


Property Detail
Top

PUBLIC CHARACTER Name
Inherited from OpenEdge.Net.HTTP.HttpHeader
Returns CHARACTER
Top

PUBLIC OpenEdge.Net.HTTP.HttpHeader NullHeader
Inherited from OpenEdge.Net.HTTP.HttpHeader
Returns OpenEdge.Net.HTTP.HttpHeader
Top

PUBLIC CHARACTER ParamDelimiter
Inherited from OpenEdge.Net.HTTP.HttpHeader
Returns CHARACTER
Top

PUBLIC CHARACTER Value
Inherited from OpenEdge.Net.HTTP.HttpHeader
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0