Package de.espirit.firstspirit.access.packagepool

Interface ImportInfo

All Superinterfaces:

Serializable

public interface ImportInfo
extends Serializable

This interface provides information about a packagepool subscription update.
An instance of this interface will be available in the session of a workflow mapped with IMPORT_INFO_KEY.

Since:

3.1.165

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IMPORT_INFO_KEY	Use context.getSession().get(IMPORT_INFO_KEY) to get the import info object

Method Summary

Modifier and Type	Method	Description
IDProvider	getConflictNode(int index)	Returns the conflicted node at the specified index. Call setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.
int	getConflictNodeCount()	Returns the count of nodes which caused conflicts during belonging package import.
int	getImportVersion()	Returns the version of the package version which had been imported.
String	getImportVersionTag()	Returns the tag of the package version which had been imported.
IDProvider	getNewNode(int index)	Returns the added node at the specified index. Call setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.
int	getNewNodeCount()	Returns the count of nodes which were added during belonging package import.
String	getPackageName()	Returns the name of the package which had been imported.
IDProvider	getRemovedNode(int index)	Returns the removed node at the specified index. Call setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.
int	getRemovedNodeCount()	Returns the count of nodes which were removed during belonging package import.
String	getSubscriber()	Returns the name of the subscriber project.
long	getSubscriberId()	Returns the id of the subscriber project.
IDProvider	getUpdatedNode(int index)	Returns the updated node at the specified index. Call setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.
int	getUpdatedNodeCount()	Returns the count of nodes which were updated during belonging package import.
void	setUserService(UserService value)	Sets the userservice which will be used to load underlying nodes.

Field Details

IMPORT_INFO_KEY

static final String IMPORT_INFO_KEY

Use context.getSession().get(IMPORT_INFO_KEY) to get the import info object

Since:

4.2.30

See Also:

• Constant Field Values

Method Details

setUserService

void setUserService(UserService value)

Sets the userservice which will be used to load underlying nodes.

Since:

3.1.165

See Also:

• getNewNode(int)
• getUpdatedNode(int)
• getConflictNode(int)
• getRemovedNode(int)

getPackageName

String getPackageName()

Returns the name of the package which had been imported.

Returns:

the name of the belonging package

Since:

4.2.30

getSubscriber

String getSubscriber()

Returns the name of the subscriber project.

Returns:

the name of the subscriber project.

Since:

4.2.30

See Also:

• Subscription.getSubscriber()

getSubscriberId

long getSubscriberId()

Returns the id of the subscriber project.

Returns:

the id of the subscriber project.

Since:

4.2.30

See Also:

• Subscription.getSubscriber()

getImportVersionTag

String getImportVersionTag()

Returns the tag of the package version which had been imported.

Returns:

the tag of the imported package version

Since:

4.2.30

getImportVersion

int getImportVersion()

Returns the version of the package version which had been imported.

Returns:

the version of the imported package version

Since:

4.2.30

getNewNodeCount

int getNewNodeCount()

Returns the count of nodes which were added during belonging package import.

Since:

3.1.165

See Also:

• getNewNode(int)

getNewNode

IDProvider getNewNode(int index)

Returns the added node at the specified index.
Call setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.

Throws:

IllegalStateException - if no userservice is set

Since:

3.1.165

See Also:

• getNewNodeCount()

getUpdatedNodeCount

int getUpdatedNodeCount()

Returns the count of nodes which were updated during belonging package import.

Since:

3.1.165

See Also:

• getUpdatedNode(int)

getUpdatedNode

IDProvider getUpdatedNode(int index)

Returns the updated node at the specified index.
Call setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.

Throws:

IllegalStateException - if no userservice is set

Since:

3.1.165

See Also:

• getUpdatedNodeCount()

getConflictNodeCount

int getConflictNodeCount()

Returns the count of nodes which caused conflicts during belonging package import.

Since:

3.1.165

See Also:

• getConflictNode(int)

getConflictNode

IDProvider getConflictNode(int index)

Returns the conflicted node at the specified index.
Call setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.

Throws:

IllegalStateException - if no userservice is set

Since:

3.1.165

See Also:

• getConflictNodeCount()

getRemovedNodeCount

int getRemovedNodeCount()

Returns the count of nodes which were removed during belonging package import.

Since:

3.1.165

See Also:

• getRemovedNode(int)

getRemovedNode

IDProvider getRemovedNode(int index)

Returns the removed node at the specified index.
Call setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.

Throws:

IllegalStateException - if no userservice is set

Since:

3.1.165

See Also:

• getRemovedNode(int)