com.canto.cumulus.events

Class CatalogingEventObject<_Source>

java.lang.Object

java.util.EventObject

com.canto.cumulus.events.BaseEventObject<_Source,CatalogingListener<_Source>>

com.canto.cumulus.events.CatalogingEventObject<_Source>

All Implemented Interfaces:

java.io.Serializable

public class CatalogingEventObject<_Source>
extends BaseEventObject<_Source,CatalogingListener<_Source>>

The event object for the CatalogingListener interface.

Since:

8.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogingEventObject.CatalogingPurpose The purpose of a cataloging process.
static class	CatalogingEventObject.EventType For internal use only.

Constructor Summary

Constructors

Constructor and Description
CatalogingEventObject(CatalogingEventObject.EventType eventType, GUID processID, int currentAssetIndex, java.lang.String assetName, int itemID, java.util.Set<java.lang.Integer> ignoredItemIDs) For internal use only.
CatalogingEventObject(GUID processID, boolean isCanceled) For internal use only.
CatalogingEventObject(GUID processID, CatalogingEventObject.CatalogingPurpose catalogingPurpose) For internal use only.
CatalogingEventObject(GUID processID, int totalAssetCount) For internal use only.
CatalogingEventObject(GUID processID, int currentAssetIndex, java.lang.String assetName, java.lang.String errorMessage) For internal use only.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAssetName() Get the name of the asset being processed.
CatalogingEventObject.CatalogingPurpose	getCatalogingPurpose() Get the purpose for cataloging assets.
int	getCurrentAssetIndex() Get the current index of the asset during the cataloging process.
java.lang.String	getErrorMessage() Get the error message generated when an asset failed to catalog.
java.util.Set<java.lang.Integer>	getIgnoredItemIDs() Get the IDs of items that are ignores during cataloging of an asset.
int	getItemID() Get the ID of the item that got updated during cataloging of an asset.
GUID	getProcessID() Get the unique ID of this cataloging process.
int	getTotalAssetCount() Get the total number of asset to be cataloged.
boolean	isCanceled() Return whether the user has canceled the process.
java.lang.String	toString() Return a string representation of this event object.

Methods inherited from class com.canto.cumulus.events.BaseEventObject

getSource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CatalogingEventObject

public CatalogingEventObject(GUID processID,
                     CatalogingEventObject.CatalogingPurpose catalogingPurpose)

For internal use only.

CatalogingEventObject

public CatalogingEventObject(GUID processID,
                     boolean isCanceled)

For internal use only.

CatalogingEventObject

public CatalogingEventObject(GUID processID,
                     int totalAssetCount)

For internal use only.

CatalogingEventObject

public CatalogingEventObject(CatalogingEventObject.EventType eventType,
                     GUID processID,
                     int currentAssetIndex,
                     java.lang.String assetName,
                     int itemID,
                     java.util.Set<java.lang.Integer> ignoredItemIDs)

For internal use only.

CatalogingEventObject

public CatalogingEventObject(GUID processID,
                     int currentAssetIndex,
                     java.lang.String assetName,
                     java.lang.String errorMessage)

For internal use only.

Method Detail

getProcessID

public GUID getProcessID()

Get the unique ID of this cataloging process.

Returns:

The unique process ID of this process.

getAssetName

public java.lang.String getAssetName()

Get the name of the asset being processed.

Returns:

The current asset name

See Also:

CatalogingListener.assetAdded(CatalogingEventObject), CatalogingListener.assetUpdated(CatalogingEventObject), CatalogingListener.assetIgnored(CatalogingEventObject), CatalogingListener.assetFailed(CatalogingEventObject)

getCatalogingPurpose

public CatalogingEventObject.CatalogingPurpose getCatalogingPurpose()

Get the purpose for cataloging assets.

Returns:

The purpose of this cataloging process.

getCurrentAssetIndex

public int getCurrentAssetIndex()

Get the current index of the asset during the cataloging process. You can use this in combination with getTotalAssetCount() to monitor progress in the cataloging process.

Returns:

The current index.

See Also:

CatalogingListener.countingAssets(CatalogingEventObject)

getErrorMessage

public java.lang.String getErrorMessage()

Get the error message generated when an asset failed to catalog.

Returns:

The error message.

See Also:

CatalogingListener.assetFailed(CatalogingEventObject)

getItemID

public int getItemID()

Get the ID of the item that got updated during cataloging of an asset.

Returns:

The ID of the item that has been updated.

See Also:

CatalogingListener.assetUpdated(CatalogingEventObject)

getTotalAssetCount

public int getTotalAssetCount()

Get the total number of asset to be cataloged. This number increases while in the phase of counting the assets.

Returns:

The current total number of asset to be cataloged.

See Also:

CatalogingListener.countingAssets(CatalogingEventObject)

getIgnoredItemIDs

public java.util.Set<java.lang.Integer> getIgnoredItemIDs()

Get the IDs of items that are ignores during cataloging of an asset.

Returns:

The IDs of the item that has been ignored.

Since:

9.2

See Also:

CatalogingListener.assetIgnored(CatalogingEventObject)

isCanceled

public boolean isCanceled()

Return whether the user has canceled the process.

Returns:

true if the user has canceled the process, false otherwise.

toString

public java.lang.String toString()

Return a string representation of this event object.

Overrides:

toString in class java.util.EventObject

Returns:

this event object as a string.