com.ibm.workplace.wcm.api.extensions.syndication
Enum SyndicationSummary.Status
java.lang.Object
java.lang.Enum<SyndicationSummary.Status>
com.ibm.workplace.wcm.api.extensions.syndication.SyndicationSummary.Status
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Comparable<SyndicationSummary.Status>
- Enclosing interface:
- SyndicationSummary
-
public static enum SyndicationSummary.Status
- extends java.lang.Enum<SyndicationSummary.Status>
The status enum covers the various possible states the syndication run is in when the extension is called.
Enum Constant Summary
|
CANCELLED
This is another form of aborting that is triggered normally and not by failure. |
FAILED
The syndication run has hit a failure that is causing it to abort the current run. |
SUCCEEDED
Indicates at the time of processing the extension
the syndication run was flagged as successful. |
Methods inherited from class java.lang.Enum
|
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object
|
getClass, notify, notifyAll, wait, wait, wait |
SUCCEEDED
public static final SyndicationSummary.Status SUCCEEDED
- Indicates at the time of processing the extension
the syndication run was flagged as successful.
However since the extension executes before syndication completes fully there is a chance that
the run could still fail after
FAILED
public static final SyndicationSummary.Status FAILED
- The syndication run has hit a failure that is causing it to abort the current run.
Even though the run is aborted syndication might still have performed a partial update, so its possible
SyndicationSummary.getChanges() returns a non empty list.
Also note that this is not directly related to item level failures reported by syndication.
The Syndication run itself can be considered successful even if there are item failures.
CANCELLED
public static final SyndicationSummary.Status CANCELLED
- This is another form of aborting that is triggered normally and not by failure. An example of this
is returning a DirectiveType.STOP in an implementation of SubscriberReady
values
public static SyndicationSummary.Status[] values()
- Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
for (SyndicationSummary.Status c : SyndicationSummary.Status.values())
System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in
the order they are declared
valueOf
public static SyndicationSummary.Status valueOf(java.lang.String name)
- Returns the enum constant of this type with the specified name.
The string must match exactly an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)
- Parameters:
- name - the name of the enum constant to be returned.
- Returns:
- the enum constant with the specified name
- Throws:
- java.lang.IllegalArgumentException - if this enum type has no constant
with the specified name
- java.lang.NullPointerException - if the argument is null