public class YtPublicationState extends AbstractExtension
app:control/yt:state
, which
describes the publication state of an entry.Modifier and Type | Class and Description |
---|---|
static class |
YtPublicationState.State
Current state.
|
AbstractExtension.AttributesHandler
localName, namespace
Constructor and Description |
---|
YtPublicationState() |
YtPublicationState(YtPublicationState.State state) |
YtPublicationState(YtPublicationState.State state,
java.lang.String reasonCode,
java.lang.String helpUrl,
java.lang.String description) |
Modifier and Type | Method and Description |
---|---|
protected void |
consumeAttributes(AttributeHelper helper)
Consumes attributes from the attribute helper.
|
java.lang.String |
getDescription()
Returns, in a human-readable form, the reason why
the entry was rejected or why processing the entry failed.
|
java.lang.String |
getHelpUrl()
Returns a HTTP url which describes the failure in more
details and/or provides a way of solving the problem.
|
java.lang.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.
|
protected void |
putAttributes(AttributeGenerator generator)
Puts attributes into the attribute generator.
|
void |
setDescription(java.lang.String description)
Sets a human-readable error message.
|
void |
setHelpUrl(java.lang.String url)
Sets a url to which users can learn more about the current
issue.
|
void |
setReasonCode(java.lang.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.
|
disableStrictValidation, enableStrictValidation, eq, generate, generate, generateAttributes, getExtensionLocalName, getExtensionNamespace, getHandler, isImmutable, isStrictValidation, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validate
public YtPublicationState()
public YtPublicationState(YtPublicationState.State state, java.lang.String reasonCode, java.lang.String helpUrl, java.lang.String description)
public YtPublicationState(YtPublicationState.State state)
public YtPublicationState.State getState()
public void setState(YtPublicationState.State state)
state
- publication statepublic java.lang.String getReasonCode()
null
public void setReasonCode(java.lang.String code)
code
- a code or null
public java.lang.String getDescription()
getReasonCode()
for that.null
public void setDescription(java.lang.String description)
description
- or null
public java.lang.String getHelpUrl()
null
public void setHelpUrl(java.lang.String url)
url
- an HTTP url or null
protected void putAttributes(AttributeGenerator generator)
AbstractExtension
AbstractExtension.generate(XmlWriter,ExtensionProfile)
. Default implementation
does nothing, though generally this is discouraged unless there really are
no attributes.putAttributes
in class AbstractExtension
generator
- attribute generatorprotected void consumeAttributes(AttributeHelper helper) throws ParseException
AbstractExtension
AttributeHelper.consumeContent(boolean)
to consume the element's text
content. Called from AbstractExtension.getHandler(com.google.gdata.data.ExtensionProfile, java.lang.String, java.lang.String, org.xml.sax.Attributes)
. Default implementation does
nothing, though generally this is discouraged unless there really are no
attributes.consumeAttributes
in class AbstractExtension
helper
- attribute helperParseException
- any parsing exception