com.wrq.apptrieve.appconn

Class OperationMetaData

java.lang.Object

com.wrq.apptrieve.appconn.OperationMetaData

All Implemented Interfaces:

AppConnMetaData

public class OperationMetaData
extends java.lang.Object
implements AppConnMetaData

Provides metadata about an operation that is defined on an entity of a Host Integrator model.

Field Summary

Fields inherited from interface com.wrq.apptrieve.appconn.AppConnMetaData

METADATA_TYPE_ATTRIBUTE, METADATA_TYPE_COLUMN, METADATA_TYPE_FIELD, METADATA_TYPE_OPERATION, METADATA_TYPE_PROCEDURE, METADATA_TYPE_RECORDSET, METADATA_TYPE_VARIABLE

Constructor Summary

Constructors

Constructor and Description
OperationMetaData(EntityOperationMeta saObject) Constructor for internal use only.

Method Summary

Modifier and Type	Method and Description
java.util.List	getAltDestinations() Gets the alternate destination entities for the operation.
java.util.List	getAttributesUsed() Gets the attributes used in the operation.
java.lang.String	getDescription() Gets the description for the operation.
java.lang.String	getDestination() Gets the destination entity for the operation.
int	getMetaDataType() Get the meta data type for this object.
java.lang.String	getName() Gets the name of the operation.
int	getTimeout() Gets the timeout for the operation.
java.util.List	getVariablesUsed() Gets the variables used in the operation.
boolean	isDefault() Discovers whether this is the default operation for the entity.
java.lang.String	toString() Generates a String object that represents the current values of this OperationMetaData object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OperationMetaData

public OperationMetaData(EntityOperationMeta saObject)

Constructor for internal use only.

Parameters:

saObject - data

Method Detail

getAltDestinations

public java.util.List getAltDestinations()

Gets the alternate destination entities for the operation.

Returns:

List - each item is a String object that contains the name of an entity in the Apptrieve model

getAttributesUsed

public java.util.List getAttributesUsed()

Gets the attributes used in the operation.

Returns:

List - each item is a String object that contains a name of an attribute in the Apptrieve model

getDescription

public java.lang.String getDescription()

Gets the description for the operation.

Specified by:

getDescription in interface AppConnMetaData

Returns:

String

getDestination

public java.lang.String getDestination()

Gets the destination entity for the operation.

Returns:

String

getMetaDataType

public int getMetaDataType()

Get the meta data type for this object.

Specified by:

getMetaDataType in interface AppConnMetaData

Returns:

int - always returns AppConnMetaData.METADATA_TYPE_OPERATION

getName

public java.lang.String getName()

Gets the name of the operation.

Specified by:

getName in interface AppConnMetaData

Returns:

String

getTimeout

public int getTimeout()

Gets the timeout for the operation.

Returns:

int - the time out value in seconds

getVariablesUsed

public java.util.List getVariablesUsed()

Gets the variables used in the operation.

Returns:

List - each item is a String object that contains the name of a variable in the Apptrieve model

isDefault

public boolean isDefault()

Discovers whether this is the default operation for the entity.

The default operation for an entity is the operation that executes when navigating from the entity to its primary destination via the AppConnSession.setCurrentEntity() method.

Returns:

boolean

toString

public java.lang.String toString()

Generates a String object that represents the current values of this OperationMetaData object.

Overrides:

toString in class java.lang.Object

Returns:

java.lang.String the string representation of this object