public interface IDfScopeManager
Modifier and Type | Method and Description |
---|---|
IDfScope |
beginScope(boolean bNested)
Opens an explicit scope boundary.
|
void |
clearDefaultScope(com.documentum.fc.client.ScopeBoundary boundary)
Removes one default scoping policy.
|
void |
clearScopes()
Pops all the scopes from the scope stack.
|
void |
enableServerScope(boolean enable)
Enables or disables server-side scoping.
|
void |
endScope()
Closes the explicit scope boundary.
|
IDfScope |
getCurrentScope()
Returns the currect active scope from the top of scope stack.
|
IDfScope |
getDefaultScope(com.documentum.fc.client.ScopeBoundary boundary)
Returns the default scope template for the specific boundary.
|
int |
getScopeCount()
Returns the number of scopes currently on the scope stack.
|
boolean |
isScopeActive()
Returns true if one or more CUSTOM scopes are open.
|
boolean |
isServerScopingEnabled()
Returns true if server-side scoping is enabled, otherwise false.
|
void |
setDefaultScope(com.documentum.fc.client.ScopeBoundary boundary,
boolean bNested)
Set the default scoping policy for a given boundary.
|
void setDefaultScope(com.documentum.fc.client.ScopeBoundary boundary, boolean bNested) throws DfException
boundary
- of a default scope policybNested
- value to be used when opening the corresponding scopeDfException
- thrown when a scope for the given boundary is openvoid clearDefaultScope(com.documentum.fc.client.ScopeBoundary boundary) throws DfException
boundary
- of a default scoping policyDfException
IDfScope beginScope(boolean bNested) throws DfException
bNested
- If server scoping is activated and bNested is true, then the current scope
will be pushed to the server.DfException
void endScope() throws DfException
DfException
- thrown if no matching beginScope existsIDfScope getDefaultScope(com.documentum.fc.client.ScopeBoundary boundary)
boundary
- for a default scope templateIDfScope getCurrentScope()
void clearScopes() throws DfException
DfException
- if an error occursvoid enableServerScope(boolean enable)
enable
- is true or false to enable or disable server side scopingboolean isServerScopingEnabled()
int getScopeCount()
boolean isScopeActive()
Copyright 1994-2023 OpenText Corporation. All rights reserved.