public class

Engagement

extends ExtensionPoint
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.analytics.Engagement

Class Overview

Engagement goal.

Summary

Nested Classes
class Engagement.Comparison Engagement goal's comparison operation. 
class Engagement.Type Goal's threshold type. 
Constants
String COMPARISON XML "comparison" attribute name
String THRESHOLDVALUE XML "thresholdValue" attribute name
String TYPE XML "type" attribute name
String XML_NAME XML element name
Fields
private String comparison Engagement goal's comparison operation
private Long thresholdValue Threshold value
private String type Goal's threshold type
[Expand]
Inherited Fields
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
Engagement()
Default mutable constructor.
Engagement(String comparison, Long thresholdValue, String type)
Immutable constructor.
Public Methods
boolean equals(Object obj)
String getComparison()
Returns the engagement goal's comparison operation.
static ExtensionDescription getDefaultDescription(boolean required, boolean repeatable)
Returns the extension description, specifying whether it is required, and whether it is repeatable.
Long getThresholdValue()
Returns the threshold value.
String getType()
Returns the goal's threshold type.
boolean hasComparison()
Returns whether it has the engagement goal's comparison operation.
boolean hasThresholdValue()
Returns whether it has the threshold value.
boolean hasType()
Returns whether it has the goal's threshold type.
int hashCode()
void setComparison(String comparison)
Sets the engagement goal's comparison operation.
void setThresholdValue(Long thresholdValue)
Sets the threshold value.
void setType(String type)
Sets the goal's threshold type.
String toString()
Protected Methods
void consumeAttributes(AttributeHelper helper)
Consumes attributes from the attribute helper.
void putAttributes(AttributeGenerator generator)
Puts attributes into the attribute generator.
void validate()
Checks the attributes to see if there are any problems.
[Expand]
Inherited Methods
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension

Constants

private static final String COMPARISON

XML "comparison" attribute name

Constant Value: "comparison"

private static final String THRESHOLDVALUE

XML "thresholdValue" attribute name

Constant Value: "thresholdValue"

private static final String TYPE

XML "type" attribute name

Constant Value: "type"

static final String XML_NAME

XML element name

Constant Value: "engagement"

Fields

private String comparison

Engagement goal's comparison operation

private Long thresholdValue

Threshold value

private String type

Goal's threshold type

Public Constructors

public Engagement ()

Default mutable constructor.

public Engagement (String comparison, Long thresholdValue, String type)

Immutable constructor.

Parameters
comparison Engagement goal's comparison operation.
thresholdValue Threshold value.
type Goal's threshold type.

Public Methods

public boolean equals (Object obj)

Parameters
obj

public String getComparison ()

Returns the engagement goal's comparison operation.

Returns
  • engagement goal's comparison operation

public static ExtensionDescription getDefaultDescription (boolean required, boolean repeatable)

Returns the extension description, specifying whether it is required, and whether it is repeatable.

Parameters
required Whether it is required
repeatable Whether it is repeatable
Returns
  • extension description

public Long getThresholdValue ()

Returns the threshold value.

Returns
  • threshold value

public String getType ()

Returns the goal's threshold type.

Returns
  • goal's threshold type

public boolean hasComparison ()

Returns whether it has the engagement goal's comparison operation.

Returns
  • whether it has the engagement goal's comparison operation

public boolean hasThresholdValue ()

Returns whether it has the threshold value.

Returns
  • whether it has the threshold value

public boolean hasType ()

Returns whether it has the goal's threshold type.

Returns
  • whether it has the goal's threshold type

public int hashCode ()

public void setComparison (String comparison)

Sets the engagement goal's comparison operation.

Parameters
comparison Engagement goal's comparison operation or null to reset

public void setThresholdValue (Long thresholdValue)

Sets the threshold value.

Parameters
thresholdValue Threshold value or null to reset

public void setType (String type)

Sets the goal's threshold type.

Parameters
type Goal's threshold type or null to reset

public String toString ()

Protected Methods

protected void consumeAttributes (AttributeHelper helper)

Consumes attributes from the attribute helper. May also use consumeContent(boolean) to consume the element's text content. Called from getHandler(ExtensionProfile, String, String, Attributes). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Parameters
helper Attribute helper
Throws
ParseException

protected void putAttributes (AttributeGenerator generator)

Puts attributes into the attribute generator. Called from generate(XmlWriter, ExtensionProfile). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Parameters
generator Attribute generator

protected void validate ()

Checks the attributes to see if there are any problems. Default implementation does nothing, though generally this is discouraged unless there really are no restrictions.