public class

YtPublicationState

extends AbstractExtension
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.youtube.YtPublicationState

Class Overview

Object representation of app:control/yt:state, which describes the publication state of an entry.

Summary

Nested Classes
enum YtPublicationState.State Current state. 
Fields
private String description
private String helpUrl
private String reasonCode
private YtPublicationState.State state
[Expand]
Inherited Fields
From class com.google.gdata.data.AbstractExtension
Public Constructors
YtPublicationState()
YtPublicationState(YtPublicationState.State state, String reasonCode, String helpUrl, String description)
YtPublicationState(YtPublicationState.State state)
Public Methods
String getDescription()
Returns, in a human-readable form, the reason why the entry was rejected or why processing the entry failed.
String getHelpUrl()
Returns a HTTP url which describes the failure in more details and/or provides a way of solving the problem.
String getReasonCode()
Gets a code describing the reason why the entry was rejected or why processing the entry failed.
YtPublicationState.State getState()
Gets the publication state enum value.
void setDescription(String description)
Sets a human-readable error message.
void setHelpUrl(String url)
Sets a url to which users can learn more about the current issue.
void setReasonCode(String code)
Sets the code describing the reason why the entry was rejected or why processing the entry failed.
void setState(YtPublicationState.State state)
Sets the publication state enum value.
Protected Methods
void consumeAttributes(AttributeHelper helper)
Consumes attributes from the attribute helper.
void putAttributes(AttributeGenerator generator)
Puts attributes into the attribute generator.
[Expand]
Inherited Methods
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension

Fields

private String description

private String helpUrl

private String reasonCode

private YtPublicationState.State state

Public Constructors

public YtPublicationState ()

public YtPublicationState (YtPublicationState.State state, String reasonCode, String helpUrl, String description)

Parameters
state
reasonCode
helpUrl
description

public YtPublicationState (YtPublicationState.State state)

Parameters
state

Public Methods

public String getDescription ()

Returns, in a human-readable form, the reason why the entry was rejected or why processing the entry failed. This error message is only meant to help debugging and should not be parsed automatically. The exact message will change with time. Please use getReasonCode() for that.

Returns
  • description human-readable error description or null

public String getHelpUrl ()

Returns a HTTP url which describes the failure in more details and/or provides a way of solving the problem.

Returns
  • url a url or null

public String getReasonCode ()

Gets a code describing the reason why the entry was rejected or why processing the entry failed.

Returns
  • a code or null

public YtPublicationState.State getState ()

Gets the publication state enum value.

Returns
  • publication state

public void setDescription (String description)

Sets a human-readable error message.

Parameters
description Or null

public void setHelpUrl (String url)

Sets a url to which users can learn more about the current issue.

Parameters
url An HTTP url or null

public void setReasonCode (String code)

Sets the code describing the reason why the entry was rejected or why processing the entry failed.

Parameters
code A code or null

public void setState (YtPublicationState.State state)

Sets the publication state enum value.

Parameters
state Publication state

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