oracle.ecsf
Interface ApplicationExtension

public interface ApplicationExtension

Method Summary

oracle.jbo.ApplicationModule	createApplicationModule(java.lang.String amConfig) Creates a new AM when needed.
Attachment	createAttachment(DocumentDefinition doc, java.lang.Object row) Creates an attachment by the extension.
java.lang.String	format(java.lang.Object object) Return formatted string based on current session user locale.
java.util.Collection<java.lang.String>	getApplicationIds(java.lang.String pillarName) Returns a list of application ids for a given pillar name
java.lang.String	getCredentialKeyString(long engineId, java.lang.String username, java.lang.String delimiter) Return the credential key string based on the username.
java.lang.String	getCredentialMapString(java.lang.String username) Return the credential map string based on the username.
void	initializeSession(java.lang.String username) Initialize application specific session.
void	releaseSession() Release application specific session.

Method Detail

createAttachment

Attachment createAttachment(DocumentDefinition doc,
                            java.lang.Object row)

Creates an attachment by the extension. Return null if the extension does not create an attachment.

Parameters:

doc - document definition an attachment is defined

row - the data to be used for creating an attachment.

Returns:

Attachment if able to create, or null

initializeSession

void initializeSession(java.lang.String username)

Initialize application specific session. Username can be obtained from search context.

Parameters:

username - the user for who the session will be initialized for.

releaseSession

void releaseSession()

Release application specific session.

createApplicationModule

oracle.jbo.ApplicationModule createApplicationModule(java.lang.String amConfig)

Creates a new AM when needed. Return null if the extension does not want to handle it.

Returns:

application module

getApplicationIds

java.util.Collection<java.lang.String> getApplicationIds(java.lang.String pillarName)

Returns a list of application ids for a given pillar name

Parameters:

pillarName - - an expression understood by the extension

Returns:

a list of application ids.

format

java.lang.String format(java.lang.Object object)

Return formatted string based on current session user locale.

Parameters:

object - the Object to be formatted.

Returns:

formatted string.

getCredentialMapString

java.lang.String getCredentialMapString(java.lang.String username)

Return the credential map string based on the username.

Parameters:

username - - the username.

Returns:

string.

getCredentialKeyString

java.lang.String getCredentialKeyString(long engineId,
                                        java.lang.String username,
                                        java.lang.String delimiter)

Return the credential key string based on the username.

Parameters:

engineId - - the username.

username - - the username.

delimiter - - the delimiter.

Returns:

string.