com.unboundid.directory.sdk.ds.types

Interface TaskContext

@NotExtensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface TaskContext

This interface may be used to obtain information about an administrative task which is being processed.

Method Summary

Modifier and Type	Method and Description
DirectoryServerContext	getServerContext() Retrieves information about the server in which the task is being processed.
Entry	getTaskEntry() Retrieves a read-only copy of the entry that contains the definition for this task.
java.lang.String	getTaskEntryDN() Retrieves the DN of the entry that contains the definition for this task.
java.lang.String	getTaskID() Retrieves the unique identifier for this task.

Method Detail

getTaskEntryDN

java.lang.String getTaskEntryDN()

Retrieves the DN of the entry that contains the definition for this task.

Returns:

The DN of the entry that contains the definition for this task.

getTaskEntry

Entry getTaskEntry()

Retrieves a read-only copy of the entry that contains the definition for this task.

Returns:

A read-only copy of the entry that contains the definition for this task.

getTaskID

java.lang.String getTaskID()

Retrieves the unique identifier for this task.

Returns:

The unique identifier for this task.

getServerContext

DirectoryServerContext getServerContext()

Retrieves information about the server in which the task is being processed.

Returns:

Information about the server in which the task is being processed.