oracle.ifs.protocols.commands

Class IfsInvokeSelectorContext

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommandContext

oracle.ifs.protocols.commands.IfsInvokeSelectorContext

All Implemented Interfaces:

InvokeSelectorContext, CommandContext

public class IfsInvokeSelectorContext
extends IfsCommandContext
implements InvokeSelectorContext

IfsInvokeSelectorContext implements context for invoke selector command.

Command specification IfsInvokeSelectorCommand

Inputs:

• session:LibrarySession (required)
• SearchClassName:String (required)
• SearchWhereClause:String (optional)
• sortSpec: SortSpecification (optional)

Outputs:

• LibraryObject []

Description:

• Builds a Selector using the class name, where clause and sort specification being passed in. Uses the LibrarySession to invoke the Selector and returns an array of LibraryObject.

Version:

0.9

Author:

Vijayanth Devadhar

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsInvokeSelectorContext() Default Constructor.
IfsInvokeSelectorContext(LibrarySession session, String classname, String whereClause, SortSpecification sortSpec) Constructor which sets up all the required parameters.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the Context.
LibrarySession	getLibrarySession() Gets the LibrarySession.
LibraryObject[]	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	setLibrarySession(LibrarySession session) Sets the LibrarySession.
void	setResult(LibraryObject[] 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

IfsInvokeSelectorContext

public IfsInvokeSelectorContext()
                         throws IfsException

Default Constructor.

Throws:

IfsException - if the operation fails

(Published)

IfsInvokeSelectorContext

public IfsInvokeSelectorContext(LibrarySession session,
                                String classname,
                                String whereClause,
                                SortSpecification sortSpec)
                         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

Throws:

IfsException - if the operation fails

(Published)

Method Detail

clear

public void clear()

Clears the Context. Does not throw.

Specified by:

clear in interface InvokeSelectorContext

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 InvokeSelectorContext

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 InvokeSelectorContext

Parameters:

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

Throws:

IfsException - if the operation fails

(Published)

getResult

public LibraryObject[] getResult()
                          throws IfsException

Gets the Results.

Specified by:

getResult in interface InvokeSelectorContext

Returns:

LibraryObject [] array of LibraryObject

Throws:

IfsException - if the operation fails

(Published)

setResult

public void setResult(LibraryObject[] result)
               throws IfsException

Sets the result.

Specified by:

setResult in interface InvokeSelectorContext

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 InvokeSelectorContext

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 InvokeSelectorContext

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 InvokeSelectorContext

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 InvokeSelectorContext

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 InvokeSelectorContext

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 InvokeSelectorContext

Parameters:

sortSpec - sets the SortSpecification for this context

Throws:

IfsException - if the operation fails

(Published)