Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.bemoko.live.platform.mwc.intent
Class IntentParameters

java.lang.Object
  extended by com.bemoko.live.platform.mwc.intent.IntentParameters
All Implemented Interfaces:
com.bemoko.live.platform.context.LiveContextParameters
public class IntentParameters
extends Object
implements com.bemoko.live.platform.context.LiveContextParameters

Field Summary
static String INTENT_PARAMETER_UI_OVERRIDE
          Deprecated. 
 
Constructor Summary
IntentParameters(InteractionUri interactionUri)
           
IntentParameters(InteractionUri interactionUri, boolean initialise)
          Create an intent parameters object
 
Method Summary
 void flush()
          Flush any cached objects - e.g.
 String get(String name)
           
 InteractionUri getInteractionUri()
           
 Map<String,IntentParameter> getMap()
           
 Map<String,IntentParameter> getMap(int bitMaskSource)
          Get the map of parameters from a given bit mask source return null if no parameters are set for the given bit mask
 Map<String,String> getMapOfStrings()
           
 IntentParameter getParameter(String name)
           
 String getParameterString()
           
 String getPlatformEndPoint()
           
 URI getReferer()
           
 String getRequestedUri()
           
 String getServerRelativeSiteEndPoint()
          Deprecated. since 1.4.3 - please use InteractionUri.getServerRelativeSiteEndPoint()
 String getSiteRelativeContextEndPoint()
          Deprecated. 
 String getSourceParametersAsQueryString(int queryStringParameterBitMask)
          Return the parameters from the given sources as a query string.
 String getSourceParametersAsRestPath(int pathParameterBitMask)
          Return the parameters from the given sources as a REST path string.
 Upload getUpload(String uploadName)
           
 Collection<Upload> getUploads()
           
 Map<String,Upload> getUploadsAsMap()
           
 boolean hasParameters(int bitMaskSource)
          Check whether parameters are set for teh defined bit mask source
 boolean hasUploads()
           
protected  void initialise()
          Extract the parameter map from the parameter string
 boolean isClickThrough()
           
 IntentParameters put(String name, IntentParameter parameter)
          Put parameter with support for chaining
 IntentParameters put(String name, String value, int source)
          Put a parameter with a specified source
 void putAll(Map<String,String[]> map, int source)
           
protected  void putUpload(String name, Upload upload)
           
 void remove(String name)
           
 void setIsClickThrough(boolean isClickThrough)
           
 void setPlatformEndPoint(String platformEndPoint)
           
 void setReferer(URI referer)
           
 void setRequestedUri(String requestedUri)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INTENT_PARAMETER_UI_OVERRIDE

@Deprecated
public static final String INTENT_PARAMETER_UI_OVERRIDE
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

IntentParameters

public IntentParameters(InteractionUri interactionUri)

IntentParameters

public IntentParameters(InteractionUri interactionUri,
                        boolean initialise)
Create an intent parameters object

Method Detail

getInteractionUri

public InteractionUri getInteractionUri()

flush

public void flush()
Flush any cached objects - e.g. query string generations

get

public String get(String name)
Specified by:
get in interface com.bemoko.live.platform.context.LiveContextParameters

getMap

public Map<String,IntentParameter> getMap()
Returns:
Map

getMap

public Map<String,IntentParameter> getMap(int bitMaskSource)
Get the map of parameters from a given bit mask source return null if no parameters are set for the given bit mask

Returns:
Map

getMapOfStrings

public Map<String,String> getMapOfStrings()

getParameter

public IntentParameter getParameter(String name)

getParameterString

public String getParameterString()
Returns:
the parameterString

getPlatformEndPoint

public String getPlatformEndPoint()
Returns:
platform end point
See Also:
LiveIntent.getPlatformEndPoint()

getReferer

public URI getReferer()

getRequestedUri

public String getRequestedUri()

getServerRelativeSiteEndPoint

@Deprecated
public String getServerRelativeSiteEndPoint()
Deprecated. since 1.4.3 - please use InteractionUri.getServerRelativeSiteEndPoint()

Returns:
server relative site end point
See Also:
LiveIntent.getServerRelativeSiteEndPoint()

getSiteRelativeContextEndPoint

@Deprecated
public String getSiteRelativeContextEndPoint()
Deprecated. 

getSourceParametersAsQueryString

public String getSourceParametersAsQueryString(int queryStringParameterBitMask)
Return the parameters from the given sources as a query string. The generated string is cached locally so this method can be called several times without worry about the overhead of generation.

Parameters:
queryStringParameterBitMask -
Returns:
String

getSourceParametersAsRestPath

public String getSourceParametersAsRestPath(int pathParameterBitMask)
Return the parameters from the given sources as a REST path string. The string is cached locally so this method can be called several times without worry about the overhead of generation.

Parameters:
pathParameterBitMask -
Returns:
String

hasParameters

public boolean hasParameters(int bitMaskSource)
Check whether parameters are set for teh defined bit mask source

Parameters:
bitMaskSource -
Returns:
boolean

initialise

protected void initialise()
Extract the parameter map from the parameter string

isClickThrough

public boolean isClickThrough()

put

public IntentParameters put(String name,
                            IntentParameter parameter)
Put parameter with support for chaining

Parameters:
name -
Returns:
IntentParameters

put

public IntentParameters put(String name,
                            String value,
                            int source)
Put a parameter with a specified source

Parameters:
name -
value -
source -
Returns:
IntentParameters

putAll

public void putAll(Map<String,String[]> map,
                   int source)

remove

public void remove(String name)

setIsClickThrough

public void setIsClickThrough(boolean isClickThrough)

setPlatformEndPoint

public void setPlatformEndPoint(String platformEndPoint)

setReferer

public void setReferer(URI referer)

setRequestedUri

public void setRequestedUri(String requestedUri)

toString

public String toString()
Overrides:
toString in class Object

putUpload

protected void putUpload(String name,
                         Upload upload)

hasUploads

public boolean hasUploads()

getUpload

public Upload getUpload(String uploadName)

getUploadsAsMap

public Map<String,Upload> getUploadsAsMap()

getUploads

public Collection<Upload> getUploads()
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD