public interface Subscription
Modifier and Type | Field and Description |
---|---|
static byte |
MODE_AUTOMATIC |
static byte |
MODE_MANUAL |
static byte |
RELEASE_MODE_AUTO |
static byte |
RELEASE_MODE_WORKFLOW |
static byte |
STRATEGY_COPY
Strategy for update conflicts (the local copy and the original have been modified): .
|
static byte |
STRATEGY_ERROR
Strategy for update conflicts (the local copy and the original have been modified): An error is reported and the
update / import process is cancelled.
|
static byte |
STRATEGY_OVERRIDE
Strategy for update conflicts (the local copy and the original have been modified): Override local changes.
|
Modifier and Type | Method and Description |
---|---|
void |
addSitestoreVariableToOverride(String name)
Deprecated.
since 5.0.101 - no replacement
|
boolean |
delete()
Deletes this subscription.
|
void |
excludeNode(IDProvider storeElement)
Excludes the given storeelement from the list
of nodes which will be imported from the package.
|
byte |
getConflictMode()
The conflict mode defines a strategy to handle conflicts which occurs during the import of this subscription.
|
Collection<IDProvider> |
getExclusionNodeList()
Returns a read-only list of
StoreElement 's
which are excluded from the list of startnodes in the belonging
Package of this subscription. |
Calendar |
getLastImport()
Returns the date of the last import.
|
PackageImportLogfile |
getLastImportLogfile()
Returns the import log file of the last import of this subscription or
null
if no import log file exists. |
Package |
getPackage()
Returns the package this subscription is belonging to
|
int |
getPackageVersion()
Gets the version number of the last imported package version or
-1 |
PublishGroup |
getPublishGroup()
Gets the publish group of this subscription.
|
byte |
getReleaseMode()
Gets the release mode of this subscription.
|
Collection<String> |
getSiteStoreVariablesToOverride()
Deprecated.
since 5.0.101 - no replacement
|
Project |
getSubscriber()
Returns the subscriber
Project of this subscription. |
byte |
getUpdateMode()
Gets the update mode of this subscription.
|
Workflow |
getWorkflow(byte type)
Gets the workflow defined for the given event type.
|
String |
getWorkflowName(byte type)
Gets the name of the workflow which is mapped to the given event type.
|
boolean |
hasImportErrors()
Returns
true if an error occurred during the import
of the last PackageVersion |
void |
includeNode(IDProvider storeElement)
Includes the given storeelement to the list
of nodes which will be imported from the package.
|
boolean |
isActive()
Returns
true if this subscription is active, false otherwiseIf the subscription is inactive the update will not be processed. |
boolean |
isChangeable()
|
boolean |
isUptoDate()
Returns
true if the Package subscribed by
this Subscription has 'no' newer PackageVersion as the last imported
PackageVersion in the subscriber-project of this Subscription |
void |
pullImport()
Executes the import of this subscription.
|
void |
refresh()
Refreshes this subscription with the subcription object
from the server.
|
void |
removeSitestoreVariable(String name)
Deprecated.
since 5.0.101 - no replacement
|
void |
save()
Call to this method makes all
changes to this subscription persistent on the server.
|
void |
setActive(boolean activate)
Activates / Deactivates this subscription.
|
void |
setChangeable(boolean changeable)
Sets the changeable flag for this subscription.
|
void |
setConflictMode(byte conflictMode)
Sets the conflict mode for this subscription.
|
void |
setPublishGroup(PublishGroup value)
Sets the given publish group for this subscription
|
void |
setReleaseMode(byte releaseMode)
Sets the release mode for this subscription.
|
void |
setUpdateMode(byte updateMode)
Sets the update mode for this subscription.
|
void |
setWorkflow(byte type,
Workflow workflow)
Sets the given workflow for the given event type.
|
static final byte MODE_AUTOMATIC
static final byte MODE_MANUAL
static final byte RELEASE_MODE_AUTO
static final byte RELEASE_MODE_WORKFLOW
static final byte STRATEGY_OVERRIDE
STRATEGY_ERROR
,
STRATEGY_COPY
,
getConflictMode()
,
setConflictMode(byte)
,
Constant Field Valuesstatic final byte STRATEGY_ERROR
STRATEGY_OVERRIDE
,
STRATEGY_COPY
,
getConflictMode()
,
setConflictMode(byte)
,
Constant Field Valuesstatic final byte STRATEGY_COPY
STRATEGY_OVERRIDE
,
STRATEGY_ERROR
,
getConflictMode()
,
setConflictMode(byte)
,
Constant Field ValuesPublishGroup getPublishGroup()
During the update the latest PackageVersion
existing
in the subscribed Package
, which is published for the returned
publish group, is imported.
void setPublishGroup(PublishGroup value)
value
- Package getPackage()
@Nullable Project getSubscriber()
Project
of this subscription.@Nullable Calendar getLastImport()
null
if nothing has been imported yet@Nullable PackageImportLogfile getLastImportLogfile()
null
if no import log file exists.int getPackageVersion()
-1 if nothing
has been imported yet
PackageVersion.getVersion()
boolean isUptoDate()
true
if the Package
subscribed by
this Subscription
has 'no' newer PackageVersion
as the last imported
PackageVersion
in the subscriber-project of this Subscription
true
if uptoDate, false
otherwiseboolean hasImportErrors()
true
if an error occurred during the import
of the last PackageVersion
true
if an error occurred, false
otherwiseboolean isActive()
true
if this subscription is active, false
otherwisetrue
if this subscription is active false
otherwisevoid setActive(boolean activate)
activate
- true
to activate, false
to deactivate the subscriptionboolean isChangeable()
Package
which is subscribed by
this subscription, are changeable (true
)
in the subscriber Project
or not (false
).true
imported nodes are changeable, false
- read-onlyvoid setChangeable(boolean changeable)
changeable
- isChangeable()
@Deprecated Collection<String> getSiteStoreVariablesToOverride()
@Deprecated void addSitestoreVariableToOverride(String name)
@Deprecated void removeSitestoreVariable(String name)
void excludeNode(IDProvider storeElement)
master project
and NOT from the subscriber
.storeElement
- the element from master project respectively the element from the packagevoid includeNode(IDProvider storeElement)
master project
and NOT from the subscriber
.storeElement
- the element from master project respectively the element from the packageCollection<IDProvider> getExclusionNodeList()
StoreElement
's
which are excluded from the list of startnodes in the belonging
Package
of this subscription.StoreElement
'sbyte getUpdateMode()
MODE_AUTOMATIC
(default) the import
of this subscription will start automatically as soon as
a new version of the belonging Package
is available.MODE_MANUAL
mode the import has to be started manually.MODE_AUTOMATIC
or MODE_MANUAL
void setUpdateMode(byte updateMode)
updateMode
- MODE_AUTOMATIC
or MODE_MANUAL
getUpdateMode()
byte getReleaseMode()
RELEASE_MODE_AUTO
(default) : all nodes which were updated or
created during the import of this subscription will be released automatically.RELEASE_MODE_WORKFLOW
: after the import of this subscription
the defined release workflow (setWorkflow(byte, Workflow)
) will be started.RELEASE_MODE_AUTO
(default) or RELEASE_MODE_WORKFLOW
void setReleaseMode(byte releaseMode)
releaseMode
- RELEASE_MODE_AUTO
(default) or RELEASE_MODE_WORKFLOW
getReleaseMode()
byte getConflictMode()
STRATEGY_OVERRIDE
(default), STRATEGY_ERROR
, or STRATEGY_COPY
void setConflictMode(byte conflictMode)
conflictMode
- STRATEGY_OVERRIDE
, STRATEGY_ERROR
, or STRATEGY_COPY
getConflictMode()
Workflow getWorkflow(byte type)
Package
. This mapping could be overridden
by using setWorkflow(byte, Workflow)
type
- Package.WF_OK
, Package.WF_ERROR
, Package.WF_CONFLICT
, Package.WF_RELEASE
, Package.WF_ACTUALIZE
String getWorkflowName(byte type)
type
- Package.WF_OK
, Package.WF_ERROR
, Package.WF_CONFLICT
, Package.WF_RELEASE
, Package.WF_ACTUALIZE
null
if no workflow is defined for this type, else the node id of the workflow nodevoid setWorkflow(byte type, Workflow workflow)
type
- Package.WF_OK
, Package.WF_ERROR
, Package.WF_CONFLICT
, Package.WF_RELEASE
, Package.WF_ACTUALIZE
workflow
- void pullImport()
PackageVersion
existing in the
underlying Package
will be imported.NoPackageVersionExistingException
- if no PackageVersion
existing in belonging the Package
which is released for the underlying PublishGroup
getLastImportLogfile()
void save()
boolean delete()
true
if this subscription was successfully deleted, false
otherwisevoid refresh()
Copyright © 2015 e-Spirit AG. All Rights Reserved. Build 5.1.408