Interface ICursor

All Superinterfaces:

IDisposable, IEntity

All Known Subinterfaces:

IAgentCursor, IAgentInCampaignOperationLogCursor, IAgentOperationLogCursor, ICampaignCursor, ICampaignOperationLogCursor, IConfigurationLogCursor, IConsentAuditCursor, IConsentCursor, IContactCursor, IContactHistoryCursor, IContactProfileCursor, IContactProfileFieldPrivacyCursor, IContactProfileGdprRequestCursor, IContactProfileInProgressWorkflowCursor, IContactProfileInteractionHistoryCursor, IContactProfileQueuedEmailCursor, IContactProfileQueuedSocialCursor, IContactProfileScheduledContactCursor, ICubeCursor, IDocumentCursor, IEntityCursor, IInstanceOperationLogCursor, IInteractionHistoryCursor, IInteractionThreadCursor, IKBDocumentCursor, IMediaCursor, IOxeSynchroDashboardCursor, IPendingWorkCursor, IPrivacyCategoryCursor, IPurposeCursor, IQueuedAgentPickUpTaskCursor, IQueuedEmailCursor, IQueuedSocialCursor, IRecordingCursor, IReportTemplateCursor, IRoleCursor, ISavedReportCursor, IScriptDocumentCursor, ISentEmailCursor, ISentSocialCursor, IServiceCursor, ISqlCursor, ISystemEventLogCursor, ITeamCursor, IUserDefinedEnumeratedFieldCursor, IWorkflowDefinitionCursor

public interface ICursor
extends IEntity

Represents a cursor on an entity

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the cursor.
void	closeOnIdleTimeout(Duration timeout)	Automatically close the cursor when it is idle for the specified amount of time.
void	closeOnSessionCleared(int sessionId)	Automatically close the cursor when the specified session is cleared.
int	getId()	Identifier of the cursor.
CursorState	getState()	State of the cursor.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

close

void close()
    throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Closes the cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

closeOnIdleTimeout

void closeOnIdleTimeout(Duration timeout)
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Automatically close the cursor when it is idle for the specified amount of time.

Parameters:

timeout - Timeout.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

closeOnSessionCleared

void closeOnSessionCleared(int sessionId)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Automatically close the cursor when the specified session is cleared. If the session does not exist, then the cursor is closed immediately.

Parameters:

sessionId - Identifier of the session.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getId

int getId()
   throws Exception,
altitude.integrationServer.exceptions.ISException

Identifier of the cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getState

CursorState getState()
              throws Exception,
altitude.integrationServer.exceptions.ISException

State of the cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException