|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEssSmartList
IEssSmartList Interface
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 |
---|
static final short ESS_VERIFY_ALL
static final short ESS_VERIFY_ORDER_INDEPENDENT
static final short ESS_VERIFY_ORDER_DEPENDENT
static final short ESS_VERIFY_DEFER
static final short ESS_VERIFY_NAMEONLY
Method Detail |
---|
long[] getIDs()
java.lang.String[] getText()
void importSmartList(java.lang.String fileName) throws com.essbase.api.base.EssException
fileName
- - Full path of the file from which the smartlist is to be imported.com.essbase.api.base.EssException
- when an error occurs.void exportSmartList(java.lang.String fileName) throws com.essbase.api.base.EssException
fileName
- - Full path of the file to which the smartlist is to be exported.com.essbase.api.base.EssException
- when an error occurs.void putSmartList(long[] IDs, java.lang.String[] text) throws com.essbase.api.base.EssException
IDs
- - List of IDs to be assigned.text
- - List of text to be assigned.com.essbase.api.base.EssException
void delete() throws com.essbase.api.base.EssException
One cannot delete smart list object with out removing references.
com.essbase.api.base.EssException
int getReferenceMembersCount() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.IEssIterator getReferenceMembers(int maxCount) throws com.essbase.api.base.EssException
maxCount
- - Count of max outline members.com.essbase.api.base.EssException
- if an error occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |