com.bowstreet.webapp
Interface LogicalOperationDescriptor

public interface LogicalOperationDescriptor

Copyright IBM (c) 2009 LogicalOperationDescriptor This defines the high level of meta data for a DataServices object, giving a meaning to the operations defined within the service, as well as some other info

Author:

szagiebo

Field Summary

static java.lang.String	LOGICAL_OPERATION_CREATE
static java.lang.String	LOGICAL_OPERATION_DELETE
static java.lang.String	LOGICAL_OPERATION_RETRIEVELIST
static java.lang.String	LOGICAL_OPERATION_RETRIEVEONE
static java.lang.String	LOGICAL_OPERATION_SEARCH
static java.lang.String	LOGICAL_OPERATION_UPDATE
static java.lang.String[]	LOGICAL_OPERATIONS

Method Summary

java.lang.String	getKeyFieldProduced() Gets the name of the key field in this operation's result values.
java.lang.String	getKeyFieldRequired() Gets the name of the key field in this operation's input values.
java.lang.String	getLogicalName() Get the Logical name,
java.lang.String	getOperationName() Gets the name of the service operation within the containing service that performs the named function.
void	setKeyFieldProduced(java.lang.String fieldName) set the name of the key field in this operation's result values
void	setKeyFieldRequired(java.lang.String fieldName) set the name of the key field that this operation requires
void	setOperationName(java.lang.String name) Set the name of the service operation within the containing service that performs this logical operation.

Field Detail

LOGICAL_OPERATION_CREATE

static final java.lang.String LOGICAL_OPERATION_CREATE

See Also:

Constant Field Values

LOGICAL_OPERATION_DELETE

static final java.lang.String LOGICAL_OPERATION_DELETE

See Also:

Constant Field Values

LOGICAL_OPERATION_RETRIEVELIST

static final java.lang.String LOGICAL_OPERATION_RETRIEVELIST

See Also:

Constant Field Values

LOGICAL_OPERATION_RETRIEVEONE

static final java.lang.String LOGICAL_OPERATION_RETRIEVEONE

See Also:

Constant Field Values

LOGICAL_OPERATION_SEARCH

static final java.lang.String LOGICAL_OPERATION_SEARCH

See Also:

Constant Field Values

LOGICAL_OPERATION_UPDATE

static final java.lang.String LOGICAL_OPERATION_UPDATE

See Also:

Constant Field Values

LOGICAL_OPERATIONS

static final java.lang.String[] LOGICAL_OPERATIONS

Method Detail

getKeyFieldProduced

java.lang.String getKeyFieldProduced()

Gets the name of the key field in this operation's result values.

Returns:

the name of the field in that operation's result values

getKeyFieldRequired

java.lang.String getKeyFieldRequired()

Gets the name of the key field in this operation's input values.

Returns:

the name of the field in that operation's input values

getLogicalName

java.lang.String getLogicalName()

Get the Logical name,

Returns:

the Logical name, which is usually one of the LOGICAL_OPERATION strings

getOperationName

java.lang.String getOperationName()

Gets the name of the service operation within the containing service that performs the named function.

Returns:

the service operation name.

setKeyFieldProduced

void setKeyFieldProduced(java.lang.String fieldName)

set the name of the key field in this operation's result values

Parameters:

fieldName - field name

setKeyFieldRequired

void setKeyFieldRequired(java.lang.String fieldName)

set the name of the key field that this operation requires

Parameters:

fieldName - key field name or null.

setOperationName

void setOperationName(java.lang.String name)

Set the name of the service operation within the containing service that performs this logical operation.

Parameters:

name - the name of a service operation.