Skip navigation links


com.essbase.api.metadata
Interface IEssSmartList

All Superinterfaces:
IEssBaseObject, IEssExtendedObject

public interface IEssSmartList
extends IEssExtendedObject

IEssSmartList Interface

Author:
adoshi1

Field Summary
static short ESS_VERIFY_ALL
           
static short ESS_VERIFY_DEFER
           
static short ESS_VERIFY_NAMEONLY
           
static short ESS_VERIFY_ORDER_DEPENDENT
           
static short ESS_VERIFY_ORDER_INDEPENDENT
           

 

Method Summary
 void delete()
          Deletes the smartlist.
 void exportSmartList(java.lang.String fileName)
          Exports the smartlist to the file specified on the client side in UTF-8 format.
 long[] getIDs()
          Returns the list of IDs of the smartlist.
 IEssIterator getReferenceMembers(int maxCount)
          Gets the all members that refer this smartlist.
 int getReferenceMembersCount()
          Gets the count of members that refer this smartlist.
 java.lang.String[] getText()
          Returns the list of texts of the smartlist
 void importSmartList(java.lang.String fileName)
          Imports the smartlist from the given file on the client side.
 void putSmartList(long[] IDs, java.lang.String[] text)
          Assigns SmartList to the Ids and text in IDs and Text specified, in the given order.

 

Methods inherited from interface com.essbase.api.base.IEssExtendedObject
clearClientCache, getName, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled

 

Field Detail

ESS_VERIFY_ALL

static final short ESS_VERIFY_ALL
See Also:
Constant Field Values

ESS_VERIFY_ORDER_INDEPENDENT

static final short ESS_VERIFY_ORDER_INDEPENDENT
See Also:
Constant Field Values

ESS_VERIFY_ORDER_DEPENDENT

static final short ESS_VERIFY_ORDER_DEPENDENT
See Also:
Constant Field Values

ESS_VERIFY_DEFER

static final short ESS_VERIFY_DEFER
See Also:
Constant Field Values

ESS_VERIFY_NAMEONLY

static final short ESS_VERIFY_NAMEONLY
See Also:
Constant Field Values

Method Detail

getIDs

long[] getIDs()
Returns the list of IDs of the smartlist.
Returns:
a long array containing list of IDs of the smartlist.

getText

java.lang.String[] getText()
Returns the list of texts of the smartlist
Returns:
a String array containing the list of texts of the smartlist

importSmartList

void importSmartList(java.lang.String fileName)
                     throws com.essbase.api.base.EssException
Imports the smartlist from the given file on the client side.
Parameters:
fileName - - Full path of the file from which the smartlist is to be imported.
Throws:
com.essbase.api.base.EssException - when an error occurs.

exportSmartList

void exportSmartList(java.lang.String fileName)
                     throws com.essbase.api.base.EssException
Exports the smartlist to the file specified on the client side in UTF-8 format.
Parameters:
fileName - - Full path of the file to which the smartlist is to be exported.
Throws:
com.essbase.api.base.EssException - when an error occurs.

putSmartList

void putSmartList(long[] IDs,
                  java.lang.String[] text)
                  throws com.essbase.api.base.EssException
Assigns SmartList to the Ids and text in IDs and Text specified, in the given order. All existing entries of SmartList are deleted.
Parameters:
IDs - - List of IDs to be assigned.
text - - List of text to be assigned.
Throws:
com.essbase.api.base.EssException

delete

void delete()
            throws com.essbase.api.base.EssException
Deletes the smartlist.

One cannot delete smart list object with out removing references.

Throws:
com.essbase.api.base.EssException

getReferenceMembersCount

int getReferenceMembersCount()
                             throws com.essbase.api.base.EssException
Gets the count of members that refer this smartlist.
Returns:
Count of associated members.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getReferenceMembers

IEssIterator getReferenceMembers(int maxCount)
                                 throws com.essbase.api.base.EssException
Gets the all members that refer this smartlist.
Parameters:
maxCount - - Count of max outline members.
Returns:
The list of members (each of type IEssMember).
Throws:
com.essbase.api.base.EssException - if an error occurs.

Skip navigation links