oracle.ifs.protocols.commands

Class IfsInvokeSelectorAndListOutputContext

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommandContext

oracle.ifs.protocols.commands.IfsInvokeSelectorAndListOutputContext

All Implemented Interfaces:

InvokeSelectorAndListOutputContext, CommandContext

public class IfsInvokeSelectorAndListOutputContext
extends IfsCommandContext
implements InvokeSelectorAndListOutputContext

IfsInvokeSelectorAndListOutputContext implements context for invoke selector and list output command.

Command specification for IfsInvokeSelectorAndListOutputCommand

Inputs:

• session:LibrarySession (required)
• SearchClassName:String (required)
• SearchWhereClause:String (optional)
• sortSpec: SortSpecification (optional)
• listingOption: int (required)
• attributeNames: String[] (required with user supplied attributes listing option)

Outputs:

• StringBuffer

Description:

• This command invokes two sub commands. It first invokes the IfsInvokeSelectorCommand. Then, it takes the output of that command and feeds the IfsStringListCommand and returns it's output

Version:

0.9

Author:

Vijayanth Devadhar

(Unpublished)

Field Summary

Fields inherited from interface oracle.ifs.protocols.commands.InvokeSelectorAndListOutputContext

LISTING_OPTION_ALL, LISTING_OPTION_LONG, LISTING_OPTION_NAME, LISTING_OPTION_SUPPLIED_ATTRIBUTES

Constructor Summary

Constructors

Constructor and Description
IfsInvokeSelectorAndListOutputContext() Default Constructor.
IfsInvokeSelectorAndListOutputContext(LibrarySession session, String classname, String whereClause, SortSpecification sortSpec, int listingOption, String[] attributeNames) Constructor which sets up all the required parameters.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the Context.
String[]	getAttributeNames() Gets the names of the attributes in result attribute list.
boolean	getIsObfuscated() Gets a boolean flag as to wether the output of the command should contain id and date strings.
LibrarySession	getLibrarySession() Gets the LibrarySession.
int	getListingOption() Gets the listing option.
StringBuffer	getResult() Gets the Results.
String	getSearchClassname() Gets the Search class name.
SortSpecification	getSortSpecification() Gets the sort specification.
String	getWhereClause() Gets the Search WHERE clause.
void	setAttributeNames(String[] attributeNames) Sets the names of attribute names to be preset in the output.
void	setIsObfuscated(boolean obfuscate) Sets a boolean flag as to wether the output of the command should contain id and date strings.
void	setLibrarySession(LibrarySession session) Sets the LibrarySession.
void	setListingOption(int value) Sets the listing option.
void	setResult(StringBuffer result) Sets the result.
void	setSearchClassname(String classname) Sets the Search class name.
void	setSortSpecification(SortSpecification sortSpec) Sets the sort specification.
void	setWhereClause(String whereClause) Sets the Search WHERE clause.

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsInvokeSelectorAndListOutputContext

public IfsInvokeSelectorAndListOutputContext()
                                      throws IfsException

Default Constructor.

Throws:

IfsException - if the operation fails

(Published)

IfsInvokeSelectorAndListOutputContext

public IfsInvokeSelectorAndListOutputContext(LibrarySession session,
                                             String classname,
                                             String whereClause,
                                             SortSpecification sortSpec,
                                             int listingOption,
                                             String[] attributeNames)
                                      throws IfsException

Constructor which sets up all the required parameters.

Parameters:

session - LibrarySession instance to execute the command

classname - name of the search class

whereClause - WHERE clause for this context

sortSpec - sort spec for this context

listingOption - indicates what type of attribute listing to be used

attributeNames - list of attribute names to be displayed if that option is chosen

Throws:

IfsException - if the operation fails

(Published)

Method Detail

clear

public void clear()

Clears the Context. Does not throw.

Specified by:

clear in interface InvokeSelectorAndListOutputContext

Specified by:

clear in interface CommandContext

Overrides:

clear in class IfsCommandContext

(Published)

getLibrarySession

public LibrarySession getLibrarySession()
                                 throws IfsException

Gets the LibrarySession.

Specified by:

getLibrarySession in interface InvokeSelectorAndListOutputContext

Returns:

LibrarySession session of this command context

Throws:

IfsException - if the operation fails

(Published)

setLibrarySession

public void setLibrarySession(LibrarySession session)
                       throws IfsException

Sets the LibrarySession.

Specified by:

setLibrarySession in interface InvokeSelectorAndListOutputContext

Parameters:

session - instance of LibrarySession to be used in this command context

Throws:

IfsException - if the operation fails

(Published)

getResult

public StringBuffer getResult()
                       throws IfsException

Gets the Results.

Specified by:

getResult in interface InvokeSelectorAndListOutputContext

Returns:

StringBuffer result of this context

Throws:

IfsException - if the operation fails

(Published)

setResult

public void setResult(StringBuffer result)
               throws IfsException

Sets the result.

Specified by:

setResult in interface InvokeSelectorAndListOutputContext

Parameters:

result - results for this context

Throws:

IfsException - if the operation fails

(Published)

getSearchClassname

public String getSearchClassname()
                          throws IfsException

Gets the Search class name.

Specified by:

getSearchClassname in interface InvokeSelectorAndListOutputContext

Returns:

String name of the class being used in this context.

Throws:

IfsException - if the operation fails

(Published)

setSearchClassname

public void setSearchClassname(String classname)
                        throws IfsException

Sets the Search class name.

Specified by:

setSearchClassname in interface InvokeSelectorAndListOutputContext

Parameters:

classname - name of the class to be used for this context

Throws:

IfsException - if the operation fails

(Published)

getWhereClause

public String getWhereClause()
                      throws IfsException

Gets the Search WHERE clause.

Specified by:

getWhereClause in interface InvokeSelectorAndListOutputContext

Returns:

String where clause in this context

Throws:

IfsException - if the operation fails

(Published)

setWhereClause

public void setWhereClause(String whereClause)
                    throws IfsException

Sets the Search WHERE clause.

Specified by:

setWhereClause in interface InvokeSelectorAndListOutputContext

Parameters:

whereClause - WHERE clause for this context

Throws:

IfsException - if the operation fails

(Published)

getSortSpecification

public SortSpecification getSortSpecification()
                                       throws IfsException

Gets the sort specification.

Specified by:

getSortSpecification in interface InvokeSelectorAndListOutputContext

Returns:

SortSpecification sort spec for this context

Throws:

IfsException - if the operation fails

(Published)

setSortSpecification

public void setSortSpecification(SortSpecification sortSpec)
                          throws IfsException

Sets the sort specification.

Specified by:

setSortSpecification in interface InvokeSelectorAndListOutputContext

Parameters:

sortSpec - sets the SortSpecification for this context

Throws:

IfsException - if the operation fails

(Published)

getAttributeNames

public String[] getAttributeNames()
                           throws IfsException

Gets the names of the attributes in result attribute list.

Specified by:

getAttributeNames in interface InvokeSelectorAndListOutputContext

Returns:

String [] array of Attribute names in the output.

Throws:

IfsException - if the operation fails

(Published)

setAttributeNames

public void setAttributeNames(String[] attributeNames)
                       throws IfsException

Sets the names of attribute names to be preset in the output.

Specified by:

setAttributeNames in interface InvokeSelectorAndListOutputContext

Parameters:

attributeNames - names of attribute in the result list.

Throws:

IfsException - if the operation fails

(Published)

getListingOption

public int getListingOption()
                     throws IfsException

Gets the listing option.

Specified by:

getListingOption in interface InvokeSelectorAndListOutputContext

Returns:

int returns the integer corresponding to the listing option chosen

Throws:

IfsException - if the operation fails

(Published)

setListingOption

public void setListingOption(int value)
                      throws IfsException

Sets the listing option.

Specified by:

setListingOption in interface InvokeSelectorAndListOutputContext

Parameters:

value - value to be set for show all attributes flag

Throws:

IfsException - if the operation fails

(Published)

getIsObfuscated

public boolean getIsObfuscated()
                        throws IfsException

Gets a boolean flag as to wether the output of the command should contain id and date strings.

Specified by:

getIsObfuscated in interface InvokeSelectorAndListOutputContext

Throws:

IfsException

(Published)

setIsObfuscated

public void setIsObfuscated(boolean obfuscate)
                     throws IfsException

Sets a boolean flag as to wether the output of the command should contain id and date strings.

Specified by:

setIsObfuscated in interface InvokeSelectorAndListOutputContext

Throws:

IfsException

(Published)