com.essbase.api.datasource
Interface IEssCube.IEssSecurityFilter

All Superinterfaces:

IEssBaseObject

Enclosing interface:

IEssCube

public static interface IEssCube.IEssSecurityFilter

extends IEssBaseObject

The IEssSecurityFilter is cube security filter.

Nested Class Summary

static interface

IEssCube.IEssSecurityFilter.IEssFilterRow IEssFilterRow represents a security filter row.

Method Summary

IEssCube.IEssSecurityFilter	copy(java.lang.String destName) Deprecated. - use copyFilter(String)
IEssCube.IEssSecurityFilter	copy(java.lang.String destName, java.lang.String destAppName, java.lang.String destCubeName) Deprecated. - use copyFilter(String, String, String)
void	copyFilter(java.lang.String destName) Copies this security filter.
void	copyFilter(java.lang.String destName, java.lang.String destAppName, java.lang.String destCubeName) Copies this security filter.
void	delete() Deletes this security filter.
short	getAccess() Gets the default filter access level.
IEssCube.IEssSecurityFilter.IEssFilterRow	getFilterRow() Get the next filter row.
java.lang.String	getName() Gets the name of the security filter.
java.lang.String[]	getSecurityFilterList() Gets the list of users who are assigned a filter.
boolean	isActive() Checks if this filter is currently in effect cube.
void	rename(java.lang.String newName) Renames this security filter.
void	setFilterRow(java.lang.String row, IEssCube.EEssCubeAccess access) Set a filter row.
void	verifyFilter(java.lang.String[] RowStrings) Verifies the syntax of a series of filter row strings against a specified database.

Method Detail

getName

public java.lang.String getName()
                         throws EssException

Gets the name of the security filter.

Returns:

The security filter name.

Throws:

EssException - if an error occurs.

isActive

public boolean isActive()
                 throws EssException

Checks if this filter is currently in effect cube.

Returns:

true if filter is currently in effect.

Throws:

EssException - if an error occurs.

getAccess

public short getAccess()
                throws EssException

Gets the default filter access level.

Returns:

The default filter access level.

Throws:

EssException - if an error occurs.

copy

public IEssCube.IEssSecurityFilter copy(java.lang.String destName)
                                 throws EssException

Deprecated. - use copyFilter(String)

Copies this security filter.

Parameters:

destName - The destination name of the copied filter.

Throws:

EssException - if an error occurs.

copyFilter

public void copyFilter(java.lang.String destName)
                throws EssException

Copies this security filter.

Parameters:

destName - The destination name of the copied filter.

Throws:

EssException - if an error occurs.

copy

public IEssCube.IEssSecurityFilter copy(java.lang.String destName,
                                        java.lang.String destAppName,
                                        java.lang.String destCubeName)
                                 throws EssException

Deprecated. - use copyFilter(String, String, String)

Copies this security filter.

Parameters:

destAppName - The destination application name.

destCubeName - The destination cube name.

destName - The name for the filter copy.

Returns:

The security filter.

Throws:

EssException - if an error occurs.

copyFilter

public void copyFilter(java.lang.String destName,
                       java.lang.String destAppName,
                       java.lang.String destCubeName)
                throws EssException

Copies this security filter.

Parameters:

destAppName - The destination application name.

destCubeName - The destination cube name.

destName - The destination name of the copied filter.

Throws:

EssException - if an error occurs.

rename

public void rename(java.lang.String newName)
            throws EssException

Renames this security filter.

Returns:

The new name for the filter.

Throws:

EssException - if an error occurs.

delete

public void delete()
            throws EssException

Deletes this security filter. This function requires the caller to have database Design privilege for the specified database.

Throws:

EssException - if an error occurs.

setFilterRow

public void setFilterRow(java.lang.String row,
                         IEssCube.EEssCubeAccess access)
                  throws EssException

Set a filter row. This function should be called repeatedly after calling setFilter(), once for each row of the filter, terminating the row list with a NULL row string pointer This function requires the caller to have database designer privilege for the specified database.

Throws:

EssException - if an error occurs.

getFilterRow

public IEssCube.IEssSecurityFilter.IEssFilterRow getFilterRow()
                                                       throws EssException

Get the next filter row. This function should be called repeatedly after calling getFilter(), until a NULL row string pointer is returned.

Returns:

IEssCube.IEssSecurityFilter.IEssFilterRow; If successful, returns the next filter row (if any); returns null if invoked after receiving the last row.

Throws:

EssException - if an error occurs.

getSecurityFilterList

public java.lang.String[] getSecurityFilterList()
                                         throws EssException

Gets the list of users who are assigned a filter.

Returns:

If successful, returns an array of user names .

Throws:

EssException - if an error occurs.

verifyFilter

public void verifyFilter(java.lang.String[] RowStrings)
                  throws EssException

Verifies the syntax of a series of filter row strings against a specified database. Follow this call with successive calls to IEssCube.IEssSecurityFilter.verifyFilterRow() to verify all rows for the filter. This function requires the caller to have database designer privilege for the specified database.

Throws:

EssException