Skip navigation links

oracle.iam.rm.server_api
Interface ServerOperation

All Superinterfaces:

java.io.Serializable

public interface ServerOperation

extends java.io.Serializable

The generic operation interface exposed by the server. <p/> This is not normally referred to directly by consuming systems that would instead use the Client API's Operation interface.

See Also:

Operation

Field Summary

static int	TYPE_BUSINESS_TASK The constant representing the BUSINESS TASK operation type (3).
static int	TYPE_LOOKUP The constant representing the LOOKUP operation type (1).
static int	TYPE_SEARCH The constant representing the SEARCH operation type (2).
static int	TYPE_SUPPLEMENTAL The constant representing the SUPPLMENTAL operation type (4).

Method Summary

ArgumentDefinition[]	getArgumentDefinitions() Gets the argument definitions for this operation.
java.lang.String	getDefinitionId() Gets the ID of the definition in which this operation is defined.
java.lang.String	getDescription() Gets the description of this operation.
java.lang.String	getLocalOperationId() Gets the local ID of this operation if used for a supplemental operation.
java.lang.String	getOperationId() Gets the ID of this operation.
java.lang.String	getTitle() Gets the title of this operation.
int	getType() Gets the type of operation that this represents, either 1 for LOOKUP, 2 for SEARCH, 3 for BUSINESS TASK, or 4 for SUPPLEMENTAL.

Field Detail

TYPE_LOOKUP

static final int TYPE_LOOKUP

The constant representing the LOOKUP operation type (1).

See Also:

Constant Field Values

TYPE_SEARCH

static final int TYPE_SEARCH

The constant representing the SEARCH operation type (2).

See Also:

Constant Field Values

TYPE_BUSINESS_TASK

static final int TYPE_BUSINESS_TASK

The constant representing the BUSINESS TASK operation type (3).

See Also:

Constant Field Values

TYPE_SUPPLEMENTAL

static final int TYPE_SUPPLEMENTAL

The constant representing the SUPPLMENTAL operation type (4).

See Also:

Constant Field Values

Method Detail

getDefinitionId

java.lang.String getDefinitionId()

Gets the ID of the definition in which this operation is defined.

Returns:

ID of the definition in which this operation is defined.

getOperationId

java.lang.String getOperationId()

Gets the ID of this operation.

Returns:

ID of this operation.

getTitle

java.lang.String getTitle()

Gets the title of this operation.

Returns:

title of this operation.

getDescription

java.lang.String getDescription()

Gets the description of this operation.

Returns:

description of this operation.

getType

int getType()

Gets the type of operation that this represents, either 1 for LOOKUP, 2 for SEARCH, 3 for BUSINESS TASK, or 4 for SUPPLEMENTAL.

Returns:

Integer representing the type of operation that this represents.

getArgumentDefinitions

ArgumentDefinition[] getArgumentDefinitions()

Gets the argument definitions for this operation.

Returns:

Array of argument definitions for this operation.

getLocalOperationId

java.lang.String getLocalOperationId()

Gets the local ID of this operation if used for a supplemental operation.

Returns:

String representing the local ID of this operation if it is supplemental, otherwise null if it is not supplemental.

Skip navigation links