oracle.ifs.protocols.commands

Interface InvokeSelectorContext

All Superinterfaces:

CommandContext

All Known Implementing Classes:

IfsInvokeSelectorContext

public interface InvokeSelectorContext
extends CommandContext

InvokeSelectorContext interface encapsulates context for InvokeSelector command.

Version:

0.9

Author:

Vijayanth Devadhar

(Unpublished)

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.

Method Detail

clear

void clear()

Clears the Context. Does not throw.

Specified by:

clear in interface CommandContext

(Published)

getResult

LibraryObject[] getResult()
                   throws IfsException

Gets the Results.

Returns:

LibraryObject [] array of LibraryObject

Throws:

IfsException - if the operation fails

(Published)

setResult

void setResult(LibraryObject[] result)
        throws IfsException

Sets the result.

Parameters:

result - results for this context

Throws:

IfsException - if the operation fails

(Published)

getSearchClassname

String getSearchClassname()
                   throws IfsException

Gets the Search class name.

Returns:

String name of the class being used in this context.

Throws:

IfsException - if the operation fails

(Published)

setSearchClassname

void setSearchClassname(String classname)
                 throws IfsException

Sets the Search class name.

Parameters:

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

Throws:

IfsException - if the operation fails

(Published)

getWhereClause

String getWhereClause()
               throws IfsException

Gets the Search WHERE clause.

Returns:

String where clause in this context

Throws:

IfsException - if the operation fails

(Published)

setWhereClause

void setWhereClause(String whereClause)
             throws IfsException

Sets the Search WHERE clause.

Parameters:

whereClause - WHERE clause for this context

Throws:

IfsException - if the operation fails

(Published)

getSortSpecification

SortSpecification getSortSpecification()
                                throws IfsException

Gets the sort specification.

Returns:

SortSpecification sort spec for this context

Throws:

IfsException - if the operation fails

(Published)

setSortSpecification

void setSortSpecification(SortSpecification sortSpec)
                   throws IfsException

Sets the sort specification.

Parameters:

sortSpec - sets the SortSpecification for this context

Throws:

IfsException - if the operation fails

(Published)

getLibrarySession

LibrarySession getLibrarySession()
                          throws IfsException

Gets the LibrarySession.

Returns:

LibrarySession session of this command context

Throws:

IfsException - if the operation fails

(Published)

setLibrarySession

void setLibrarySession(LibrarySession session)
                throws IfsException

Sets the LibrarySession.

Parameters:

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

Throws:

IfsException - if the operation fails

(Published)