com.goldencode.p2j.util

Interface CommonProcedure

All Known Subinterfaces:

CommonSession, HandleCommon, PersistentProcedure

All Known Implementing Classes:

DeferredProgramWrapper, ExternalProgramWrapper, PortTypeWrapper, ProxyProcedureWrapper

public interface CommonProcedure

Exposes the following methods or attributes, common for the SESSION and PROCEDURE handles:

attribute or method	API
SUPER-PROCEDURES	superProcedures()
ADD-SUPER-PROCEDURE	addSuperProcedure APIs
REMOVE-SUPER-PROCEDURE	removeSuperProcedure APIs

This interface is used as a returned type by the handle.unwrapCommonProcedure() API, which, depending on the handle's state and type, it either returns an SessionUtils.asHandle() instance (for SESSION handles) or an ExternalProgramWrapper instance (for PROCEDURE handles), or a dynamic proxy using handle.invalidAttrAccessProxy.

Method Summary

Modifier and Type	Method and Description
logical	addSuperProcedure(handle h) Add the given handle as a super-procedure for the current handle.
logical	addSuperProcedure(handle h, int mode) Add the given handle as a super-procedure for the current handle, using the search-mode set as a string (one of the SEARCH-TARGET or SEARCH-SELF string literals).
logical	addSuperProcedure(handle h, integer mode) Add the given handle as a super-procedure for the current handle, using the search-mode set as a string (one of the SEARCH-TARGET or SEARCH-SELF string literals).
logical	addSuperProcedure(handle h, ProcedureManager.SearchMode mode) Add the given handle as a super-procedure for the current handle, using the explicit mode.
logical	isRemote() Indicates if the procedure is ran remote.
logical	removeSuperProcedure(handle h) Remove the given handle from this handle's list of super-procedures.
character	superProcedures() Get the SUPER-PROCEDURES attribute for this SESSION or procedure handle.

Method Detail

superProcedures

character superProcedures()

Get the SUPER-PROCEDURES attribute for this SESSION or procedure handle.

Returns:

See above.

addSuperProcedure

logical addSuperProcedure(handle h)

Add the given handle as a super-procedure for the current handle.

Parameters:

h - The handle to be added as a super-procedure.

Returns:

true if h is a valid procedure handle.

addSuperProcedure

logical addSuperProcedure(handle h,
                          ProcedureManager.SearchMode mode)

Add the given handle as a super-procedure for the current handle, using the explicit mode.

Parameters:

h - The handle to be added as a super-procedure.

mode - The ProcedureManager.SearchMode to be set for the h handle.

Returns:

true if h is a valid procedure handle.

addSuperProcedure

logical addSuperProcedure(handle h,
                          int mode)

Add the given handle as a super-procedure for the current handle, using the search-mode set as a string (one of the SEARCH-TARGET or SEARCH-SELF string literals).

Parameters:

h - The handle to be added as a super-procedure.

mode - The search-mode to be set for the h handle.

Returns:

true if h is a valid procedure handle.

addSuperProcedure

logical addSuperProcedure(handle h,
                          integer mode)

Add the given handle as a super-procedure for the current handle, using the search-mode set as a string (one of the SEARCH-TARGET or SEARCH-SELF string literals).

Parameters:

h - The handle to be added as a super-procedure.

mode - The search-mode to be set for the h handle.

Returns:

true if h is a valid procedure handle.

removeSuperProcedure

logical removeSuperProcedure(handle h)

Remove the given handle from this handle's list of super-procedures.

Parameters:

h - The procedure handle to be removed.

Returns:

true if h is a valid procedure handle.

isRemote

logical isRemote()

Indicates if the procedure is ran remote.

Returns:

true if the procedure is run remote , false otherwise.