Skip navigation links

com.essbase.eas.essbase.server
Class FilterPrimitives

java.lang.Object
com.essbase.eas.essbase.server.FilterPrimitives

public final class FilterPrimitives

extends java.lang.Object

This class provides the primitive operations for an Essbase Filter object. In the current implementation, no instances of this class should ever be instantiated.

Methods that need to be implemented

1. run()

Version:

1.00, 08/13/2000

Author:

Brian Litofsky

See Also:

EssSession, EssSessionMessage

Method Summary

static boolean	assign(ISession session, java.lang.String appName, java.lang.String dbName, java.lang.String filterName, java.util.List nameList) Assigns a filter to a list of users/groups
static boolean	copy(ISession destSession, java.lang.String destApp, java.lang.String destDatabase, java.lang.String descFilter, java.lang.String srcApp, java.lang.String srcDatabase, java.lang.String srcFilter, boolean replace) copies an filter within an individual server.
static boolean	create(ISession session, java.lang.String appName, java.lang.String dbName, FilterProperties filter) creates a filter.
static boolean	create(ISession session, java.lang.String appName, java.lang.String dbName, FilterProperties filter, boolean update) creates a filter.
static boolean	delete(ISession session, java.lang.String appName, java.lang.String dbName, java.lang.String filterName) deletes a filter
static java.util.List	getAssignedList(ISession session, java.lang.String appName, java.lang.String dbName, java.lang.String filterName) Gets the list of users/groups assigned to a filter
static FilterProperties	getFilter(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String filterName) gets a filter
static java.util.List	getList(ISession session, java.lang.String application, java.lang.String database) Creates a list of filters that belong to a specific server.
static boolean	renameFilter(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String oldFilterName, java.lang.String newFilterName) Renames a filter
static boolean	update(ISession session, java.lang.String appName, java.lang.String dbName, FilterProperties filter) updates a filter.
static boolean	verify(ISession session, java.lang.String appName, java.lang.String dbName, FilterProperties filter) Verifies the syntax of a filter, line by line

Methods inherited from class java.lang.Object

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

Method Detail

getList

public static java.util.List getList(ISession session,
                                     java.lang.String application,
                                     java.lang.String database)

Creates a list of filters that belong to a specific server. Creates the list for a specific application and database.

Parameters:

session - object for this Essbase session.

application - to restrict request within.

database - to restrict request within

Returns:

a list collection containing strings with the filter names.

copy

public static boolean copy(ISession destSession,
                           java.lang.String destApp,
                           java.lang.String destDatabase,
                           java.lang.String descFilter,
                           java.lang.String srcApp,
                           java.lang.String srcDatabase,
                           java.lang.String srcFilter,
                           boolean replace)

copies an filter within an individual server.

Should we throw an exception here?

Parameters:

session - - session object server.

destApp - - application name for the copy.

destDatabase - - database name for the copy.

destFilter - - filter name for the copy.

srcApp - - application to be copied.

srcDatabase - - database to be copied.

srcFilter - - filter name to be copied.

replace - - replace existing filter

Returns:

true if the database is successfully copied. What do we do about messages if the call fails?

create

public static boolean create(ISession session,
                             java.lang.String appName,
                             java.lang.String dbName,
                             FilterProperties filter)

creates a filter.

Parameters:

session - - session object for this command.

appName - - application to create database in.

dbName - - database name that filter belongs to.

filter - - contents of the filter

Returns:

true if the creation succeeds.What do we do about messages if the call fails?

create

public static boolean create(ISession session,
                             java.lang.String appName,
                             java.lang.String dbName,
                             FilterProperties filter,
                             boolean update)

creates a filter.

Parameters:

session - - session object for this command.

appName - - application to create database in.

dbName - - database name that filter belongs to.

filter - - contents of the filter

update - - update filter definition if it already exists

Returns:

true if the creation succeeds.What do we do about messages if the call fails?

update

public static boolean update(ISession session,
                             java.lang.String appName,
                             java.lang.String dbName,
                             FilterProperties filter)

updates a filter.

Parameters:

session - - session object for this command.

appName - - application to create database in.

dbName - - database name that filter belongs to.

filter - - contents of the filter

Returns:

true if the creation succeeds.What do we do about messages if the call fails?

delete

public static boolean delete(ISession session,
                             java.lang.String appName,
                             java.lang.String dbName,
                             java.lang.String filterName)

deletes a filter

Parameters:

session - - session object for this command.

appName - - name of application containing the filter to be deleted.

dbName - - name of database containing the filter to be deleted.

filterName - - name of the filter to delete

Returns:

true if the delete succeeds. What do we do about messages if the call fails?

getFilter

public static FilterProperties getFilter(EssSession session,
                                         java.lang.String appName,
                                         java.lang.String dbName,
                                         java.lang.String filterName)

gets a filter

Parameters:

session - - session object for this command.

appName - - name of application containing the filter.

dbName - - name of database containing the filter.

filterName - - name of the filter to get

verify

public static boolean verify(ISession session,
                             java.lang.String appName,
                             java.lang.String dbName,
                             FilterProperties filter)

Verifies the syntax of a filter, line by line

Parameters:

session - - session object for this command.

appName - - application to create database in.

dbName - - database name that filter belongs to.

filter - - contents of the filter

assign

public static boolean assign(ISession session,
                             java.lang.String appName,
                             java.lang.String dbName,
                             java.lang.String filterName,
                             java.util.List nameList)

Assigns a filter to a list of users/groups

Parameters:

session - - session object for this command.

appName - - application to containing the database.

dbName - - database name that filter belongs to.

filterName - - name of the filter

nameList - - Array of string objects containing names of users and/or groups

getAssignedList

public static java.util.List getAssignedList(ISession session,
                                             java.lang.String appName,
                                             java.lang.String dbName,
                                             java.lang.String filterName)

Gets the list of users/groups assigned to a filter

Parameters:

session - - session object for this command.

appName - - application to containing the database.

dbName - - database name that filter belongs to.

filterName - - name of the filter

Returns:

List - Array of string objects containing names of users and/or groups assigned to the filter

renameFilter

public static boolean renameFilter(EssSession session,
                                   java.lang.String appName,
                                   java.lang.String dbName,
                                   java.lang.String oldFilterName,
                                   java.lang.String newFilterName)

Renames a filter

Skip navigation links