oracle.ifs.protocols.commands

Interface InvokeSelectorAndListOutputContext

All Superinterfaces:

CommandContext

All Known Implementing Classes:

IfsInvokeSelectorAndListOutputContext

public interface InvokeSelectorAndListOutputContext
extends CommandContext

InvokeSelectorAndListOutputContext interface encapsulates context for InvokeSelectorAndListOutput command.

Version:

0.9

Author:

Vijayanth Devadhar

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
static int	LISTING_OPTION_ALL Indicates the list all attributes option.
static int	LISTING_OPTION_LONG Indicates the long format listing option.
static int	LISTING_OPTION_NAME Indicates the list only name option.
static int	LISTING_OPTION_SUPPLIED_ATTRIBUTES Indicates the list attributes that are suuplied option.

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.

Field Detail

LISTING_OPTION_ALL

static final int LISTING_OPTION_ALL

Indicates the list all attributes option.

See Also:

Constant Field Values

(Published)

LISTING_OPTION_SUPPLIED_ATTRIBUTES

static final int LISTING_OPTION_SUPPLIED_ATTRIBUTES

Indicates the list attributes that are suuplied option.

See Also:

Constant Field Values

(Published)

LISTING_OPTION_NAME

static final int LISTING_OPTION_NAME

Indicates the list only name option.

See Also:

Constant Field Values

(Published)

LISTING_OPTION_LONG

static final int LISTING_OPTION_LONG

Indicates the long format listing option.

See Also:

Constant Field Values

(Published)

Method Detail

clear

void clear()

Clears the Context. Does not throw.

Specified by:

clear in interface CommandContext

(Published)

getResult

StringBuffer getResult()
                throws IfsException

Gets the Results.

Returns:

StringBuffer result of the context

Throws:

IfsException - if the operation fails

(Published)

setResult

void setResult(StringBuffer 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)

getAttributeNames

String[] getAttributeNames()
                    throws IfsException

Gets the names of the attributes in result attribute list.

Returns:

String [] array of Attribute names in the output.

Throws:

IfsException - if the operation fails

(Published)

setAttributeNames

void setAttributeNames(String[] attributeNames)
                throws IfsException

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

Parameters:

attributeNames - names of attribute in the result list.

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)

getListingOption

int getListingOption()
              throws IfsException

Gets the listing option.

Returns:

int returns the integer corresponding to the listing option chosen

Throws:

IfsException - if the operation fails

(Published)

setListingOption

void setListingOption(int value)
               throws IfsException

Sets the listing option.

Parameters:

value - value to be set for show all attributes flag

Throws:

IfsException - if the operation fails

(Published)

getIsObfuscated

boolean getIsObfuscated()
                 throws IfsException

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

Throws:

IfsException

(Published)

setIsObfuscated

void setIsObfuscated(boolean obfuscate)
              throws IfsException

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

Throws:

IfsException

(Published)