|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface AssetRepository
AssetRepository manages sheets and their folders, each one of which belongs to a scope namely GLOBAL_SCOPE, REPORT_SCOPE and USER_SCOPE. We can access any one of them using its associated AssetEntry, which contains information including scope, type, user, path and other properties like report id.
| Field Summary | |
|---|---|
static ThreadLocal |
ASSET_ERRORS
Thread local. |
static int |
COMPONENT_SCOPE
Component scope asset. |
static int |
GLOBAL_SCOPE
Global scope asset. |
static ThreadLocal |
IGNORE_PERM
|
static String |
LOCAL_QUERY
Local query. |
static int |
QUERY_SCOPE
Query scope asset. |
static int |
REPORT_SCOPE
Report scope asset. |
static String |
REPORT_WORKSHEET
Local worksheet. |
static int |
REPOSITORY_SCOPE
Component scope asset. |
static int |
TEMPORARY_SCOPE
Temporary scope asset. |
static int |
USER_SCOPE
User scope asset. |
| Method Summary | |
|---|---|
void |
addAssetChangeListener(AssetChangeListener listener)
Adds a listener that is notified when this repository is modified. |
void |
addFolder(AssetEntry entry,
Principal user)
Add one folder. |
void |
allowsFolderScopeChange(AssetEntry entry,
int nscope,
Principal user)
Check if to change a folder scope is allowed. |
void |
allowsSheetScopeChange(AssetEntry entry,
int nscope,
Principal user)
Check if to change a sheet scope is allowed. |
void |
changeFolder(AssetEntry oentry,
AssetEntry nentry,
Principal user,
boolean force)
Change one folder. |
void |
changeSheet(AssetEntry oentry,
AssetEntry nentry,
Principal user,
boolean force)
Change one sheet. |
void |
checkAssetPermission(Principal principal,
AssetEntry entry,
String permission)
Check asset permission. |
void |
checkFolderRemoveable(AssetEntry entry,
Principal user)
Check if folder is removeable. |
boolean |
checkPermission(Principal principal,
String prefix,
String resource,
String permission)
Check permission. |
void |
clearVSBookmark(AssetEntry entry)
Clear all the viewsheet bookmarks. |
boolean |
containsEntry(AssetEntry entry)
Check if contain the specified asset entry. |
void |
dispose()
Dispose the asset repository. |
AssetEntry[] |
getEntries(AssetEntry entry,
Principal user,
String permission)
Get the sub entries of a folder. |
AssetEntry[] |
getEntries(AssetEntry entry,
Principal user,
String permission,
int selector)
Get the sub entries of a folder. |
String |
getEntryIdentifier(AssetEntry entry)
Create an unique identifier for the entry. |
XQueryRepository |
getLocalQueryRepository(String rid)
Get the local query repository. |
AssetRepository |
getParent()
Get the parent of the engine. |
ReportEntry[] |
getReportSheetDependencies(AssetEntry entry,
Principal user)
Get the report sheets depend on a sheet. |
Object |
getSession()
Get the session object. |
AbstractSheet |
getSheet(AssetEntry entry,
Principal user,
boolean permission,
AssetContent ctype)
Get one sheet. |
AssetEntry[] |
getSheetDependencies(AssetEntry entry,
Principal user)
Get the sheets depend on a sheet. |
inetsoft.util.IndexedStorage |
getStorage(AssetEntry entry)
Get the indexed storage of an asset entry. |
inetsoft.uql.viewsheet.VSBookmark |
getVSBookmark(AssetEntry entry,
Principal user)
Get the viewsheet bookmark. |
void |
removeAssetChangeListener(AssetChangeListener listener)
Removes an asset change listener from the notification list. |
void |
removeFolder(AssetEntry entry,
Principal user,
boolean force)
Remove one folder. |
void |
removeSheet(AssetEntry entry,
Principal user,
boolean force)
Remove one sheet. |
void |
removeUser(String name)
Remove a user. |
void |
renameUser(String oname,
String nname)
Rename a user. |
void |
setParent(AssetRepository engine)
Set the parent of the engine. |
void |
setSheet(AssetEntry entry,
AbstractSheet ws,
Principal user,
boolean force)
Set one sheet. |
void |
setVSBookmark(AssetEntry entry,
inetsoft.uql.viewsheet.VSBookmark bookmark,
Principal user)
Set the viewsheet bookmark. |
boolean |
supportsScope(int scope)
Check if supports one scope. |
| Field Detail |
|---|
static final int QUERY_SCOPE
static final int GLOBAL_SCOPE
static final int REPORT_SCOPE
static final int USER_SCOPE
static final int TEMPORARY_SCOPE
static final int COMPONENT_SCOPE
static final int REPOSITORY_SCOPE
static final ThreadLocal ASSET_ERRORS
static final ThreadLocal IGNORE_PERM
static final String LOCAL_QUERY
static final String REPORT_WORKSHEET
| Method Detail |
|---|
void setParent(AssetRepository engine)
engine - the specified parent.AssetRepository getParent()
boolean supportsScope(int scope)
throws Exception
scope - the specified scope.
Exception
boolean checkPermission(Principal principal,
String prefix,
String resource,
String permission)
principal - the specified user.prefix - the specified prefix.resource - the specified resource.permission - the specified permission.
void checkAssetPermission(Principal principal,
AssetEntry entry,
String permission)
throws Exception
principal - the specified user.entry - the specified asset entry.permission - the specified permission.
Exception
AssetEntry[] getEntries(AssetEntry entry,
Principal user,
String permission)
throws Exception
entry - the specified folder entry.user - the specified user.permission - the specified access way.
Exception
AssetEntry[] getEntries(AssetEntry entry,
Principal user,
String permission,
int selector)
throws Exception
entry - the specified folder entry.user - the specified user.permission - the specified access way.selector - used to select the type of entries to return. OR'ed
value of the entry types defined in AssetEntry.
Exception
void addFolder(AssetEntry entry,
Principal user)
throws Exception
entry - the specified folder entry.user - the specified user.
Exception
boolean containsEntry(AssetEntry entry)
throws Exception
entry - the specified asset entry.
Exception
void changeFolder(AssetEntry oentry,
AssetEntry nentry,
Principal user,
boolean force)
throws Exception
oentry - the specified old folder entry.nentry - the specified new folder entry.user - the specified user.force - true to change folder forcely without
checking dependency.
Exception
void removeFolder(AssetEntry entry,
Principal user,
boolean force)
throws Exception
entry - the specified folder entry.user - the specified user.force - true to remove folder forcely without
checking.
Exception
AbstractSheet getSheet(AssetEntry entry,
Principal user,
boolean permission,
AssetContent ctype)
throws Exception
entry - the specified sheet entry.user - the specified user.permission - true to check permission, false
otherwise.ctype - the asset content type.
Exception
void setSheet(AssetEntry entry,
AbstractSheet ws,
Principal user,
boolean force)
throws Exception
entry - the specified sheet entry.user - the specified user.force - true to set sheet forcely without
checking.
Exception
void changeSheet(AssetEntry oentry,
AssetEntry nentry,
Principal user,
boolean force)
throws Exception
oentry - the specified old sheet entry.nentry - the specified new sheet entry.user - the specified user.force - true to change sheet forcely without
checking dependency.
Exception
void removeSheet(AssetEntry entry,
Principal user,
boolean force)
throws Exception
entry - the specified sheet entry.user - the specified user.force - true to remove sheet forcely without
checking.
Exception
AssetEntry[] getSheetDependencies(AssetEntry entry,
Principal user)
throws Exception
entry - the specified sheet entry.user - the specified user.
Exception
ReportEntry[] getReportSheetDependencies(AssetEntry entry,
Principal user)
throws Exception
entry - the specified sheet entry.user - the specified user.
Exception
void allowsFolderScopeChange(AssetEntry entry,
int nscope,
Principal user)
throws Exception
entry - the specified folder entry.nscope - the specified new scope to change to.user - the specified user.
Exception
void allowsSheetScopeChange(AssetEntry entry,
int nscope,
Principal user)
throws Exception
entry - the specified sheet entry.nscope - the specified new scope to change to.user - the specified uder.
Exception
void checkFolderRemoveable(AssetEntry entry,
Principal user)
throws Exception
entry - the specified folder entry.user - the specified user.
Exceptionvoid addAssetChangeListener(AssetChangeListener listener)
listener - the listener to remove.void removeAssetChangeListener(AssetChangeListener listener)
listener - the listener to remove.
Object getSession()
throws Exception
Exceptionvoid dispose()
XQueryRepository getLocalQueryRepository(String rid)
rid - the specified report id.
void renameUser(String oname,
String nname)
throws Exception
oname - the old name of the user.nname - the new name of the user.
Exception
void removeUser(String name)
throws Exception
name - the name of the user.
Exception
inetsoft.uql.viewsheet.VSBookmark getVSBookmark(AssetEntry entry,
Principal user)
throws Exception
entry - the entry of the specified viewsheet.user - the specified user.
Exception
void setVSBookmark(AssetEntry entry,
inetsoft.uql.viewsheet.VSBookmark bookmark,
Principal user)
throws Exception
entry - the entry of the specified viewsheet.bookmark - the specified viewsheet bookmark.user - the specified user.
Exception
void clearVSBookmark(AssetEntry entry)
throws Exception
entry - the entry of the specified viewsheet.user - the specified user.
Exception
inetsoft.util.IndexedStorage getStorage(AssetEntry entry)
throws Exception
entry - the specified asset entry.
ExceptionString getEntryIdentifier(AssetEntry entry)
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||