Package com.oracle.database.selectai

Interface Profile

public interface Profile

Contract for Select AI profile lifecycle, prompt execution, and attribute management.

An AI profile is the database-side configuration that tells Select AI which provider and AI model to use, which credential authorizes provider calls, and which schema metadata or vector index should be used when answering natural language prompts. A Profile instance may represent a profile created by this Java SDK, PL/SQL, Python, SQL tools, or any other client, as long as that profile is visible in the current schema.

A Profile object can be configured for creation or database-backed. A configured profile has a profile name, attributes, description, and status in memory, but it is not persisted until create() succeeds. A database-backed profile is opened from the database, listed from metadata, or successfully created through this SDK.

Metadata getters can return configured values before creation. Operations that execute against an existing database profile, such as prompt generation, attribute updates, enable, disable, drop, feedback, summarize, translate, and synthetic-data generation, require a database-backed profile. The SDK rejects those operations with IllegalStateException when the object is not bound to a profile name or is configured for creation but has not been created yet.

See Also:

• Manage AI profiles
• About Select AI

Method Summary

Modifier and Type	Method	Description
String	chat(String prompt)	Sends the prompt as a chat-style request using this profile.
String	chat(String prompt, GenerateParams generateParams)	Sends the prompt as a chat-style request using optional generate parameters.
Session	chatSession(Conversation conversation)	Starts a Select AI chat session using the supplied conversation.
Session	chatSession(Conversation conversation, boolean deleteOnClose)	Starts a Select AI chat session using the supplied conversation.
boolean	create()	Creates this configured profile in the database.
boolean	disable()	Disables this profile so callers cannot use it for Select AI operations until it is enabled again.
boolean	drop(boolean force)	Drops this profile from the database.
boolean	enable()	Enables this profile so it can be used for Select AI operations.
String	explainsql(String prompt)	Generates SQL and returns a natural-language explanation.
String	explainsql(String prompt, GenerateParams generateParams)	Generates SQL and returns a natural-language explanation using optional generate parameters.
boolean	feedback(Feedback feedbackRequest)	Stores or removes feedback about generated SQL for this profile.
String	generate(String prompt, GenerateAction generateAction)	Sends a natural-language prompt to Select AI using this profile.
String	generate(String prompt, GenerateAction generateAction, GenerateParams generateParams)	Sends a natural-language prompt to Select AI using this profile and optional generate parameters.
String	generate(String prompt, GenerateAction generateAction, ProfileAttributes profileAttributes)	Sends a natural-language prompt to Select AI using this profile and request-level profile attributes.
String	generate(String prompt, GenerateAction generateAction, ProfileAttributes profileAttributes, GenerateParams generateParams)	Sends a natural-language prompt to Select AI using this profile, request-level profile attributes, and optional generate parameters.
boolean	generateSyntheticData(SyntheticDataBatchRequest request)	Generates synthetic data using this profile for multiple objects in one request.
boolean	generateSyntheticData(SyntheticDataSingleRequest request)	Generates synthetic data using this profile and a single-object request payload.
String	getDescription()	Returns profile description.
ProfileAttributes	getProfileAttributes()	Returns profile attributes.
String	getProfileName()	Returns profile name.
String	getStatus()	Returns profile status.
String	narrate(String prompt)	Generates and runs SQL, then asks the model to narrate the result.
String	narrate(String prompt, GenerateParams generateParams)	Generates and runs SQL, then asks the model to narrate the result using optional generate parameters.
String	runsql(String prompt)	Generates SQL from the prompt and runs it.
String	runsql(String prompt, GenerateParams generateParams)	Generates SQL from the prompt and runs it using optional generate parameters.
boolean	setAttribute(String attributeName, boolean attributeValue)	Updates one profile attribute using a boolean value.
boolean	setAttribute(String attributeName, Float attributeValue)	Updates one profile attribute using a floating-point value.
boolean	setAttribute(String attributeName, Integer attributeValue)	Updates one profile attribute using an integer value.
boolean	setAttribute(String attributeName, String attributeValue)	Updates one profile attribute using a string value.
boolean	setAttributes(ProfileAttributes profileAttributes)	Replaces or updates multiple profile attributes in one operation.
String	showprompt(String prompt)	Returns the augmented prompt that Select AI would send to the provider.
String	showprompt(String prompt, GenerateParams generateParams)	Returns the augmented prompt that Select AI would send to the provider using optional generate parameters.
String	showsql(String prompt)	Generates SQL from the prompt without running it.
String	showsql(String prompt, GenerateParams generateParams)	Generates SQL from the prompt without running it using optional generate parameters.
String	summarize(String content, String credential_name, String location_uri, String userPrompt, SummaryParams params)	Summarizes inline text or content read from an external location.
String	translate(String text)	Translates text using the provider configured by this profile.
String	translate(String text, String targetLanguage)	Translates text using the provider configured by this profile and an explicit target language.
String	translate(String text, String sourceLanguage, String targetLanguage)	Translates text using the provider configured by this profile.

Method Details

create

boolean create()
        throws SelectAIException

Creates this configured profile in the database.

For a complete runnable sample source, see CreateProfileSample source.

Returns:

true when create succeeds

Throws:

IllegalStateException - when this Profile instance is not configured for creation

SelectAIException - when create fails

drop

boolean drop(boolean force)
      throws SelectAIException

Drops this profile from the database.

Use this when the provider and AI model configuration is no longer needed. The operation affects the database profile object, not only the Java object. For a complete runnable sample source, see DropProfileSample source.

Parameters:

force - when true, force drop is attempted

Returns:

true when drop succeeds

Throws:

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when drop fails

enable

boolean enable()
        throws SelectAIException

Enables this profile so it can be used for Select AI operations.

For a complete runnable sample source, see EnableProfileSample source.

Returns:

true when enable succeeds

Throws:

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when enable fails

disable

boolean disable()
         throws SelectAIException

Disables this profile so callers cannot use it for Select AI operations until it is enabled again.

For a complete runnable sample source, see DisableProfileSample source.

Returns:

true when disable succeeds

Throws:

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when disable fails

generate

String generate(String prompt,
 GenerateAction generateAction)
         throws SelectAIException

Sends a natural-language prompt to Select AI using this profile.

The selected action determines whether Select AI runs SQL, returns SQL, explains SQL, narrates query results, chats, generates embeddings, or shows the provider-facing prompt. For a complete runnable sample source, see GenerateProfileSample source.

Parameters:

prompt - natural language prompt

generateAction - action type (runsql, showsql, chat, embedding, etc.)

Returns:

generated response text

Throws:

IllegalArgumentException - when prompt is null/blank or generateAction is null

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

generate

String generate(String prompt,
 GenerateAction generateAction,
 ProfileAttributes profileAttributes)
         throws SelectAIException

Sends a natural-language prompt to Select AI using this profile and request-level profile attributes.

The supplied profileAttributes are passed only for this generate request. They do not update the stored profile definition. For a complete runnable sample source, see GenerateWithProfileAttributesSample source.

Parameters:

prompt - natural language prompt

generateAction - action type (runsql, showsql, chat, embedding, etc.)

profileAttributes - optional request-level profile attributes

Returns:

generated response text

Throws:

IllegalArgumentException - when prompt is null/blank or generateAction is null

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

generate

String generate(String prompt,
 GenerateAction generateAction,
 GenerateParams generateParams)
         throws SelectAIException

Sends a natural-language prompt to Select AI using this profile and optional generate parameters.

Generate parameters are serialized to the params payload accepted by DBMS_CLOUD_AI.GENERATE. For example, callers can pass a conversation identifier for context-aware chat requests. For a complete runnable sample source, see GenerateWithGenerateParamsSample source.

Parameters:

prompt - natural language prompt

generateAction - action type (runsql, showsql, chat, embedding, etc.)

generateParams - optional generate parameters

Returns:

generated response text

Throws:

IllegalArgumentException - when prompt is null/blank or generateAction is null

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

generate

String generate(String prompt,
 GenerateAction generateAction,
 ProfileAttributes profileAttributes,
 GenerateParams generateParams)
         throws SelectAIException

Sends a natural-language prompt to Select AI using this profile, request-level profile attributes, and optional generate parameters.

The supplied profileAttributes are passed only for this generate request and do not update the stored profile definition. generateParams are serialized to the params payload accepted by DBMS_CLOUD_AI.GENERATE. For a complete runnable sample source, see GenerateWithProfileAttributesAndGenerateParamsSample source.

Parameters:

prompt - natural language prompt

generateAction - action type (runsql, showsql, chat, embedding, etc.)

profileAttributes - optional request-level profile attributes

generateParams - optional generate parameters

Returns:

generated response text

Throws:

IllegalArgumentException - when prompt is null/blank or generateAction is null

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

runsql

String runsql(String prompt)
       throws SelectAIException

Generates SQL from the prompt and runs it.

Use this for NL2SQL workflows where the application wants the database result rather than only the generated SQL text. For a complete runnable sample source, see RunSqlProfileSample source.

Parameters:

prompt - natural language prompt

Returns:

generated SQL execution result/content

Throws:

IllegalArgumentException - when prompt is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

See Also:

• generate(String, GenerateAction)

runsql

String runsql(String prompt,
 GenerateParams generateParams)
       throws SelectAIException

Generates SQL from the prompt and runs it using optional generate parameters.

For a complete runnable sample source, see RunSqlWithGenerateParamsSample source.

Parameters:

prompt - natural language prompt

generateParams - optional generate parameters, such as conversation ID

Returns:

generated SQL execution result/content

Throws:

IllegalArgumentException - when prompt is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

See Also:

• generate(String, GenerateAction, GenerateParams)

showsql

String showsql(String prompt)
        throws SelectAIException

Generates SQL from the prompt without running it.

Use this when the application wants to review, log, or approve SQL before execution. For a complete runnable sample source, see ShowSqlProfileSample source.

Parameters:

prompt - natural language prompt

Returns:

generated SQL text

Throws:

IllegalArgumentException - when prompt is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

See Also:

• generate(String, GenerateAction)

showsql

String showsql(String prompt,
 GenerateParams generateParams)
        throws SelectAIException

Generates SQL from the prompt without running it using optional generate parameters.

For a complete runnable sample source, see ShowSqlWithGenerateParamsSample source.

Parameters:

prompt - natural language prompt

generateParams - optional generate parameters, such as conversation ID

Returns:

generated SQL text

Throws:

IllegalArgumentException - when prompt is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

See Also:

• generate(String, GenerateAction, GenerateParams)

explainsql

String explainsql(String prompt)
           throws SelectAIException

Generates SQL and returns a natural-language explanation.

For a complete runnable sample source, see ExplainSqlProfileSample source.

Parameters:

prompt - natural language prompt

Returns:

explanation of generated SQL

Throws:

IllegalArgumentException - when prompt is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

See Also:

• generate(String, GenerateAction)

explainsql

String explainsql(String prompt,
 GenerateParams generateParams)
           throws SelectAIException

Generates SQL and returns a natural-language explanation using optional generate parameters.

For a complete runnable sample source, see ExplainSqlWithGenerateParamsSample source.

Parameters:

prompt - natural language prompt

generateParams - optional generate parameters, such as conversation ID

Returns:

explanation of generated SQL

Throws:

IllegalArgumentException - when prompt is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

See Also:

• generate(String, GenerateAction, GenerateParams)

narrate

String narrate(String prompt)
        throws SelectAIException

Generates and runs SQL, then asks the model to narrate the result.

This action can require data access because the model may receive query result values to produce the narrative response. For a complete runnable sample source, see NarrateProfileSample source.

Parameters:

prompt - natural language prompt

Returns:

narrative response

Throws:

IllegalArgumentException - when prompt is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

See Also:

• generate(String, GenerateAction)

narrate

String narrate(String prompt,
 GenerateParams generateParams)
        throws SelectAIException

Generates and runs SQL, then asks the model to narrate the result using optional generate parameters.

For a complete runnable sample source, see NarrateWithGenerateParamsSample source.

Parameters:

prompt - natural language prompt

generateParams - optional generate parameters, such as conversation ID

Returns:

narrative response

Throws:

IllegalArgumentException - when prompt is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

See Also:

• generate(String, GenerateAction, GenerateParams)

showprompt

String showprompt(String prompt)
           throws SelectAIException

Returns the augmented prompt that Select AI would send to the provider.

Use this for troubleshooting profile metadata, object selection, and prompt augmentation behavior. For a complete runnable sample source, see ShowPromptProfileSample source.

Parameters:

prompt - natural language prompt

Returns:

rewritten/provider-facing prompt

Throws:

IllegalArgumentException - when prompt is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

See Also:

• generate(String, GenerateAction)

showprompt

String showprompt(String prompt,
 GenerateParams generateParams)
           throws SelectAIException

Returns the augmented prompt that Select AI would send to the provider using optional generate parameters.

For a complete runnable sample source, see ShowPromptWithGenerateParamsSample source.

Parameters:

prompt - natural language prompt

generateParams - optional generate parameters, such as conversation ID

Returns:

rewritten/provider-facing prompt

Throws:

IllegalArgumentException - when prompt is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

See Also:

• generate(String, GenerateAction, GenerateParams)

chat

String chat(String prompt)
     throws SelectAIException

Sends the prompt as a chat-style request using this profile.

For a complete runnable sample source, see ChatProfileSample source.

Parameters:

prompt - natural language prompt

Returns:

chat response

Throws:

IllegalArgumentException - when prompt is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

See Also:

• generate(String, GenerateAction)

chat

String chat(String prompt,
 GenerateParams generateParams)
     throws SelectAIException

Sends the prompt as a chat-style request using optional generate parameters.

For a complete runnable sample source, see ChatWithGenerateParamsSample source.

Parameters:

prompt - natural language prompt

generateParams - optional generate parameters, such as conversation ID

Returns:

chat response

Throws:

IllegalArgumentException - when prompt is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when generation fails

See Also:

• generate(String, GenerateAction, GenerateParams)

chatSession

Session chatSession(Conversation conversation)
             throws SelectAIException

Starts a Select AI chat session using the supplied conversation.

If the conversation does not yet have a conversation ID, this method calls Conversation.create() before creating the session. The resulting conversation ID is sent with each session generation request. For a complete runnable sample source, see ChatSessionWithoutDeleteSample source.

Parameters:

conversation - conversation to use for context-aware generation

Returns:

session bound to the conversation ID

Throws:

IllegalArgumentException - when conversation is null

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when conversation creation or session initialization fails

chatSession

Session chatSession(Conversation conversation,
 boolean deleteOnClose)
             throws SelectAIException

Starts a Select AI chat session using the supplied conversation.

When deleteOnClose is true, Session.close() drops the conversation. Closing the session does not close this profile, the SelectAI client, or the underlying JDBC connection. For a complete runnable sample source, see ChatSessionProfileSample source.

Parameters:

conversation - conversation to use for context-aware generation

deleteOnClose - whether to drop the conversation when the session closes

Returns:

session bound to the conversation ID

Throws:

IllegalArgumentException - when conversation is null

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when conversation creation, drop, or session initialization fails

setAttribute

boolean setAttribute(String attributeName,
 String attributeValue)
              throws SelectAIException

Updates one profile attribute using a string value.

Profile attributes tune provider settings, object selection, AI model behavior, RAG configuration, and other Select AI behavior. For a complete runnable sample source, see SetProfileStringAttributeSample source.

Parameters:

attributeName - attribute name

attributeValue - attribute value (null clears attribute where supported)

Returns:

true when update succeeds

Throws:

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when update fails

setAttribute

boolean setAttribute(String attributeName,
 boolean attributeValue)
              throws SelectAIException

Updates one profile attribute using a boolean value.

For a complete runnable sample source, see SetProfileBooleanAttributeSample source.

Parameters:

attributeName - attribute name

attributeValue - boolean value

Returns:

true when update succeeds

Throws:

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when update fails

setAttribute

boolean setAttribute(String attributeName,
 Integer attributeValue)
              throws SelectAIException

Updates one profile attribute using an integer value.

For a complete runnable sample source, see SetProfileIntegerAttributeSample source.

Parameters:

attributeName - attribute name

attributeValue - integer value

Returns:

true when update succeeds

Throws:

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when update fails

setAttribute

boolean setAttribute(String attributeName,
 Float attributeValue)
              throws SelectAIException

Updates one profile attribute using a floating-point value.

For a complete runnable sample source, see SetProfileFloatAttributeSample source.

Parameters:

attributeName - attribute name

attributeValue - float value

Returns:

true when update succeeds

Throws:

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when update fails

setAttributes

boolean setAttributes(ProfileAttributes profileAttributes)
               throws SelectAIException

Replaces or updates multiple profile attributes in one operation.

For a complete runnable sample source, see SetProfileAttributesSample source.

Parameters:

profileAttributes - attributes payload

Returns:

true when update succeeds

Throws:

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when update fails

feedback

boolean feedback(Feedback feedbackRequest)
          throws SelectAIException

Stores or removes feedback about generated SQL for this profile.

Feedback is profile-specific guidance for NL2SQL behavior, not a general rating for chat or RAG answers. Positive feedback confirms that generated SQL is useful; negative feedback can include the expected response and explanatory comments so future prompts can be guided toward a better SQL shape. The target profile is this Profile instance. For a complete runnable sample source, see SubmitFeedbackProfileSample source.

Parameters:

feedbackRequest - feedback payload

Returns:

true when feedback is successfully submitted

Throws:

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when submission fails

See Also:

• DBMS_CLOUD_AI feedback reference

generateSyntheticData

boolean generateSyntheticData(SyntheticDataSingleRequest request)
                       throws SelectAIException

Generates synthetic data using this profile and a single-object request payload.

The target AI profile is this Profile instance. The request object keeps the object name, owner, row count, prompt guidance, and optional generation parameters together. For a complete runnable sample source, see GenerateSyntheticDataSingleRequestSample source.

Parameters:

request - single request payload

Returns:

true when generation request is accepted/succeeds

Throws:

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when single-request synthetic data generation fails

See Also:

• DBMS_CLOUD_AI synthetic data reference

generateSyntheticData

boolean generateSyntheticData(SyntheticDataBatchRequest request)
                       throws SelectAIException

Generates synthetic data using this profile for multiple objects in one request.

Batch generation is useful for related tables where referential or domain consistency across generated data matters. The target AI profile is this Profile instance. For a complete runnable sample source, see GenerateSyntheticDataBatchRequestSample source.

Parameters:

request - batch request payload

Returns:

true when generation request is accepted/succeeds

Throws:

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when batch synthetic data generation fails

See Also:

• DBMS_CLOUD_AI synthetic data reference

summarize

String summarize(String content,
 String credential_name,
 String location_uri,
 String userPrompt,
 SummaryParams params)
          throws SelectAIException

Summarizes inline text or content read from an external location.

Use this operation when the application wants a concise natural-language summary rather than generated SQL. The request may provide text directly or reference content through a location and credential. For a complete runnable sample source, see SummarizeProfileSample source.

Parameters:

content - inline content

credential_name - credential name for external source access

location_uri - source URI

userPrompt - summarization prompt/instructions

params - typed summarization parameters

Returns:

summary text

Throws:

IllegalArgumentException - when neither or both of content and location_uri are provided

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when the database summarization call fails

See Also:

• DBMS_CLOUD_AI summarization reference

translate

String translate(String text)
          throws SelectAIException

Translates text using the provider configured by this profile.

Source and target languages are omitted. The database can use profile language attributes or source-language detection according to DBMS_CLOUD_AI.TRANSLATE behavior. For a complete runnable sample source, see TranslateProfileSample source.

Parameters:

text - source text

Returns:

translated text

Throws:

IllegalArgumentException - when text is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when translation fails

translate

String translate(String text,
 String targetLanguage)
          throws SelectAIException

Translates text using the provider configured by this profile and an explicit target language.

The source language is omitted. The database can use profile language attributes or source-language detection according to DBMS_CLOUD_AI.TRANSLATE behavior. For a complete runnable sample source, see TranslateProfileSample source.

Parameters:

text - source text

targetLanguage - target language/code

Returns:

translated text

Throws:

IllegalArgumentException - when text is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when translation fails

translate

String translate(String text,
 String sourceLanguage,
 String targetLanguage)
          throws SelectAIException

Translates text using the provider configured by this profile.

Source and target language values are optional and may be null. When omitted, the database can use profile language attributes or source-language detection according to DBMS_CLOUD_AI.TRANSLATE behavior. For a complete runnable sample source, see TranslateProfileSample source.

Parameters:

text - source text

sourceLanguage - source language/code

targetLanguage - target language/code

Returns:

translated text

Throws:

IllegalArgumentException - when text is null or blank

IllegalStateException - when this Profile instance is not bound to a profile name or is configured for creation but has not been created yet

SelectAIException - when translation fails

getProfileName

String getProfileName()

Returns profile name.

For a complete runnable sample source, see GetProfileNameSample source.

Returns:

profile name

getStatus

String getStatus()
          throws SelectAIException

Returns profile status.

For a configured profile that has not been created yet, returns the caller-supplied create status. For a profile bound to an existing database profile, refreshes metadata from the database before returning the status. For a complete runnable sample source, see GetProfileStatusSample source.

Returns:

profile status

Throws:

SelectAIException - when current profile metadata cannot be fetched

getDescription

String getDescription()

Returns profile description.

For a complete runnable sample source, see GetProfileDescriptionSample source.

Returns:

profile description

getProfileAttributes

ProfileAttributes getProfileAttributes()
                                throws SelectAIException

Returns profile attributes.

For a configured profile that has not been created yet, returns the caller-supplied create attributes. For a profile bound to an existing database profile, refreshes attributes from the database before returning them. For a complete runnable sample source, see GetProfileAttributesSample source.

Returns:

profile attributes

Throws:

IllegalStateException - when this Profile instance is not bound to a profile name

SelectAIException - when current profile attributes cannot be fetched